aleph1.co.uk Git - yaffs-website/blob - web/modules/contrib/layout_plugin/src/Plugin/Layout/LayoutPluginManagerInterface.php

   1 <?php
   2
   3 namespace Drupal\layout_plugin\Plugin\Layout;
   4
   5 use Drupal\Component\Plugin\CategorizingPluginManagerInterface;
   6
   7 /**
   8  * Provides an interface for the discovery and instantiation of layout plugins.
   9  */
  10 interface LayoutPluginManagerInterface extends CategorizingPluginManagerInterface {
  11
  12   /**
  13    * Get all available layouts as an options array.
  14    *
  15    * If group_by_category option/parameter passed group the options by
  16    * category.
  17    *
  18    * @param array $params
  19    *   (optional) An associative array with the following keys:
  20    *   - group_by_category: (bool) If set to TRUE, return an array of arrays
  21    *   grouped by the category name; otherwise, return a single-level
  22    *   associative array.
  23    *
  24    * @return array
  25    *   Layout options, as array.
  26    */
  27   public function getLayoutOptions(array $params = []);
  28
  29   /**
  30    * Get theme implementations for layouts that give only a template.
  31    *
  32    * @return array
  33    *   An associative array of the same format as returned by hook_theme().
  34    *
  35    * @see hook_theme()
  36    */
  37   public function getThemeImplementations();
  38
  39   /**
  40    * Modifies the theme implementations for the layouts that we registered.
  41    *
  42    * @param array &$theme_registry
  43    *   An associative array of the same format as passed to hook_theme_registry_alter().
  44    *
  45    * @see hook_theme_registry_alter()
  46    */
  47   public function alterThemeImplementations(array &$theme_registry);
  48
  49   /**
  50    * Get library info for layouts that want to automatically register CSS.
  51    *
  52    * @return array
  53    *   An associative array of the same format as returned by
  54    *   hook_library_info_build().
  55    *
  56    * @see hook_library_info_build()
  57    *
  58    * @deprecated when moving layout plugin to core
  59    */
  60   public function getLibraryInfo();
  61
  62 }