interface UnboundDisplayInterface

Interface for a Display that is not coupled with any layout.

Unbound displays contain references to blocks, but not to any particular layout. Their primary use case is to express a set of relative block placements without necessitating any particular layout be present. This allows upstream (module and distribution) developers to express a visual composition of blocks without knowing anything about the layouts a particular site has available.

Hierarchy

Expanded class hierarchy of UnboundDisplayInterface

All classes that implement UnboundDisplayInterface

See also

\Drupal\layout\Config\DisplayInterface

2 files declare their use of UnboundDisplayInterface
Display.php in drupal/core/modules/layout/lib/Drupal/layout/Plugin/Core/Entity/Display.php
Definition of Drupal\layout\Plugin\Core\Entity\Display.
UnboundDisplay.php in drupal/core/modules/layout/lib/Drupal/layout/Plugin/Core/Entity/UnboundDisplay.php
Definition of Drupal\layout\Plugin\Core\Entity\Display.

File

drupal/core/modules/layout/lib/Drupal/layout/Config/UnboundDisplayInterface.php, line 23
Definition of Drupal\layout\Config\UnboundDisplayInterface

Namespace

Drupal\layout\Config
View source
interface UnboundDisplayInterface extends DisplayInterface {

  /**
   * Returns a bound display entity by binding a layout to this unbound display.
   *
   * This will DisplayInterface::mapBlocksToLayout() using the provided layout,
   * then create and return a new Display object with the output. This is just
   * a factory - calling code is responsible for saving the returned object.
   *
   * @param \Drupal\layout\Plugin\LayoutInterface $layout
   *   The desired layout.
   *
   * @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\BoundDisplayInterface.
   *
   * @return \Drupal\layout\Config\BoundDisplayInterface
   *   The newly created entity.
   */
  public function generateDisplay(LayoutInterface $layout, $id, $entity_type = 'display');

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 5
ComplexDataInterface::get public function Gets a property object. 7
ComplexDataInterface::getProperties public function Gets an array of property objects. 7
ComplexDataInterface::getPropertyDefinition public function Gets the definition of a contained property. 7
ComplexDataInterface::getPropertyDefinitions public function Gets an array of property definitions of contained properties. 7
ComplexDataInterface::getPropertyValues public function Gets an array of property values. 7
ComplexDataInterface::isEmpty public function Determines whether the data structure is empty. 7
ComplexDataInterface::onChange public function React to changes to a child property. 7
ComplexDataInterface::set public function Sets a property value. 7
ComplexDataInterface::setPropertyValues public function Sets multiple property values. 7
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::getOriginalID public function Returns the original ID. 2
ConfigEntityInterface::setOriginalID public function Sets the original ID. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
DisplayInterface::getAllBlockInfo public function Returns the display-specific configuration of all blocks in this display. 1
DisplayInterface::getAllRegionTypes public function Returns the names of all region types to which blocks are assigned. 1
DisplayInterface::mapBlocksToLayout public function Maps the contained block info to the provided layout. 1
EntityInterface::bundle public function Returns the bundle of the entity. 3
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 3
EntityInterface::delete public function Deletes an entity permanently. 3
EntityInterface::enforceIsNew public function Enforces an entity to be new. 3
EntityInterface::entityInfo public function Returns the info of the type of the entity. 3
EntityInterface::entityType public function Returns the type of the entity. 3
EntityInterface::getBCEntity public function Gets a backward compatibility decorator entity. 3
EntityInterface::getExportProperties public function Retrieves the exportable properties of the entity. 3
EntityInterface::getNGEntity public function Removes any possible (backward compatibility) decorator in use. 3
EntityInterface::getRevisionId public function Returns the revision identifier of the entity. 3
EntityInterface::id public function Returns the entity identifier (the entity's machine name or numeric ID). 3
EntityInterface::isDefaultRevision public function Checks if this entity is the default revision. 3
EntityInterface::isNew public function Returns whether the entity is new. 3
EntityInterface::isNewRevision public function Returns whether a new revision should be created on save. 3
EntityInterface::isTranslatable public function Returns the translation support status. 3
EntityInterface::label public function Returns the label of the entity. 3
EntityInterface::save public function Saves an entity permanently. 3
EntityInterface::setNewRevision public function Enforces an entity to be saved as a new revision. 3
EntityInterface::uri public function Returns the URI elements of the entity. 3
EntityInterface::uriRelationships public function Returns a list of URI relationships supported by this entity. 3
EntityInterface::uuid public function Returns the entity UUID (Universally Unique Identifier). 3
TranslatableInterface::getTranslation public function Gets a translation of the data. 3
TranslatableInterface::getTranslationLanguages public function Returns the languages the data is translated to. 3
TranslatableInterface::language public function Returns the default language. 3
TypedDataInterface::getConstraints public function Gets a list of validation constraints. 4
TypedDataInterface::getDefinition public function Gets the data definition. 4
TypedDataInterface::getName public function Returns the name of a property or item. 4
TypedDataInterface::getParent public function Returns the parent data structure; i.e. either complex data or a list. 4
TypedDataInterface::getPropertyPath public function Returns the property path of the data. 4
TypedDataInterface::getRoot public function Returns the root of the typed data tree. 4
TypedDataInterface::getString public function Returns a string representation of the data. 4
TypedDataInterface::getType public function Gets the data type. 5
TypedDataInterface::getValue public function Gets the data value. 4
TypedDataInterface::setContext public function Sets the context of a property or item via a context aware parent. 4
TypedDataInterface::setValue public function Sets the data value. 4
TypedDataInterface::validate public function Validates the currently set data value. 4
UnboundDisplayInterface::generateDisplay public function Returns a bound display entity by binding a layout to this unbound display. 1