Same name and namespace in other branches
  1. 8.9.x core/modules/field_layout/src/Display/EntityDisplayWithLayoutInterface.php \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface
  2. 9 core/modules/field_layout/src/Display/EntityDisplayWithLayoutInterface.php \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface

Provides a common interface for entity displays that have layout.

Hierarchy

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

... See full list

File

core/modules/field_layout/src/Display/EntityDisplayWithLayoutInterface.php, line 11

Namespace

Drupal\field_layout\Display
View 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

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 6
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 12
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 12
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 12
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 1
ConfigEntityInterface::disable public function Disables the configuration entity. 1
ConfigEntityInterface::enable public function Enables the configuration entity. 1
ConfigEntityInterface::get public function Returns the value of a property. 1
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 1
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 1
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 1
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 1
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 1
ConfigEntityInterface::set public function Sets the value of a property. 1
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 1
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 1
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 1
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
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. 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. 2
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. 3
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. 3
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. 7
EntityInterface::postLoad public static function Acts on loaded entities. 2
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 8
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 4
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 6
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 8
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 3
EntityInterface::setOriginalId public function Sets the original ID. 1
EntityInterface::toArray public function Gets an array of all property values. 2
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
ObjectWithPluginCollectionInterface::getPluginCollections public function Gets the plugin collections used by this object. 8
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata.
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts.
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags.
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age.
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization.
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag.
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 3
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 3
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 3
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 3
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 3