class QuickEditLayoutBuilderEntityViewDisplay in Drupal 10

Provides an entity view display entity that has a layout with quickedit.

Hierarchy

class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
  - class \Drupal\Core\Entity\EntityDisplayBase implements EntityDisplayInterface
    class \Drupal\Core\Entity\Entity\EntityViewDisplay implements EntityViewDisplayInterface
    class \Drupal\layout_builder\Entity\LayoutBuilderEntityViewDisplay implements LayoutEntityDisplayInterface uses LayoutEntityHelperTrait, SectionListTrait
    class \Drupal\quickedit\Entity\QuickEditLayoutBuilderEntityViewDisplay

Expanded class hierarchy of QuickEditLayoutBuilderEntityViewDisplay

1 file declares its use of QuickEditLayoutBuilderEntityViewDisplay

quickedit.module in core/modules/quickedit/quickedit.module: Provides in-place content editing functionality for fields.

File

core/modules/quickedit/src/Entity/QuickEditLayoutBuilderEntityViewDisplay.php, line 13

Namespace

Drupal\quickedit\Entity

View source

class QuickEditLayoutBuilderEntityViewDisplay extends LayoutBuilderEntityViewDisplay {

  /**
   * {@inheritdoc}
   */
  public function getComponent($name) {
    if ($this
      ->isLayoutBuilderEnabled() && ($section_component = $this
      ->getQuickEditSectionComponent())) {
      $plugin = $section_component
        ->getPlugin();
      if ($plugin instanceof ConfigurableInterface) {
        $configuration = $plugin
          ->getConfiguration();
        if (isset($configuration['formatter'])) {
          return $configuration['formatter'];
        }
      }
    }
    return parent::getComponent($name);
  }

  /**
   * Returns the Quick Edit formatter settings.
   *
   * @return \Drupal\layout_builder\SectionComponent|null
   *   The section component if it is available.
   *
   * @see \Drupal\quickedit\LayoutBuilderIntegration::entityViewAlter()
   * @see \Drupal\quickedit\MetadataGenerator::generateFieldMetadata()
   */
  private function getQuickEditSectionComponent() {

    // To determine the Quick Edit view_mode ID we need an originalMode set.
    if ($original_mode = $this
      ->getOriginalMode()) {
      $parts = explode('-', $original_mode);

      // The Quick Edit view mode ID is created by
      // \Drupal\quickedit\LayoutBuilderIntegration::entityViewAlter()
      // concatenating together the information we need to retrieve the Layout
      // Builder component. It follows the structure prescribed by the
      // documentation of hook_quickedit_render_field().
      if (count($parts) === 6 && $parts[0] === 'layout_builder') {
        [
          ,
          $delta,
          $component_uuid,
          $entity_id,
        ] = LayoutBuilderIntegration::deconstructViewModeId($original_mode);
        $entity = $this
          ->entityTypeManager()
          ->getStorage($this
          ->getTargetEntityTypeId())
          ->load($entity_id);
        $sections = $this
          ->getEntitySections($entity);
        if (isset($sections[$delta])) {
          $component = $sections[$delta]
            ->getComponent($component_uuid);
          $plugin = $component
            ->getPlugin();

          // We only care about FieldBlock because these are only components
          // that provide Quick Edit integration: Quick Edit enables in-place
          // editing of fields of entities, not of anything else.
          if ($plugin instanceof DerivativeInspectionInterface && $plugin
            ->getBaseId() === 'field_block') {
            return $component;
          }
        }
      }
    }
    return NULL;
  }

}

Members

