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

Provides an interface for static Layout plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface
  • interface \Drupal\layout_plugin\Plugin\Layout\LayoutInterface

File

src/Plugin/Layout/LayoutInterface.php, line 11

Namespace

Drupal\layout_plugin\Plugin\Layout

interface LayoutInterface extends PluginInspectionInterface, DerivativeInspectionInterface {

  /**
   * Build a render array for layout with regions.
   *
   * @param array $regions
   *   An associative array keyed by region name, containing render arrays
   *   representing the content that should be placed in each region.
   *
   * @return array
   *   Render array for the layout with regions.
   */
  public function build(array $regions);

}

Members

Name	Modifiers	Type	Description	Overrides
DerivativeInspectionInterface::getBaseId	public	function	Gets the base_plugin_id of the plugin instance.	1
DerivativeInspectionInterface::getDerivativeId	public	function	Gets the derivative_id of the plugin instance.	1
LayoutInterface::build	public	function	Build a render array for layout with regions.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2