class UnboundDisplay

Defines the unbound_display entity.

Unbound displays contain blocks that are not 'bound' to a specific layout, and their contained blocks are mapped only to region types, not regions.

Plugin annotation


@Plugin(
  id = "unbound_display",
  label = @Translation("Unbound Display"),
  module = "layout",
  controller_class = "Drupal\Core\Config\Entity\ConfigStorageController",
  config_prefix = "display.unbound",
  entity_keys = {
    "id" = "id",
    "uuid" = "uuid"
  }
)

Hierarchy

Expanded class hierarchy of UnboundDisplay

1 file declares its use of UnboundDisplay
DisplayInternalLogicTest.php in drupal/core/modules/layout/lib/Drupal/layout/Tests/DisplayInternalLogicTest.php
Definition of \Drupal\layout\Tests\DisplayInternalLogicTest.

File

drupal/core/modules/layout/lib/Drupal/layout/Plugin/Core/Entity/UnboundDisplay.php, line 35
Definition of Drupal\layout\Plugin\Core\Entity\Display.

Namespace

Drupal\layout\Plugin\Core\Entity
View source
class UnboundDisplay extends DisplayBase implements UnboundDisplayInterface {

  /**
   * Implements UnboundDisplayInterface::generateDisplay().
   *
   * @throws \Exception
   */
  public function generateDisplay(LayoutInterface $layout, $id, $entity_type = 'display') {
    $values = array(
      'layout' => $layout
        ->getPluginId(),
      'blockInfo' => $this
        ->mapBlocksToLayout($layout),
      'id' => $id,
    );
    $entity = entity_create($entity_type, $values);
    if (!$entity instanceof BoundDisplayInterface) {
      throw new \Exception(sprintf('Attempted to bind an unbound display but provided an invalid entity type.'), E_RECOVERABLE_ERROR);
    }
    return $entity;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigEntityBase::$originalID protected property The original ID of the configuration entity.
ConfigEntityBase::createDuplicate public function Overrides Entity::createDuplicate(). Overrides Entity::createDuplicate 1
ConfigEntityBase::get public function Overrides Entity::get(). Overrides Entity::get 1
ConfigEntityBase::getOriginalID public function Implements ConfigEntityInterface::getOriginalID(). Overrides ConfigEntityInterface::getOriginalID
ConfigEntityBase::isNew final public function Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::set public function Overrides Entity::set(). Overrides Entity::set
ConfigEntityBase::setOriginalID public function Implements ConfigEntityInterface::setOriginalID(). Overrides ConfigEntityInterface::setOriginalID
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label.
ConfigEntityBase::__construct public function Overrides Entity::__construct(). Overrides Entity::__construct 2
DisplayBase::$blockInfo protected property Contains all block configuration.
DisplayBase::$id public property The ID (config name) identifying a specific display object.
DisplayBase::$uuid public property The UUID identifying a specific display object.
DisplayBase::getAllBlockInfo public function Implements DisplayInterface::getAllBlockInfo(). Overrides DisplayInterface::getAllBlockInfo
DisplayBase::getAllRegionTypes public function Implements DisplayInterface::getAllRegionTypes(). Overrides DisplayInterface::getAllRegionTypes
DisplayBase::mapBlocksToLayout public function Implements DisplayInterface::mapBlocksToLayout(). Overrides DisplayInterface::mapBlocksToLayout
Entity::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
Entity::$entityType protected property The entity type.
Entity::$isDefaultRevision protected property Indicates whether this is the default revision. 1
Entity::$langcode public property The language code of the entity's default language. 4
Entity::$newRevision protected property Boolean indicating whether a new revision should be created on save.
Entity::access public function Implements AccessibleInterface::access(). Overrides AccessibleInterface::access
Entity::bundle public function Implements EntityInterface::bundle(). Overrides EntityInterface::bundle 4
Entity::delete public function Implements EntityInterface::delete(). Overrides EntityInterface::delete
Entity::enforceIsNew public function Implements EntityInterface::enforceIsNew(). Overrides EntityInterface::enforceIsNew
Entity::entityInfo public function Implements EntityInterface::entityInfo(). Overrides EntityInterface::entityInfo
Entity::entityType public function Implements EntityInterface::entityType(). Overrides EntityInterface::entityType
Entity::getIterator public function Implements ComplexDataInterface::getIterator(). 1
Entity::getProperties public function Implements ComplexDataInterface::getProperties(). Overrides ComplexDataInterface::getProperties 1
Entity::getPropertyDefinition public function Implements ComplexDataInterface::getPropertyDefinition(). Overrides ComplexDataInterface::getPropertyDefinition 1
Entity::getPropertyDefinitions public function Implements ComplexDataInterface::getPropertyDefinitions(). Overrides ComplexDataInterface::getPropertyDefinitions 1
Entity::getPropertyValues public function Implements ComplexDataInterface::getPropertyValues(). Overrides ComplexDataInterface::getPropertyValues 1
Entity::getRevisionId public function Implements Drupal\Core\Entity\EntityInterface::getRevisionId(). Overrides EntityInterface::getRevisionId 3
Entity::getTranslation public function Implements TranslatableInterface::getTranslation(). Overrides TranslatableInterface::getTranslation 1
Entity::getTranslationLanguages public function Implements TranslatableInterface::getTranslationLanguages(). Overrides TranslatableInterface::getTranslationLanguages 1
Entity::id public function Implements EntityInterface::id(). Overrides EntityInterface::id 10
Entity::isDefaultRevision public function Implements Drupal\Core\Entity\EntityInterface::isDefaultRevision(). Overrides EntityInterface::isDefaultRevision 1
Entity::isEmpty public function Implements ComplexDataInterface::isEmpty(). Overrides ComplexDataInterface::isEmpty 1
Entity::isNewRevision public function Implements EntityInterface::isNewRevision(). Overrides EntityInterface::isNewRevision
Entity::label public function Implements EntityInterface::label(). Overrides EntityInterface::label 1
Entity::language public function Implements TranslatableInterface::language(). Overrides TranslatableInterface::language 1
Entity::save public function Implements EntityInterface::save(). Overrides EntityInterface::save 3
Entity::setNewRevision public function Implements EntityInterface::setNewRevision(). Overrides EntityInterface::setNewRevision
Entity::setPropertyValues public function Implements ComplexDataInterface::setPropertyValues(). Overrides ComplexDataInterface::setPropertyValues 1
Entity::translations public function Returns the languages the entity is translated to.
Entity::uri public function Implements EntityInterface::uri(). Overrides EntityInterface::uri 1
Entity::uuid public function Implements EntityInterface::uuid(). Overrides EntityInterface::uuid 1
UnboundDisplay::generateDisplay public function Implements UnboundDisplayInterface::generateDisplay(). Overrides UnboundDisplayInterface::generateDisplay