interface LayoutEntityDisplayInterface in Drupal 10

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; interface \Drupal\layout_builder\SectionListInterface extends \Drupal\layout_builder\Countable; interface \Drupal\layout_builder\LayoutBuilderEnabledInterface
  • interface \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface

7 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

LayoutBuilderIsActiveCacheContext.php in core/modules/layout_builder/src/Cache/LayoutBuilderIsActiveCacheContext.php

LayoutBuilderIsActiveCacheContextTest.php in core/modules/layout_builder/tests/src/Unit/LayoutBuilderIsActiveCacheContextTest.php

... See full list

File

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

Namespace

Drupal\layout_builder\Entity

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

Name	Modifiers	Type	Description	Overrides
AccessibleInterface::access	public	function	Checks data value access.	4
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	19
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	19
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	13
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.	1
EntityInterface::create	public static	function	Constructs a new entity object, without permanently saving it.	1
EntityInterface::createDuplicate	public	function	Creates a duplicate of the entity.	1
EntityInterface::delete	public	function	Deletes an entity permanently.	1
EntityInterface::enforceIsNew	public	function	Enforces an entity to be new.	1
EntityInterface::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches.	1
EntityInterface::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies.	1
EntityInterface::getConfigDependencyName	public	function	Gets the configuration dependency name.	1
EntityInterface::getConfigTarget	public	function	Gets the configuration target identifier for the entity.	1
EntityInterface::getEntityType	public	function	Gets the entity type definition.	1
EntityInterface::getEntityTypeId	public	function	Gets the ID of the type of the entity.	1
EntityInterface::getOriginalId	public	function	Gets the original ID.	1
EntityInterface::getTypedData	public	function	Gets a typed data object for this entity object.	1
EntityInterface::hasLinkTemplate	public	function	Indicates if a link template exists for a given key.	1
EntityInterface::id	public	function	Gets the identifier.	1
EntityInterface::isNew	public	function	Determines whether the entity is new.	1
EntityInterface::label	public	function	Gets the label of the entity.	1
EntityInterface::language	public	function	Gets the language of the entity.	1
EntityInterface::load	public static	function	Loads an entity.	1
EntityInterface::loadMultiple	public static	function	Loads one or more entities.	1
EntityInterface::postCreate	public	function	Acts on a created entity before hooks are invoked.	1
EntityInterface::postDelete	public static	function	Acts on deleted entities before the delete hook is invoked.	1
EntityInterface::postLoad	public static	function	Acts on loaded entities.	1
EntityInterface::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked.	1
EntityInterface::preCreate	public static	function	Changes the values of an entity before it is created.	1
EntityInterface::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked.	1
EntityInterface::preSave	public	function	Acts on an entity before the presave hook is invoked.	1
EntityInterface::referencedEntities	public	function	Gets a list of entities referenced by this entity.	1
EntityInterface::save	public	function	Saves an entity permanently.	1
EntityInterface::setOriginalId	public	function	Sets the original ID.	1
EntityInterface::toArray	public	function	Gets an array of all property values.	1
EntityInterface::toLink	public	function	Generates the HTML for a link to this entity.	1
EntityInterface::toUrl	public	function	Gets the URL object for the entity.	1
EntityInterface::uriRelationships	public	function	Gets a list of URI relationships supported by this entity.	1
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	1
LayoutBuilderEnabledInterface::disableLayoutBuilder	public	function	Disables the Layout Builder.	1
LayoutBuilderEnabledInterface::enableLayoutBuilder	public	function	Enables the Layout Builder.	1
LayoutBuilderEnabledInterface::isLayoutBuilderEnabled	public	function	Determines if Layout Builder is enabled.	1
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
ObjectWithPluginCollectionInterface::getPluginCollections	public	function	Gets the plugin collections used by this object.	10
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.
SectionListInterface::getSection	public	function	Gets a domain object for the layout section.
SectionListInterface::getSections	public	function	Gets the layout sections.	2
SectionListInterface::insertSection	public	function	Inserts a new section at a given delta.
SectionListInterface::removeAllSections	public	function	Removes all of the sections.
SectionListInterface::removeSection	public	function	Removes the section at the given delta.
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.	4
ThirdPartySettingsInterface::getThirdPartySetting	public	function	Gets the value of a third-party setting.	4
ThirdPartySettingsInterface::getThirdPartySettings	public	function	Gets all third-party settings of a given module.	4
ThirdPartySettingsInterface::setThirdPartySetting	public	function	Sets the value of a third-party setting.	4
ThirdPartySettingsInterface::unsetThirdPartySetting	public	function	Unsets a third-party setting.	4