class SectionStorageBase
Same name in other branches
- 8.9.x core/modules/layout_builder/src/Plugin/SectionStorage/SectionStorageBase.php \Drupal\layout_builder\Plugin\SectionStorage\SectionStorageBase
- 10 core/modules/layout_builder/src/Plugin/SectionStorage/SectionStorageBase.php \Drupal\layout_builder\Plugin\SectionStorage\SectionStorageBase
- 11.x core/modules/layout_builder/src/Plugin/SectionStorage/SectionStorageBase.php \Drupal\layout_builder\Plugin\SectionStorage\SectionStorageBase
Provides a base class for Section Storage types.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\layout_builder\Plugin\SectionStorage\SectionStorageBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\layout_builder\SectionStorageInterface, \Drupal\layout_builder\TempStoreIdentifierInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\layout_builder\Routing\LayoutBuilderRoutesTrait
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of SectionStorageBase
1 file declares its use of SectionStorageBase
- TestStateBasedSectionStorage.php in core/
modules/ layout_builder/ tests/ modules/ layout_builder_test/ src/ Plugin/ SectionStorage/ TestStateBasedSectionStorage.php
File
-
core/
modules/ layout_builder/ src/ Plugin/ SectionStorage/ SectionStorageBase.php, line 18
Namespace
Drupal\layout_builder\Plugin\SectionStorageView source
abstract class SectionStorageBase extends PluginBase implements SectionStorageInterface, TempStoreIdentifierInterface, CacheableDependencyInterface {
use ContextAwarePluginTrait;
use LayoutBuilderRoutesTrait;
/**
* Gets the section list.
*
* @return \Drupal\layout_builder\SectionListInterface
* The section list.
*/
protected abstract function getSectionList();
/**
* {@inheritdoc}
*/
public function getStorageType() {
return $this->getPluginId();
}
/**
* {@inheritdoc}
*/
public function count() {
return $this->getSectionList()
->count();
}
/**
* {@inheritdoc}
*/
public function getSections() {
return $this->getSectionList()
->getSections();
}
/**
* {@inheritdoc}
*/
public function getSection($delta) {
return $this->getSectionList()
->getSection($delta);
}
/**
* {@inheritdoc}
*/
public function appendSection(Section $section) {
$this->getSectionList()
->appendSection($section);
return $this;
}
/**
* {@inheritdoc}
*/
public function insertSection($delta, Section $section) {
$this->getSectionList()
->insertSection($delta, $section);
return $this;
}
/**
* {@inheritdoc}
*/
public function removeSection($delta) {
$this->getSectionList()
->removeSection($delta);
return $this;
}
/**
* {@inheritdoc}
*/
public function removeAllSections($set_blank = FALSE) {
$this->getSectionList()
->removeAllSections($set_blank);
return $this;
}
/**
* {@inheritdoc}
*/
public function getContextsDuringPreview() {
$contexts = $this->getContexts();
// view_mode is a required context, but SectionStorage plugins are not
// required to return it (for example, the layout_library plugin provided
// in the Layout Library module. In these instances, explicitly create a
// view_mode context with the value "default".
if (!isset($contexts['view_mode']) || $contexts['view_mode']->validate()
->count() || !$contexts['view_mode']->getContextValue()) {
$contexts['view_mode'] = new Context(new ContextDefinition('string'), 'default');
}
return $contexts;
}
/**
* {@inheritdoc}
*/
public function getTempstoreKey() {
return $this->getStorageId();
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
ContextAwarePluginTrait::$context | protected | property | The data objects representing the context of this plugin. | ||
ContextAwarePluginTrait::$initializedContextConfig | protected | property | Tracks whether the context has been initialized from configuration. | ||
ContextAwarePluginTrait::getCacheContexts | public | function | 9 | ||
ContextAwarePluginTrait::getCacheMaxAge | public | function | 7 | ||
ContextAwarePluginTrait::getCacheTags | public | function | 4 | ||
ContextAwarePluginTrait::getContext | public | function | |||
ContextAwarePluginTrait::getContextDefinition | public | function | |||
ContextAwarePluginTrait::getContextDefinitions | public | function | |||
ContextAwarePluginTrait::getContextMapping | public | function | |||
ContextAwarePluginTrait::getContexts | public | function | |||
ContextAwarePluginTrait::getContextValue | public | function | |||
ContextAwarePluginTrait::getContextValues | public | function | |||
ContextAwarePluginTrait::getPluginDefinition | abstract public | function | 1 | ||
ContextAwarePluginTrait::setContext | public | function | 1 | ||
ContextAwarePluginTrait::setContextMapping | public | function | |||
ContextAwarePluginTrait::setContextValue | public | function | |||
ContextAwarePluginTrait::validateContexts | public | function | |||
LayoutBuilderRoutesTrait::buildLayoutRoutes | protected | function | Builds the layout routes for the given values. | ||
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 | |
SectionStorageBase::appendSection | public | function | Appends a new section to the end of the list. | Overrides SectionListInterface::appendSection | |
SectionStorageBase::count | public | function | |||
SectionStorageBase::getContextsDuringPreview | public | function | Gets contexts for use during preview. | Overrides SectionStorageInterface::getContextsDuringPreview | 2 |
SectionStorageBase::getSection | public | function | Gets a domain object for the layout section. | Overrides SectionListInterface::getSection | |
SectionStorageBase::getSectionList | abstract protected | function | Gets the section list. | 3 | |
SectionStorageBase::getSections | public | function | Gets the layout sections. | Overrides SectionListInterface::getSections | 1 |
SectionStorageBase::getStorageType | public | function | Returns the type of this storage. | Overrides SectionStorageInterface::getStorageType | |
SectionStorageBase::getTempstoreKey | public | function | Gets a string suitable for use as a tempstore key. | Overrides TempStoreIdentifierInterface::getTempstoreKey | 1 |
SectionStorageBase::insertSection | public | function | Inserts a new section at a given delta. | Overrides SectionListInterface::insertSection | |
SectionStorageBase::removeAllSections | public | function | Removes all of the sections. | Overrides SectionListInterface::removeAllSections | |
SectionStorageBase::removeSection | public | function | Removes the section at the given delta. | Overrides SectionListInterface::removeSection | |
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::getLayoutBuilderUrl | public | function | Gets the URL used to display the Layout Builder UI. | 4 | |
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::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.