interface LayoutEntityDisplayInterface

Same name in other branches
  1. 9 core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface
  2. 10 core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface
  3. 11.x core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface

Provides an interface for entity displays that have layout.

@todo Refactor this interface in https://www.drupal.org/node/2985362.

Hierarchy

  • interface \Drupal\Core\Entity\Display\EntityDisplayInterface extends \Drupal\Core\Config\Entity\ConfigEntityInterface \Drupal\Core\Entity\EntityWithPluginCollectionInterface; interface \Drupal\layout_builder\LayoutBuilderEnabledInterface; interface \Drupal\layout_builder\SectionListInterface extends \Drupal\layout_builder\Countable
    • interface \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface extends \Drupal\Core\Entity\Display\EntityDisplayInterface \Drupal\layout_builder\SectionListInterface \Drupal\layout_builder\LayoutBuilderEnabledInterface

Expanded class hierarchy of LayoutEntityDisplayInterface

All classes that implement LayoutEntityDisplayInterface

6 files declare their use of LayoutEntityDisplayInterface
DefaultsEntityForm.php in core/modules/layout_builder/src/Form/DefaultsEntityForm.php
DefaultsSectionStorageTest.php in core/modules/layout_builder/tests/src/Unit/DefaultsSectionStorageTest.php
LayoutBuilderEntityViewDisplayForm.php in core/modules/layout_builder/src/Form/LayoutBuilderEntityViewDisplayForm.php
LayoutEntityDisplayNormalizer.php in core/modules/layout_builder/src/Normalizer/LayoutEntityDisplayNormalizer.php
LayoutEntityHelperTrait.php in core/modules/layout_builder/src/LayoutEntityHelperTrait.php

... See full list

File

core/modules/layout_builder/src/Entity/LayoutEntityDisplayInterface.php, line 14

Namespace

Drupal\layout_builder\Entity
View source 
interface LayoutEntityDisplayInterface extends EntityDisplayInterface, SectionListInterface, LayoutBuilderEnabledInterface {
    
    /**
     * Determines if the display allows custom overrides.
     *
     * @return bool
     *   TRUE if custom overrides are allowed, FALSE otherwise.
     */
    public function isOverridable();
    
    /**
     * Sets the display to allow or disallow overrides.
     *
     * @param bool $overridable
     *   TRUE if the display should allow overrides, FALSE otherwise.
     *
     * @return $this
     */
    public function setOverridable($overridable = TRUE);

}

Members

Title Deprecated Modifiers Object type Summary Overrides
AccessibleInterface::access public function Checks data value access. 9
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
EntityDisplayInterface::createCopy public function Creates a duplicate of the entity display object on a different view mode. 1
EntityDisplayInterface::getComponent public function Gets the display options set for a component. 1
EntityDisplayInterface::getComponents public function Gets the display options for all components. 1
EntityDisplayInterface::getHighestWeight public function Gets the highest weight of the components in the display. 1
EntityDisplayInterface::getMode public function Gets the view or form mode to be displayed. 1
EntityDisplayInterface::getOriginalMode public function Gets the original view or form mode that was requested. 1
EntityDisplayInterface::getRenderer public function Gets the renderer plugin for a field (e.g. widget, formatter). 2
EntityDisplayInterface::getTargetBundle public function Gets the bundle to be displayed. 1
EntityDisplayInterface::getTargetEntityTypeId public function Gets the entity type for which this display is used. 1
EntityDisplayInterface::removeComponent public function Sets a component to be hidden. 1
EntityDisplayInterface::setComponent public function Sets the display options for a component. 1
EntityDisplayInterface::setTargetBundle public function Sets the bundle to be displayed. 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
LayoutBuilderEnabledInterface::disableLayoutBuilder public function Disables the Layout Builder. 2
LayoutBuilderEnabledInterface::enableLayoutBuilder public function Enables the Layout Builder. 2
LayoutBuilderEnabledInterface::isLayoutBuilderEnabled public function Determines if Layout Builder is enabled. 2
LayoutEntityDisplayInterface::isOverridable public function Determines if the display allows custom overrides. 1
LayoutEntityDisplayInterface::setOverridable public function Sets the display to allow or disallow overrides. 1
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
SectionListInterface::appendSection public function Appends a new section to the end of the list. 1
SectionListInterface::getSection public function Gets a domain object for the layout section. 1
SectionListInterface::getSections public function Gets the layout sections. 5
SectionListInterface::insertSection public function Inserts a new section at a given delta. 1
SectionListInterface::removeAllSections public function Removes all of the sections. 1
SectionListInterface::removeSection public function Removes the section at the given delta. 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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.