class LayoutBuilderEntityViewDisplay

Same name in this branch

main core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php \Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay
main core/modules/layout_builder/tests/modules/layout_builder_override_dependency/src/LayoutBuilderEntityViewDisplay.php \Drupal\layout_builder_override_dependency\LayoutBuilderEntityViewDisplay

Same name and namespace in other branches

11.x core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php \Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay
10 core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php \Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay
9 core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php \Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay
8.9.x core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php \Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay
11.x core/modules/layout_builder/tests/modules/layout_builder_override_dependency/src/LayoutBuilderEntityViewDisplay.php \Drupal\layout_builder_override_dependency\LayoutBuilderEntityViewDisplay
11.x core/modules/layout_builder/tests/modules/layout_builder_override/src/LayoutBuilderEntityViewDisplay.php \Drupal\layout_builder_override\LayoutBuilderEntityViewDisplay

Provides an entity view display entity that has a layout.

Hierarchy

class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
  - class \Drupal\Core\Entity\EntityDisplayBase implements \Drupal\Core\Entity\Display\EntityDisplayInterface extends \Drupal\Core\Config\Entity\ConfigEntityBase
    - class \Drupal\Core\Entity\Entity\EntityViewDisplay implements \Drupal\Core\Entity\Display\EntityViewDisplayInterface extends \Drupal\Core\Entity\EntityDisplayBase
      - class \Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay implements \Drupal\layout_builder\Entity\LayoutEntityDisplayInterface uses \Drupal\layout_builder\LayoutEntityHelperTrait, \Drupal\layout_builder\SectionListTrait, \Drupal\Core\StringTranslation\StringTranslationTrait extends \Drupal\Core\Entity\Entity\EntityViewDisplay
        class \Drupal\layout_builder_override\LayoutBuilderEntityViewDisplay extends \Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay

Expanded class hierarchy of LayoutBuilderEntityViewDisplay

2 files declare their use of LayoutBuilderEntityViewDisplay

LayoutBuilderOverrideHook.php in core/modules/layout_builder/tests/modules/layout_builder_override/src/Hook/LayoutBuilderOverrideHook.php
LayoutBuilderOverrideTest.php in core/modules/layout_builder/tests/src/Kernel/LayoutBuilderOverrideTest.php

File

View on git.drupalcode.org

core/modules/layout_builder/tests/modules/layout_builder_override/src/LayoutBuilderEntityViewDisplay.php, line 12

Namespace

Drupal\layout_builder_override

View source

class LayoutBuilderEntityViewDisplay extends BaseLayoutBuilderEntityViewDisplay {

}

Members

