You are here

Home » API reference » Layout 8.2 » BoundDisplayInterface.php

interface BoundDisplayInterface in Layout 8.2

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.

Hierarchy

Expanded class hierarchy of BoundDisplayInterface

All classes that implement BoundDisplayInterface

See also

\Drupal\layout\Config\DisplayInterface

2 files declare their use of BoundDisplayInterface
Display.php in lib/Drupal/layout/Entity/Display.php
Definition of Drupal\layout\Entity\Display.
UnboundDisplay.php in lib/Drupal/layout/Entity/UnboundDisplay.php
Definition of Drupal\layout\Entity\Display.

File

lib/Drupal/layout/Config/BoundDisplayInterface.php, line 20
Definition of Drupal\layout\Config\BoundDisplayInterface

Namespace

Drupal\layout\Config
View source 
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');

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
BoundDisplayInterface::generateUnboundDisplay public function Returns an entity with the non-layout-specific configuration of this one. 1
BoundDisplayInterface::getAllSortedBlocks public function Returns this display's blocks, organized by region and ordered by weight. 1
BoundDisplayInterface::getLayoutInstance public function Returns the instantiated layout object to be used by this display. 1
BoundDisplayInterface::getSortedBlocksByRegion public function Returns the blocks in the requested region, ordered by weight. 1
BoundDisplayInterface::remapToLayout public function Adjusts this display's block placement to work with the provided layout. 1
BoundDisplayInterface::setLayout public function Sets the layout to be used by this display. 1
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 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
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 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 Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::link Deprecated public function Deprecated way of generating a link to the entity. See toLink(). 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::url Deprecated public function Gets the public URL for this entity. 2
EntityInterface::urlInfo Deprecated public function Gets the URL object for the entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5