interface OverridesSectionStorageInterface

Same name and namespace in other branches
  1. 8.9.x core/modules/layout_builder/src/OverridesSectionStorageInterface.php \Drupal\layout_builder\OverridesSectionStorageInterface
  2. 10 core/modules/layout_builder/src/OverridesSectionStorageInterface.php \Drupal\layout_builder\OverridesSectionStorageInterface
  3. 11.x core/modules/layout_builder/src/OverridesSectionStorageInterface.php \Drupal\layout_builder\OverridesSectionStorageInterface

Defines an interface for an object that stores layout sections for overrides.

Hierarchy

Expanded class hierarchy of OverridesSectionStorageInterface

All classes that implement OverridesSectionStorageInterface

6 files declare their use of OverridesSectionStorageInterface
LayoutBuilderRoutesTrait.php in core/modules/layout_builder/src/Routing/LayoutBuilderRoutesTrait.php
LayoutEntityHelperTraitTest.php in core/modules/layout_builder/tests/src/Kernel/LayoutEntityHelperTraitTest.php
OverridesEntityForm.php in core/modules/layout_builder/src/Form/OverridesEntityForm.php
OverridesSectionStorage.php in core/modules/layout_builder/src/Plugin/SectionStorage/OverridesSectionStorage.php
PrepareLayout.php in core/modules/layout_builder/src/EventSubscriber/PrepareLayout.php

... See full list

File

core/modules/layout_builder/src/OverridesSectionStorageInterface.php, line 8

Namespace

Drupal\layout_builder
View on git.drupalcode.org
View source 
interface OverridesSectionStorageInterface extends SectionStorageInterface {
    
    /**
     * Returns the corresponding defaults section storage for this override.
     *
     * @return \Drupal\layout_builder\DefaultsSectionStorageInterface
     *   The defaults section storage.
     *
     * @todo Determine if this method needs a parameter in
     *   https://www.drupal.org/project/drupal/issues/2907413.
     */
    public function getDefaultSectionStorage();
    
    /**
     * Indicates if overrides are in use.
     *
     * @return bool
     *   TRUE if this overrides section storage is in use, otherwise FALSE.
     */
    public function isOverridden();

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
ContextAwarePluginInterface::getContext public function Gets a defined context. 1
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. 1
ContextAwarePluginInterface::getContextValue public function Gets the value for a defined context. 1
ContextAwarePluginInterface::getContextValues public function Gets the values for all defined contexts. 1
ContextAwarePluginInterface::setContext public function Set a context on this plugin. 2
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. 1
ContextAwarePluginInterface::validateContexts public function Validates the set values for the defined contexts. 1
OverridesSectionStorageInterface::getDefaultSectionStorage public function Returns the corresponding defaults section storage for this override. 1
OverridesSectionStorageInterface::isOverridden public function Indicates if overrides are in use. 1
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
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. 5
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 4
SectionStorageInterface::buildRoutes public function Provides the routes needed for Layout Builder UI. 4
SectionStorageInterface::deriveContextsFromRoute public function Derives the available plugin contexts from route values. 4
SectionStorageInterface::getContextsDuringPreview public function Gets contexts for use during preview. 2
SectionStorageInterface::getLayoutBuilderUrl public function Gets the URL used to display the Layout Builder UI. 4
SectionStorageInterface::getPluginDefinition public function Overrides \Drupal\Component\Plugin\PluginInspectionInterface::getPluginDefinition(). Overrides PluginInspectionInterface::getPluginDefinition
SectionStorageInterface::getRedirectUrl public function Gets the URL used when redirecting away from the Layout Builder UI. 4
SectionStorageInterface::getStorageId public function Returns an identifier for this storage. 4
SectionStorageInterface::getStorageType public function Returns the type of this storage. 2
SectionStorageInterface::isApplicable public function Determines if this section storage is applicable for the current contexts. 4
SectionStorageInterface::label public function Gets the label for the object using the sections. 4
SectionStorageInterface::save public function Saves the sections. 4

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