interface SupportAwareSectionStorageInterface

Interface for section storage that knows whether it supports a view mode.

Hierarchy

Expanded class hierarchy of SupportAwareSectionStorageInterface

All classes that implement SupportAwareSectionStorageInterface

1 file declares its use of SupportAwareSectionStorageInterface
SectionStorageManager.php in core/modules/layout_builder/src/SectionStorage/SectionStorageManager.php

File

View on git.drupalcode.org

core/modules/layout_builder/src/SupportAwareSectionStorageInterface.php, line 10

Namespace

Drupal\layout_builder
View source 
interface SupportAwareSectionStorageInterface extends SectionStorageInterface {
  
  /**
   * Determines if layout builder is supported by a view mode.
   *
   * @param string $entity_type_id
   *   The entity type id.
   * @param string $bundle
   *   The bundle.
   * @param string $view_mode
   *   The view mode.
   *
   * @return bool
   *   TRUE if it is supported, otherwise FALSE.
   */
  public function isSupported(string $entity_type_id, string $bundle, string $view_mode) : bool;

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ContextAwarePluginInterface::getContext public function Gets a defined context.
ContextAwarePluginInterface::getContextDefinition public function Gets a specific context definition of the plugin. Overrides ContextAwarePluginInterface::getContextDefinition
ContextAwarePluginInterface::getContextDefinitions public function Gets the context definitions of the plugin. Overrides ContextAwarePluginInterface::getContextDefinitions
ContextAwarePluginInterface::getContextMapping public function Gets a mapping of the expected assignment names to their context names.
ContextAwarePluginInterface::getContexts public function Gets the defined contexts.
ContextAwarePluginInterface::getContextValue public function Gets the value for a defined context.
ContextAwarePluginInterface::getContextValues public function Gets the values for all defined contexts.
ContextAwarePluginInterface::setContext public function Set a context on this plugin. 1
ContextAwarePluginInterface::setContextMapping public function Sets a mapping of the expected assignment names to their context names.
ContextAwarePluginInterface::setContextValue public function Sets the value for a defined context.
ContextAwarePluginInterface::validateContexts public function Validates the set values for the defined contexts.
PluginInspectionInterface::getPluginId public function Gets the plugin ID of the plugin instance. 3
SectionListInterface::appendSection public function Appends a new section to the end of the list. 1
SectionListInterface::getSection public function Gets a domain object for the layout section. 1
SectionListInterface::getSections public function Gets the layout sections. 6
SectionListInterface::insertSection public function Inserts a new section at a given delta. 1
SectionListInterface::removeAllSections public function Removes all of the sections. 1
SectionListInterface::removeSection public function Removes the section at the given delta. 1
SectionStorageInterface::access public function Overrides \Drupal\Core\Access\AccessibleInterface::access(). Overrides AccessibleInterface::access 5
SectionStorageInterface::buildRoutes public function Provides the routes needed for Layout Builder UI. 5
SectionStorageInterface::deriveContextsFromRoute public function Derives the available plugin contexts from route values. 5
SectionStorageInterface::getContextsDuringPreview public function Gets contexts for use during preview. 3
SectionStorageInterface::getLayoutBuilderUrl public function Gets the URL used to display the Layout Builder UI. 5
SectionStorageInterface::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition
SectionStorageInterface::getRedirectUrl public function Gets the URL used when redirecting away from the Layout Builder UI. 5
SectionStorageInterface::getStorageId public function Returns an identifier for this storage. 5
SectionStorageInterface::getStorageType public function Returns the type of this storage. 3
SectionStorageInterface::isApplicable public function Determines if this section storage is applicable for the current contexts. 5
SectionStorageInterface::label public function Gets the label for the object using the sections. 5
SectionStorageInterface::save public function Saves the sections. 5
SupportAwareSectionStorageInterface::isSupported public function Determines if layout builder is supported by a view mode. 2

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