Name	Modifiers	Type	Description	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	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
ConfigEntityBase::addDependency	protected	function	Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides EntityBase::createDuplicate	1
ConfigEntityBase::disable	public	function	Disables the configuration entity. Overrides ConfigEntityInterface::disable	1
ConfigEntityBase::enable	public	function	Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get	public	function	Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate	public	function	Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders	public	function	Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting	public	function	Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings	public	function	Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig	protected	function	Gets the typed config manager.
ConfigEntityBase::hasTrustedData	public	function	Gets whether on not the data is trusted. 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	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	6
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides EntityBase::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting	public	function	Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling	public	function
ConfigEntityBase::sort	public static	function	Helper callback for uasort() to sort configuration entities by weight and label.	6
ConfigEntityBase::status	public	function	Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status	4
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
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::$typedData	protected	property	A typed data object wrapping this entity.
EntityBase::access	public	function		1
EntityBase::bundle	public	function		1
EntityBase::create	public static	function		1
EntityBase::delete	public	function		2
EntityBase::enforceIsNew	public	function
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function
EntityBase::getCacheMaxAge	public	function
EntityBase::getCacheTags	public	function
EntityBase::getConfigDependencyKey	public	function
EntityBase::getEntityType	public	function
EntityBase::getEntityTypeId	public	function
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function
EntityBase::getTypedDataClass	private	function	Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate	public	function
EntityBase::language	public	function		1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.
EntityBase::load	public static	function
EntityBase::loadMultiple	public static	function
EntityBase::postCreate	public	function		4
EntityBase::postDelete	public static	function		12
EntityBase::postLoad	public static	function		3
EntityBase::preCreate	public static	function		5
EntityBase::referencedEntities	public	function		1
EntityBase::toLink	public	function
EntityBase::uriRelationships	public	function
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	1
EntityBase::uuid	public	function		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::$mode	protected	property	View or form mode to be displayed.
EntityDisplayBase::$originalMode	protected	property	The original view or form mode that was requested (case of view/form modes being configured to fall back to the 'default' display).
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. If the entity (form) display is disabled, we'll fall back to the 'default' display. Overrides ConfigEntityBase::$status
EntityDisplayBase::$targetEntityType	protected	property	Entity type to be displayed.
EntityDisplayBase::CUSTOM_MODE		constant	The 'mode' for runtime EntityDisplay objects used to render entities with arbitrary display options rather than a configured view mode or form mode.
EntityDisplayBase::fieldHasDisplayOptions	private	function	Determines if a field has options for a given display.
EntityDisplayBase::getComponents	public	function	Gets the display options for all components. 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	Gets the highest weight of the components in the display. Overrides EntityDisplayInterface::getHighestWeight
EntityDisplayBase::getLogger	protected	function	Provides the 'system' channel logger service.
EntityDisplayBase::getMode	public	function	Gets the view or form mode to be displayed. Overrides EntityDisplayInterface::getMode
EntityDisplayBase::getOriginalMode	public	function	Gets the original view or form mode that was requested. Overrides EntityDisplayInterface::getOriginalMode
EntityDisplayBase::getPluginRemovedDependencies	protected	function	Returns the plugin dependencies being removed.
EntityDisplayBase::getTargetBundle	public	function	Gets the bundle to be displayed. Overrides EntityDisplayInterface::getTargetBundle
EntityDisplayBase::getTargetEntityTypeId	public	function	Gets the entity type for which this display is used. Overrides EntityDisplayInterface::getTargetEntityTypeId
EntityDisplayBase::id	public	function	Gets the identifier. Overrides EntityBase::id
EntityDisplayBase::init	protected	function	Initializes the display.
EntityDisplayBase::removeComponent	public	function	Sets a component to be hidden. Overrides EntityDisplayInterface::removeComponent
EntityDisplayBase::setTargetBundle	public	function	Sets the bundle to be displayed. Overrides EntityDisplayInterface::setTargetBundle
EntityDisplayBase::toArray	public	function	Gets an array of all property values. Overrides ConfigEntityBase::toArray
EntityDisplayBase::__sleep	public	function	Overrides ConfigEntityBase::__sleep
EntityDisplayBase::__wakeup	public	function	Overrides DependencySerializationTrait::__wakeup
EntityViewDisplay::$displayContext	protected	property	Context in which this entity will be used (e.g. 'view', 'form'). Overrides EntityDisplayBase::$displayContext
EntityViewDisplay::build	public	function	Builds a renderable array for the components of an entity. 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	Gets the plugin collections used by this object. Overrides ObjectWithPluginCollectionInterface::getPluginCollections
EntityViewDisplay::getRenderer	public	function	Gets the renderer plugin for a field (e.g. widget, formatter). Overrides EntityDisplayInterface::getRenderer
EntityViewDisplay::postSave	public	function	Acts on a saved entity before the insert or update hook is invoked. 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	Builds a renderable array for the components of a set of entities. Overrides EntityViewDisplay::buildMultiple
LayoutBuilderEntityViewDisplay::buildSections	protected	function	Builds the render array for the sections of a given entity.
LayoutBuilderEntityViewDisplay::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides EntityDisplayBase::calculateDependencies
LayoutBuilderEntityViewDisplay::contextRepository	protected	function	Wraps the context repository service.
LayoutBuilderEntityViewDisplay::createCopy	public	function	Creates a duplicate of the entity display object on a different view mode. Overrides EntityDisplayBase::createCopy
LayoutBuilderEntityViewDisplay::disableLayoutBuilder	public	function	Disables the Layout Builder. Overrides LayoutBuilderEnabledInterface::disableLayoutBuilder
LayoutBuilderEntityViewDisplay::enableLayoutBuilder	public	function	Enables the Layout Builder. Overrides LayoutBuilderEnabledInterface::enableLayoutBuilder
LayoutBuilderEntityViewDisplay::getContextsForEntity	protected	function	Gets the available contexts for a given entity.
LayoutBuilderEntityViewDisplay::getDefaultRegion	protected	function	Gets the default region. 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	Gets the layout sections. Overrides SectionListInterface::getSections
LayoutBuilderEntityViewDisplay::isCustomMode	protected	function	Indicates if this display is using the '_custom' view mode.
LayoutBuilderEntityViewDisplay::isLayoutBuilderEnabled	public	function	Determines if Layout Builder is enabled. Overrides LayoutBuilderEnabledInterface::isLayoutBuilderEnabled
LayoutBuilderEntityViewDisplay::isOverridable	public	function	Determines if the display allows custom overrides. Overrides LayoutEntityDisplayInterface::isOverridable
LayoutBuilderEntityViewDisplay::label	public	function	@todo Move this upstream in https://www.drupal.org/node/2939931. Overrides EntityBase::label
LayoutBuilderEntityViewDisplay::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides EntityDisplayBase::onDependencyRemoval
LayoutBuilderEntityViewDisplay::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides EntityDisplayBase::preSave
LayoutBuilderEntityViewDisplay::removeSectionField	protected	function	Removes a layout section field if it is no longer needed.
LayoutBuilderEntityViewDisplay::sectionStorageManager	private	function	Gets the section storage manager. Overrides LayoutEntityHelperTrait::sectionStorageManager
LayoutBuilderEntityViewDisplay::setComponent	public	function	Sets the display options for a component. Overrides EntityDisplayBase::setComponent
LayoutBuilderEntityViewDisplay::setOverridable	public	function	Sets the display to allow or disallow overrides. Overrides LayoutEntityDisplayInterface::setOverridable
LayoutBuilderEntityViewDisplay::setSections	protected	function	Stores the information for all sections. Overrides SectionListTrait::setSections
LayoutBuilderEntityViewDisplay::__construct	public	function	Constructs an Entity object. 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::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
QuickEditLayoutBuilderEntityViewDisplay::getComponent	public	function	Gets the display options set for a component. Overrides LayoutBuilderEntityViewDisplay::getComponent
QuickEditLayoutBuilderEntityViewDisplay::getQuickEditSectionComponent	private	function	Returns the Quick Edit formatter settings.
RefinableCacheableDependencyTrait::addCacheableDependency	public	function
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	protected	function	Sets the section for the given delta on the display.
SectionListTrait::__clone	public	function	Magic method: Implements a deep clone.
SynchronizableEntityTrait::$isSyncing	protected	property	Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing	public	function
SynchronizableEntityTrait::setSyncing	public	function

You are here

class QuickEditLayoutBuilderEntityViewDisplay in Drupal 10

Hierarchy

File

Namespace

Members

API Navigation