Interface for a Display object that is coupled to a specific layout.
Bound displays contains references both to block instances and a specific layout, and the blocks are assigned to specific regions in that layout. Bound displays are used to serve real pages at request time.
Expanded class hierarchy of BoundDisplayInterface
All classes that implement BoundDisplayInterface
\Drupal\layout\Config\DisplayInterface
interface BoundDisplayInterface extends DisplayInterface {
/**
* Sets the layout to be used by this display.
*
* @param string $layout_id
* The id of the desired layout.
*/
public function setLayout($layout_id);
/**
* Returns the blocks in the requested region, ordered by weight.
*
* @param string $region
* The region from which to return the set of blocks.
*
* @return array
* The list of blocks, ordered by their weight within this display. Each
* value in the list is the configuration object name of the block.
*/
public function getSortedBlocksByRegion($region);
/**
* Returns this display's blocks, organized by region and ordered by weight.
*
* @return array
* An array keyed by region name. For each region, the value is the same as
* what is returned by getSortedBlocksByRegion().
*
* @see getSortedBlocksByRegion()
*/
public function getAllSortedBlocks();
/**
* Returns the instantiated layout object to be used by this display.
*
* @return \Drupal\layout\Plugin\LayoutInterface
*/
public function getLayoutInstance();
/**
* Adjusts this display's block placement to work with the provided layout.
*
* Essentially a shortcut that calls DisplayInterface::mapBlocksToLayout(),
* saves the result in the appropriate object property, and finally calls
* BoundDisplayInterface::setLayout().
*
* @param \Drupal\layout\Plugin\LayoutInterface $layout
* The new layout to which blocks should be remapped.
*
* @see \Drupal\layout\Config\DisplayInterface::mapBlocksToLayout()
*/
public function remapToLayout(LayoutInterface $layout);
/**
* Returns an entity with the non-layout-specific configuration of this one.
*
* @param string $id
* The entity id to assign to the newly created entity.
*
* @param string $entity_type
* The type of entity to create. The PHP class for this entity type must
* implement \Drupal\layout\Config\UnboundDisplayInterface.
*
* @return \Drupal\layout\Config\UnboundDisplayInterface
* The newly-created unbound display.
*/
public function generateUnboundDisplay($id, $entity_type = 'unbound_display');
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BoundDisplayInterface:: |
public | function | Adjusts this display's block placement to work with the provided layout. | 1 |
AccessibleInterface:: |
public | function | Checks data value access. | 5 |
EntityInterface:: |
public | function | Checks if this entity is the default revision. | 3 |
EntityInterface:: |
public | function | Creates a duplicate of the entity. | 3 |
EntityInterface:: |
public | function | Deletes an entity permanently. | 3 |
ComplexDataInterface:: |
public | function | Determines whether the data structure is empty. | 7 |
ConfigEntityInterface:: |
public | function | Disables the configuration entity. | 2 |
ConfigEntityInterface:: |
public | function | Enables the configuration entity. | 2 |
EntityInterface:: |
public | function | Enforces an entity to be new. | 3 |
EntityInterface:: |
public | function | Enforces an entity to be saved as a new revision. | 3 |
EntityInterface:: |
public | function | Gets a backward compatibility decorator entity. | 3 |
TypedDataInterface:: |
public | function | Gets a list of validation constraints. | 4 |
ComplexDataInterface:: |
public | function | Gets a property object. | 7 |
TranslatableInterface:: |
public | function | Gets a translation of the data. | 3 |
ComplexDataInterface:: |
public | function | Gets an array of property definitions of contained properties. | 7 |
ComplexDataInterface:: |
public | function | Gets an array of property objects. | 7 |
ComplexDataInterface:: |
public | function | Gets an array of property values. | 7 |
TypedDataInterface:: |
public | function | Gets the data definition. | 4 |
TypedDataInterface:: |
public | function | Gets the data type. | 5 |
TypedDataInterface:: |
public | function | Gets the data value. | 4 |
ComplexDataInterface:: |
public | function | Gets the definition of a contained property. | 7 |
DisplayInterface:: |
public | function | Maps the contained block info to the provided layout. | 1 |
ComplexDataInterface:: |
public | function | React to changes to a child property. | 7 |
EntityInterface:: |
public | function | Removes any possible (backward compatibility) decorator in use. | 3 |
EntityInterface:: |
public | function | Retrieves the exportable properties of the entity. | 3 |
EntityInterface:: |
public | function | Returns a list of URI relationships supported by this entity. | 3 |
TypedDataInterface:: |
public | function | Returns a string representation of the data. | 4 |
BoundDisplayInterface:: |
public | function | Returns an entity with the non-layout-specific configuration of this one. | 1 |
BoundDisplayInterface:: |
public | function | Returns the blocks in the requested region, ordered by weight. | 1 |
EntityInterface:: |
public | function | Returns the bundle of the entity. | 3 |
TranslatableInterface:: |
public | function | Returns the default language. | 3 |
DisplayInterface:: |
public | function | Returns the display-specific configuration of all blocks in this display. | 1 |
EntityInterface:: |
public | function | Returns the entity identifier (the entity's machine name or numeric ID). | 3 |
EntityInterface:: |
public | function | Returns the entity UUID (Universally Unique Identifier). | 3 |
EntityInterface:: |
public | function | Returns the info of the type of the entity. | 3 |
BoundDisplayInterface:: |
public | function | Returns the instantiated layout object to be used by this display. | 1 |
EntityInterface:: |
public | function | Returns the label of the entity. | 3 |
TranslatableInterface:: |
public | function | Returns the languages the data is translated to. | 3 |
TypedDataInterface:: |
public | function | Returns the name of a property or item. | 4 |
DisplayInterface:: |
public | function | Returns the names of all region types to which blocks are assigned. | 1 |
ConfigEntityInterface:: |
public | function | Returns the original ID. | 2 |
TypedDataInterface:: |
public | function | Returns the parent data structure; i.e. either complex data or a list. | 4 |
TypedDataInterface:: |
public | function | Returns the property path of the data. | 4 |
EntityInterface:: |
public | function | Returns the revision identifier of the entity. | 3 |
TypedDataInterface:: |
public | function | Returns the root of the typed data tree. | 4 |
EntityInterface:: |
public | function | Returns the translation support status. | 3 |
EntityInterface:: |
public | function | Returns the type of the entity. | 3 |
EntityInterface:: |
public | function | Returns the URI elements of the entity. | 3 |
BoundDisplayInterface:: |
public | function | Returns this display's blocks, organized by region and ordered by weight. | 1 |
EntityInterface:: |
public | function | Returns whether a new revision should be created on save. | 3 |
ConfigEntityInterface:: |
public | function | Returns whether the configuration entity is enabled. | 2 |
EntityInterface:: |
public | function | Returns whether the entity is new. | 3 |
EntityInterface:: |
public | function | Saves an entity permanently. | 3 |
ComplexDataInterface:: |
public | function | Sets a property value. | 7 |
ComplexDataInterface:: |
public | function | Sets multiple property values. | 7 |
TypedDataInterface:: |
public | function | Sets the context of a property or item via a context aware parent. | 4 |
TypedDataInterface:: |
public | function | Sets the data value. | 4 |
BoundDisplayInterface:: |
public | function | Sets the layout to be used by this display. | 1 |
ConfigEntityInterface:: |
public | function | Sets the original ID. | 2 |
ConfigEntityInterface:: |
public | function | Sets the status of the configuration entity. | 2 |
TypedDataInterface:: |
public | function | Validates the currently set data value. | 4 |