Title Sort descending	Deprecated	Modifiers	Object type	Summary	Member alias	Overriden Title	Overrides
CacheableDependencyTrait::$cacheContexts		protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge		protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags		protected	property	Cache tags.
CacheableDependencyTrait::setCacheability		protected	function	Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling		private	property	Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode		protected	property	The language code of the entity's default language.
ConfigEntityBase::$originalId		protected	property	The original ID of the configuration entity.
ConfigEntityBase::$third_party_settings		protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	Deprecated	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid		protected	property	The UUID for this entity.
ConfigEntityBase::$_core		protected	property	Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency		protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate		public	function			Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable		public	function	#[ActionMethod(adminLabel: new TranslatableMarkup('Disable'), pluralize: FALSE)]		Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable		public	function	#[ActionMethod(adminLabel: new TranslatableMarkup('Enable'), pluralize: FALSE)]		Overrides ConfigEntityInterface::enable
ConfigEntityBase::get		public	function			Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate		public	function			Overrides EntityBase::getCacheTagsToInvalidate	2
ConfigEntityBase::getConfigDependencyName		public	function			Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager		protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget		public	function			Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies		public	function			Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId		public	function			Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders		public	function			Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting		public	function			Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings		public	function			Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig		protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData		public	function			Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete		protected static	function	Override to never invalidate the individual entities' cache tags; the config system already invalidates them.		Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave		protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it.		Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable		public	function			Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew		public	function	Overrides EntityBase::isNew().		Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling		public	function			Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::preDelete		public static	function			Overrides EntityBase::preDelete	8
ConfigEntityBase::setOriginalId		public	function			Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus		public	function	#[ActionMethod(adminLabel: new TranslatableMarkup('Set status'), pluralize: FALSE)]		Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting		public	function	#[ActionMethod(adminLabel: new TranslatableMarkup('Set third-party setting'))]		Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling		public	function
ConfigEntityBase::sort		public static	function	Callback for uasort() to sort configuration entities by weight and label.			6
ConfigEntityBase::status		public	function			Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toUrl		public	function			Overrides EntityBase::toUrl
ConfigEntityBase::trustData		public	function			Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting		public	function			Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
DependencySerializationTrait::$_entityStorages		protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds		protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep		public	function		Aliased as: traitSleep		2
DependencyTrait::$dependencies		protected	property	The object's dependencies.
DependencyTrait::addDependencies		protected	function	Adds multiple dependencies.
DependencyTrait::addDependency		protected	function	Adds a dependency.	Aliased as: addDependencyTrait
EntityBase::$enforceIsNew		protected	property	Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId		protected	property	The entity type.
EntityBase::$originalEntity		protected	property	The original unchanged entity.
EntityBase::$typedData		protected	property	A weak reference to the typed data object wrapping this entity.
EntityBase::access		public	function			Overrides AccessibleInterface::access	1
EntityBase::bundle		public	function			Overrides EntityInterface::bundle	1
EntityBase::create		public static	function			Overrides EntityInterface::create	2
EntityBase::delete		public	function			Overrides EntityInterface::delete	1
EntityBase::enforceIsNew		public	function			Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo		protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager		protected	function	Gets the entity type manager.
EntityBase::getCacheContexts		public	function			Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge		public	function			Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags		public	function			Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey		public	function			Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType		public	function			Overrides EntityInterface::getEntityType	1
EntityBase::getEntityTypeId		public	function			Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate		protected	function	The list cache tags to invalidate for this entity.
EntityBase::getOriginal		public	function			Overrides EntityInterface::getOriginal
EntityBase::getTypedData		public	function	#[\NoDiscard]		Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass		private	function	Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate		public	function			Overrides EntityInterface::hasLinkTemplate
EntityBase::language		public	function			Overrides EntityInterface::language	1
EntityBase::languageManager		protected	function	Gets the language manager.
EntityBase::linkTemplates		protected	function	Gets an array link templates.			1
EntityBase::load		public static	function			Overrides EntityInterface::load
EntityBase::loadMultiple		public static	function			Overrides EntityInterface::loadMultiple
EntityBase::postCreate		public	function			Overrides EntityInterface::postCreate	5
EntityBase::postDelete		public static	function			Overrides EntityInterface::postDelete	17
EntityBase::postLoad		public static	function			Overrides EntityInterface::postLoad	3
EntityBase::preCreate		public static	function			Overrides EntityInterface::preCreate	6
EntityBase::referencedEntities		public	function			Overrides EntityInterface::referencedEntities	1
EntityBase::setOriginal		public	function			Overrides EntityInterface::setOriginal
EntityBase::toLink		public	function			Overrides EntityInterface::toLink
EntityBase::uriRelationships		public	function			Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters		protected	function	Gets an array of placeholders for this entity.			2
EntityBase::uuid		public	function			Overrides EntityInterface::uuid	1
EntityBase::uuidGenerator		protected	function	Gets the UUID generator.
EntityDisplayBase::$bundle		protected	property	Bundle to be displayed.
EntityDisplayBase::$content		protected	property	List of component display options, keyed by component name.
EntityDisplayBase::$fieldDefinitions		protected	property	A list of field definitions eligible for configuration in this display.
EntityDisplayBase::$hidden		protected	property	List of components that are set to be hidden.
EntityDisplayBase::$id		protected	property	Unique ID for the config entity.
EntityDisplayBase::$initialized		protected	property	A boolean indicating whether or not this display has been initialized.
EntityDisplayBase::$mode		protected	property	View or form mode to be displayed.
EntityDisplayBase::$originalMode		protected	property	The original view or form mode that was requested.
EntityDisplayBase::$pluginManager		protected	property	The plugin manager used by this entity type.
EntityDisplayBase::$plugins		protected	property	The plugin objects used for this display, keyed by field name.
EntityDisplayBase::$renderer		protected	property	The renderer.
EntityDisplayBase::$status		protected	property	Whether this display is enabled or not.		Overrides ConfigEntityBase::$status
EntityDisplayBase::$targetEntityType		protected	property	Entity type to be displayed.
EntityDisplayBase::CUSTOM_MODE			constant	The mode used to render entities with arbitrary display options.
EntityDisplayBase::fieldHasDisplayOptions		private	function	Determines if a field has options for a given display.
EntityDisplayBase::getComponents		public	function			Overrides EntityDisplayInterface::getComponents
EntityDisplayBase::getFieldDefinition		protected	function	Gets the field definition of a field.
EntityDisplayBase::getFieldDefinitions		protected	function	Gets the definitions of the fields that are candidate for display.
EntityDisplayBase::getHighestWeight		public	function			Overrides EntityDisplayInterface::getHighestWeight
EntityDisplayBase::getLogger		protected	function	Provides the 'system' channel logger service.
EntityDisplayBase::getMode		public	function			Overrides EntityDisplayInterface::getMode
EntityDisplayBase::getOriginalMode		public	function			Overrides EntityDisplayInterface::getOriginalMode
EntityDisplayBase::getPluginRemovedDependencies		protected	function	Returns the plugin dependencies being removed.
EntityDisplayBase::getTargetBundle		public	function			Overrides EntityDisplayInterface::getTargetBundle
EntityDisplayBase::getTargetEntityTypeId		public	function			Overrides EntityDisplayInterface::getTargetEntityTypeId
EntityDisplayBase::id		public	function			Overrides EntityBase::id
EntityDisplayBase::init		protected	function	Initializes the display.
EntityDisplayBase::removeComponent		public	function	#[ActionMethod(adminLabel: new TranslatableMarkup('Hide component'), name: 'hideComponent')]		Overrides EntityDisplayInterface::removeComponent
EntityDisplayBase::set		public	function			Overrides ConfigEntityBase::set
EntityDisplayBase::setTargetBundle		public	function			Overrides EntityDisplayInterface::setTargetBundle
EntityDisplayBase::toArray		public	function			Overrides ConfigEntityBase::toArray
EntityDisplayBase::__sleep		public	function			Overrides ConfigEntityBase::__sleep
EntityDisplayBase::__wakeup		public	function			Overrides DependencySerializationTrait::__wakeup
EntityViewDisplay::$displayContext		protected	property			Overrides EntityDisplayBase::$displayContext
EntityViewDisplay::build		public	function			Overrides EntityViewDisplayInterface::build
EntityViewDisplay::collectRenderDisplay		public static	function	Returns the display object used to render an entity.
EntityViewDisplay::collectRenderDisplays		public static	function	Returns the display objects used to render a set of entities.
EntityViewDisplay::getPluginCollections		public	function			Overrides ObjectWithPluginCollectionInterface::getPluginCollections
EntityViewDisplay::getRenderer		public	function			Overrides EntityDisplayInterface::getRenderer
EntityViewDisplay::postSave		public	function			Overrides EntityBase::postSave
LayoutBuilderEntityViewDisplay::$entityFieldManager		protected	property	The entity field manager.
LayoutBuilderEntityViewDisplay::addSectionField		protected	function	Adds a layout section field to a given bundle.
LayoutBuilderEntityViewDisplay::buildMultiple		public	function			Overrides EntityViewDisplay::buildMultiple
LayoutBuilderEntityViewDisplay::buildSections		protected	function	Builds the render array for the sections of a given entity.
LayoutBuilderEntityViewDisplay::calculateDependencies		public	function			Overrides EntityDisplayBase::calculateDependencies
LayoutBuilderEntityViewDisplay::contextRepository		protected	function	Wraps the context repository service.
LayoutBuilderEntityViewDisplay::createCopy		public	function			Overrides EntityDisplayBase::createCopy
LayoutBuilderEntityViewDisplay::disableLayoutBuilder		public	function	#[ActionMethod(adminLabel: new TranslatableMarkup('Disable Layout Builder'), pluralize: FALSE)]		Overrides LayoutBuilderEnabledInterface::disableLayoutBuilder
LayoutBuilderEntityViewDisplay::enableLayoutBuilder		public	function	#[ActionMethod(adminLabel: new TranslatableMarkup('Enable Layout Builder'), pluralize: FALSE)]		Overrides LayoutBuilderEnabledInterface::enableLayoutBuilder
LayoutBuilderEntityViewDisplay::getComponent		public	function			Overrides EntityDisplayBase::getComponent
LayoutBuilderEntityViewDisplay::getContextsForEntity		protected	function	Gets the available contexts for a given entity.
LayoutBuilderEntityViewDisplay::getDefaultRegion		protected	function			Overrides EntityDisplayBase::getDefaultRegion
LayoutBuilderEntityViewDisplay::getDefaultSection		protected	function	Gets a default section.
LayoutBuilderEntityViewDisplay::getSectionComponentForFieldName		private	function	Gets the component for a given field name if any.
LayoutBuilderEntityViewDisplay::getSections		public	function			Overrides SectionListInterface::getSections
LayoutBuilderEntityViewDisplay::isCustomMode		protected	function	Indicates if this display is using the '_custom' view mode.
LayoutBuilderEntityViewDisplay::isLayoutBuilderEnabled		public	function			Overrides LayoutBuilderEnabledInterface::isLayoutBuilderEnabled
LayoutBuilderEntityViewDisplay::isOverridable		public	function			Overrides LayoutBuilderOverridableInterface::isOverridable
LayoutBuilderEntityViewDisplay::label		public	function	@todo Move this upstream in https://www.drupal.org/node/2939931.		Overrides EntityBase::label
LayoutBuilderEntityViewDisplay::onDependencyRemoval		public	function			Overrides EntityDisplayBase::onDependencyRemoval
LayoutBuilderEntityViewDisplay::preSave		public	function			Overrides EntityDisplayBase::preSave
LayoutBuilderEntityViewDisplay::removeSectionField		protected	function	Removes a layout section field if it is no longer needed.
LayoutBuilderEntityViewDisplay::save		public	function			Overrides ConfigEntityBase::save
LayoutBuilderEntityViewDisplay::sectionStorageManager		private	function	Gets the section storage manager.		Overrides LayoutEntityHelperTrait::sectionStorageManager
LayoutBuilderEntityViewDisplay::setComponent		public	function			Overrides EntityDisplayBase::setComponent
LayoutBuilderEntityViewDisplay::setOverridable		public	function	#[ActionMethod(adminLabel: new TranslatableMarkup('Toggle overridable layouts'), pluralize: FALSE, name: 'allowLayoutOverrides')]		Overrides LayoutBuilderOverridableInterface::setOverridable
LayoutBuilderEntityViewDisplay::setSections		protected	function			Overrides SectionListTrait::setSections
LayoutBuilderEntityViewDisplay::__construct		public	function			Overrides EntityViewDisplay::__construct
LayoutEntityHelperTrait::$sectionStorageManager		protected	property	The section storage manager.			1
LayoutEntityHelperTrait::getEntitySections		protected	function	Gets the sections for an entity if any.
LayoutEntityHelperTrait::getInlineBlockComponents		protected	function	Gets components that have Inline Block plugins.
LayoutEntityHelperTrait::getInlineBlockRevisionIdsInSections		protected	function	Gets revision IDs for layout sections.
LayoutEntityHelperTrait::getOverridesSectionStorageForEntity		public	function	Gets the overrides section storage for an entity.
LayoutEntityHelperTrait::getSectionStorageContextsForEntity		public	function	Gets the section storage contexts for an entity.
LayoutEntityHelperTrait::getSectionStorageForEntity		protected	function	Gets the section storage for an entity.
LayoutEntityHelperTrait::isLayoutCompatibleEntity		protected	function	Determines if an entity can have a layout.
LayoutEntityHelperTrait::originalEntityUsesDefaultStorage		protected	function	Determines if the original entity used the default section storage.
PluginDependencyTrait::calculatePluginDependencies		protected	function	Calculates and adds dependencies of a specific plugin instance.			1
PluginDependencyTrait::getPluginDependencies		protected	function	Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler		protected	function	Wraps the module handler.			1
PluginDependencyTrait::themeHandler		protected	function	Wraps the theme handler.			1
RefinableCacheableDependencyTrait::addCacheableDependency		public	function				1
RefinableCacheableDependencyTrait::addCacheContexts		public	function
RefinableCacheableDependencyTrait::addCacheTags		public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge		public	function
SectionListTrait::addBlankSection		protected	function	Adds a blank section to the list.
SectionListTrait::appendSection		public	function
SectionListTrait::count		public	function
SectionListTrait::getSection		public	function
SectionListTrait::hasBlankSection		protected	function	Indicates if this section list contains a blank section.
SectionListTrait::hasSection		protected	function	Indicates if there is a section at the specified delta.
SectionListTrait::insertSection		public	function
SectionListTrait::removeAllSections		public	function
SectionListTrait::removeSection		public	function
SectionListTrait::setSection		public	function	Sets the section for the given delta on the display.
SectionListTrait::__clone		public	function	Magic method: Implements a deep clone.
StringTranslationTrait::$stringTranslation		protected	property	The string translation service.			3
StringTranslationTrait::formatPlural		protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals		protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation		protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation		public	function	Sets the string translation service to use.			2
StringTranslationTrait::t		protected	function	Translates a string to the current language or to a given language.			1
SynchronizableEntityTrait::$isSyncing		protected	property	Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing		public	function
SynchronizableEntityTrait::setSyncing		public	function

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

class LayoutBuilderEntityViewDisplay

Hierarchy

File

Namespace

Members

Search drupal main

API Navigation

Breadcrumb

class LayoutBuilderEntityViewDisplay

Hierarchy

File

Namespace

Members

Search drupal main

API Navigation