interface LayoutPluginManagerInterface in Layout Plugin (obsolete, use core's Layout Discovery) 8

Provides an interface for the discovery and instantiation of layout plugins.

Hierarchy

• interface \Drupal\Component\Plugin\Discovery\DiscoveryInterface; interface \Drupal\Component\Plugin\Factory\FactoryInterface; interface \Drupal\Component\Plugin\Mapper\MapperInterface
  • interface \Drupal\Component\Plugin\PluginManagerInterface
    • interface \Drupal\Component\Plugin\CategorizingPluginManagerInterface
      • interface \Drupal\layout_plugin\Plugin\Layout\LayoutPluginManagerInterface

File

src/Plugin/Layout/LayoutPluginManagerInterface.php, line 10

Namespace

Drupal\layout_plugin\Plugin\Layout

interface LayoutPluginManagerInterface extends CategorizingPluginManagerInterface {

  /**
   * Get all available layouts as an options array.
   *
   * If group_by_category option/parameter passed group the options by
   * category.
   *
   * @param array $params
   *   (optional) An associative array with the following keys:
   *   - group_by_category: (bool) If set to TRUE, return an array of arrays
   *   grouped by the category name; otherwise, return a single-level
   *   associative array.
   *
   * @return array
   *   Layout options, as array.
   */
  public function getLayoutOptions(array $params = []);

  /**
   * Get theme implementations for layouts that give only a template.
   *
   * @return array
   *   An associative array of the same format as returned by hook_theme().
   *
   * @see hook_theme()
   */
  public function getThemeImplementations();

  /**
   * Modifies the theme implementations for the layouts that we registered.
   *
   * @param array &$theme_registry
   *   An associative array of the same format as passed to hook_theme_registry_alter().
   *
   * @see hook_theme_registry_alter()
   */
  public function alterThemeImplementations(array &$theme_registry);

  /**
   * Get library info for layouts that want to automatically register CSS.
   *
   * @return array
   *   An associative array of the same format as returned by
   *   hook_library_info_build().
   *
   * @see hook_library_info_build()
   *
   * @deprecated when moving layout plugin to core
   */
  public function getLibraryInfo();

}

Members

Name	Modifiers	Type	Description	Overrides
CategorizingPluginManagerInterface::getCategories	public	function	Gets the names of all categories.	1
CategorizingPluginManagerInterface::getGroupedDefinitions	public	function	Gets sorted plugin definitions grouped by category.	1
CategorizingPluginManagerInterface::getSortedDefinitions	public	function	Gets sorted plugin definitions.	2
DiscoveryInterface::getDefinition	public	function	Gets a specific plugin definition.	4
DiscoveryInterface::getDefinitions	public	function	Gets the definition of all plugins for this type.	3
DiscoveryInterface::hasDefinition	public	function	Indicates if a specific plugin definition exists.	2
FactoryInterface::createInstance	public	function	Creates a pre-configured instance of a plugin.	7
LayoutPluginManagerInterface::alterThemeImplementations	public	function	Modifies the theme implementations for the layouts that we registered.	1
LayoutPluginManagerInterface::getLayoutOptions	public	function	Get all available layouts as an options array.	1
LayoutPluginManagerInterface::getLibraryInfo Deprecated	public	function	Get library info for layouts that want to automatically register CSS.	1
LayoutPluginManagerInterface::getThemeImplementations	public	function	Get theme implementations for layouts that give only a template.	1
MapperInterface::getInstance	public	function	Gets a preconfigured instance of a plugin.	4