interface LayoutPluginManagerInterface in Drupal 8

Provides the interface for a plugin manager of layouts.

Hierarchy

• interface \Drupal\Component\Plugin\CategorizingPluginManagerInterface; interface \Drupal\Core\Plugin\FilteredPluginManagerInterface
  • interface \Drupal\Core\Layout\LayoutPluginManagerInterface

7 files declare their use of LayoutPluginManagerInterface

ChooseSectionController.php in core/modules/layout_builder/src/Controller/ChooseSectionController.php

FieldLayoutBuilder.php in core/modules/field_layout/src/FieldLayoutBuilder.php

FieldLayoutBuilderTest.php in core/modules/field_layout/tests/src/Unit/FieldLayoutBuilderTest.php

FieldLayoutEntityFormDisplayEditForm.php in core/modules/field_layout/src/Form/FieldLayoutEntityFormDisplayEditForm.php

FieldLayoutEntityViewDisplayEditForm.php in core/modules/field_layout/src/Form/FieldLayoutEntityViewDisplayEditForm.php

... See full list

File

core/lib/Drupal/Core/Layout/LayoutPluginManagerInterface.php, line 11

Namespace

Drupal\Core\Layout

interface LayoutPluginManagerInterface extends CategorizingPluginManagerInterface, FilteredPluginManagerInterface {

  /**
   * Gets theme implementations for layouts.
   *
   * @return array
   *   An associative array of the same format as returned by hook_theme().
   *
   * @see hook_theme()
   */
  public function getThemeImplementations();

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\Core\Layout\LayoutInterface
   */
  public function createInstance($plugin_id, array $configuration = []);

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\Core\Layout\LayoutDefinition|null
   */
  public function getDefinition($plugin_id, $exception_on_invalid = TRUE);

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\Core\Layout\LayoutDefinition[]
   */
  public function getDefinitions();

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\Core\Layout\LayoutDefinition[]
   */
  public function getSortedDefinitions(array $definitions = NULL);

  /**
   * {@inheritdoc}
   *
   * @return \Drupal\Core\Layout\LayoutDefinition[][]
   */
  public function getGroupedDefinitions(array $definitions = NULL);

  /**
   * Returns an array of layout labels grouped by category.
   *
   * @return string[][]
   *   A nested array of labels suitable for #options.
   */
  public function getLayoutOptions();

}

Members

Name	Modifiers	Type	Description	Overrides
CategorizingPluginManagerInterface::getCategories	public	function	Gets the names of all categories.	1
DiscoveryInterface::hasDefinition	public	function	Indicates if a specific plugin definition exists.	2
FilteredPluginManagerInterface::getFilteredDefinitions	public	function	Gets the plugin definitions for a given type and consumer and filters them.
LayoutPluginManagerInterface::createInstance	public	function	Overrides FactoryInterface::createInstance
LayoutPluginManagerInterface::getDefinition	public	function	Overrides DiscoveryInterface::getDefinition
LayoutPluginManagerInterface::getDefinitions	public	function	Overrides DiscoveryInterface::getDefinitions
LayoutPluginManagerInterface::getGroupedDefinitions	public	function	Overrides CategorizingPluginManagerInterface::getGroupedDefinitions	1
LayoutPluginManagerInterface::getLayoutOptions	public	function	Returns an array of layout labels grouped by category.	1
LayoutPluginManagerInterface::getSortedDefinitions	public	function	Overrides CategorizingPluginManagerInterface::getSortedDefinitions	1
LayoutPluginManagerInterface::getThemeImplementations	public	function	Gets theme implementations for layouts.	1
MapperInterface::getInstance	public	function	Gets a preconfigured instance of a plugin.	4