interface EntityDisplayWithLayoutInterface
Same name in other branches
- 9 core/modules/field_layout/src/Display/EntityDisplayWithLayoutInterface.php \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface
- 8.9.x core/modules/field_layout/src/Display/EntityDisplayWithLayoutInterface.php \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface
- 11.x core/modules/field_layout/src/Display/EntityDisplayWithLayoutInterface.php \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface
Provides a common interface for entity displays that have layout.
Hierarchy
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface extends \Drupal\Core\Entity\EntityInterface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface \Drupal\Core\Entity\SynchronizableInterface; interface \Drupal\Core\Entity\EntityWithPluginCollectionInterface extends \Drupal\Core\Entity\EntityInterface \Drupal\Core\Plugin\ObjectWithPluginCollectionInterface
- interface \Drupal\Core\Entity\Display\EntityDisplayInterface extends \Drupal\Core\Config\Entity\ConfigEntityInterface \Drupal\Core\Entity\EntityWithPluginCollectionInterface
- interface \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface extends \Drupal\Core\Entity\Display\EntityDisplayInterface
- interface \Drupal\Core\Entity\Display\EntityDisplayInterface extends \Drupal\Core\Config\Entity\ConfigEntityInterface \Drupal\Core\Entity\EntityWithPluginCollectionInterface
Expanded class hierarchy of EntityDisplayWithLayoutInterface
All classes that implement EntityDisplayWithLayoutInterface
7 files declare their use of EntityDisplayWithLayoutInterface
- FieldLayoutBuilder.php in core/
modules/ field_layout/ src/ FieldLayoutBuilder.php - FieldLayoutBuilderTest.php in core/
modules/ field_layout/ tests/ src/ Unit/ FieldLayoutBuilderTest.php - FieldLayoutEntityDisplayFormTrait.php in core/
modules/ field_layout/ src/ Form/ FieldLayoutEntityDisplayFormTrait.php - FieldLayoutEntityFormDisplay.php in core/
modules/ field_layout/ src/ Entity/ FieldLayoutEntityFormDisplay.php - FieldLayoutEntityViewDisplay.php in core/
modules/ field_layout/ src/ Entity/ FieldLayoutEntityViewDisplay.php
File
-
core/
modules/ field_layout/ src/ Display/ EntityDisplayWithLayoutInterface.php, line 11
Namespace
Drupal\field_layout\DisplayView source
interface EntityDisplayWithLayoutInterface extends EntityDisplayInterface {
/**
* Gets the default region.
*
* @return string
* The default region for this display.
*/
public function getDefaultRegion();
/**
* Gets the layout plugin ID for this display.
*
* @return string
* The layout plugin ID.
*/
public function getLayoutId();
/**
* Gets the layout plugin settings for this display.
*
* @return mixed[]
* The layout plugin settings.
*/
public function getLayoutSettings();
/**
* Sets the layout plugin ID for this display.
*
* @param string|null $layout_id
* Either a valid layout plugin ID, or NULL to remove the layout setting.
* @param array $layout_settings
* (optional) An array of settings for this layout.
*
* @return $this
*/
public function setLayoutId($layout_id, array $layout_settings = []);
/**
* Sets the layout plugin for this display.
*
* @param \Drupal\Core\Layout\LayoutInterface $layout
* A layout plugin.
*
* @return $this
*/
public function setLayout(LayoutInterface $layout);
/**
* Gets the layout plugin for this display.
*
* @return \Drupal\Core\Layout\LayoutInterface
* The layout plugin.
*/
public function getLayout();
/**
* Ensures this entity has a layout.
*
* @param string $default_layout_id
* (optional) The layout ID to use as a default. Defaults to
* 'layout_onecol'.
*
* @return $this
*/
public function ensureLayout($default_layout_id = 'layout_onecol');
}
Members
Title Sort descending | 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). | 3 |
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 |
EntityDisplayWithLayoutInterface::ensureLayout | public | function | Ensures this entity has a layout. | |
EntityDisplayWithLayoutInterface::getDefaultRegion | public | function | Gets the default region. | |
EntityDisplayWithLayoutInterface::getLayout | public | function | Gets the layout plugin for this display. | |
EntityDisplayWithLayoutInterface::getLayoutId | public | function | Gets the layout plugin ID for this display. | |
EntityDisplayWithLayoutInterface::getLayoutSettings | public | function | Gets the layout plugin settings for this display. | |
EntityDisplayWithLayoutInterface::setLayout | public | function | Sets the layout plugin for this display. | |
EntityDisplayWithLayoutInterface::setLayoutId | public | function | Sets the layout plugin ID for this display. | |
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::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::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. | 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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.