Defines the shared interface for all layout plugins.
Expanded class hierarchy of LayoutInterface
All classes that implement LayoutInterface
interface LayoutInterface extends PluginInspectionInterface {
/**
* Returns a list of regions.
*
* @return array
* An associative array of region information keyed by region machine
* names. Each region information element is a two item associative array
* with a 'label' and a 'type' key designating the human readable label
* and the type of the region.
*/
public function getRegions();
/**
* Renders layout and returns the rendered markup.
*
* @param bool $admin
* (optional) TRUE if the rendered layout is displayed in an administrative
* context, FALSE otherwise. Defaults to FALSE.
* @param array $regions
* (optional) An array of region render arrays keyed by region machine
* names. Defaults to array.
*
* @return string
* Rendered HTML output from the layout.
*/
public function renderLayout($admin = FALSE, $regions = array());
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
LayoutInterface:: |
public | function | Returns a list of regions. | 1 |
LayoutInterface:: |
public | function | Renders layout and returns the rendered markup. | 1 |
PluginInspectionInterface:: |
public | function | Returns the definition of the plugin implementation. | 1 |
PluginInspectionInterface:: |
public | function | Returns the plugin_id of the plugin instance. | 1 |