interface DefaultsSectionStorageInterface

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

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

@todo Refactor this interface in https://www.drupal.org/node/2985362.

Hierarchy

  • interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\layout_builder\LayoutBuilderEnabledInterface; interface \Drupal\layout_builder\SectionStorageInterface extends \Drupal\layout_builder\SectionListInterface \Drupal\Component\Plugin\PluginInspectionInterface \Drupal\Core\Plugin\ContextAwarePluginInterface \Drupal\Core\Access\AccessibleInterface
    • interface \Drupal\layout_builder\DefaultsSectionStorageInterface extends \Drupal\layout_builder\SectionStorageInterface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface \Drupal\layout_builder\LayoutBuilderEnabledInterface

Expanded class hierarchy of DefaultsSectionStorageInterface

All classes that implement DefaultsSectionStorageInterface

5 files declare their use of DefaultsSectionStorageInterface
DefaultsSectionStorage.php in core/modules/layout_builder/src/Plugin/SectionStorage/DefaultsSectionStorage.php
LayoutBuilderDisableForm.php in core/modules/layout_builder/src/Form/LayoutBuilderDisableForm.php
LayoutBuilderRoutesTrait.php in core/modules/layout_builder/src/Routing/LayoutBuilderRoutesTrait.php
LayoutEntityHelperTraitTest.php in core/modules/layout_builder/tests/src/Kernel/LayoutEntityHelperTraitTest.php
OverridesSectionStorageTest.php in core/modules/layout_builder/tests/src/Kernel/OverridesSectionStorageTest.php

File

core/modules/layout_builder/src/DefaultsSectionStorageInterface.php, line 12

Namespace

Drupal\layout_builder
View source
interface DefaultsSectionStorageInterface extends SectionStorageInterface, ThirdPartySettingsInterface, LayoutBuilderEnabledInterface {
    
    /**
     * Determines if the defaults allow custom overrides.
     *
     * @return bool
     *   TRUE if custom overrides are allowed, FALSE otherwise.
     */
    public function isOverridable();
    
    /**
     * Sets the defaults to allow or disallow overrides.
     *
     * @param bool $overridable
     *   TRUE if the display should allow overrides, FALSE otherwise.
     *
     * @return $this
     */
    public function setOverridable($overridable = TRUE);

}

Members

Title Sort descending 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
DefaultsSectionStorageInterface::isOverridable public function Determines if the defaults allow custom overrides. 1
DefaultsSectionStorageInterface::setOverridable public function Sets the defaults to allow or disallow overrides. 1
LayoutBuilderEnabledInterface::disableLayoutBuilder public function Disables the Layout Builder. 2
LayoutBuilderEnabledInterface::enableLayoutBuilder public function Enables the Layout Builder. 2
LayoutBuilderEnabledInterface::isLayoutBuilderEnabled public function Determines if Layout Builder is enabled. 2
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
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5

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