class SectionStorageBase
Same name in other branches
- 9 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\Component\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\ContextAwarePluginInterface
- class \Drupal\Core\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\ContextAwarePluginBase implements \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\layout_builder\Plugin\SectionStorage\SectionStorageBase extends \Drupal\Core\Plugin\ContextAwarePluginBase implements \Drupal\layout_builder\SectionStorageInterface, \Drupal\layout_builder\TempStoreIdentifierInterface uses \Drupal\layout_builder\Routing\LayoutBuilderRoutesTrait
- class \Drupal\Core\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\ContextAwarePluginBase implements \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Component\Plugin\ContextAwarePluginBase extends \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\ContextAwarePluginInterface
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 17
Namespace
Drupal\layout_builder\Plugin\SectionStorageView source
abstract class SectionStorageBase extends ContextAwarePluginBase implements SectionStorageInterface, TempStoreIdentifierInterface {
use LayoutBuilderRoutesTrait;
/**
* Sets the section list on the storage.
*
* @param \Drupal\layout_builder\SectionListInterface $section_list
* The section list.
*
* @internal
* As of Drupal 8.7.0, this method should no longer be used. It previously
* should only have been used during storage instantiation.
*
* @throws \Exception
*
* @deprecated in drupal:8.7.0 and is removed from drupal:9.0.0. This
* method should no longer be used. The section list should be derived from
* context. See https://www.drupal.org/node/3016262.
*/
public function setSectionList(SectionListInterface $section_list) {
@trigger_error('\\Drupal\\layout_builder\\SectionStorageInterface::setSectionList() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. This method should no longer be used. The section list should be derived from context. See https://www.drupal.org/node/3016262.', E_USER_DEPRECATED);
throw new \Exception('\\Drupal\\layout_builder\\SectionStorageInterface::setSectionList() must no longer be called. The section list should be derived from context. See https://www.drupal.org/node/3016262.');
}
/**
* 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 | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
ContextAwarePluginBase::$context | protected | property | The data objects representing the context of this plugin. | |||
ContextAwarePluginBase::$contexts | Deprecated | private | property | Data objects representing the contexts passed in the plugin configuration. | ||
ContextAwarePluginBase::contextHandler | protected | function | Wraps the context handler. | |||
ContextAwarePluginBase::createContextFromConfiguration | protected | function | Overrides ContextAwarePluginBase::createContextFromConfiguration | |||
ContextAwarePluginBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | 3 | |
ContextAwarePluginBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | ||
ContextAwarePluginBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | ||
ContextAwarePluginBase::getContext | public | function | This code is identical to the Component in order to pick up a different Context class. |
Overrides ContextAwarePluginBase::getContext | ||
ContextAwarePluginBase::getContextDefinition | public | function | Overrides ContextAwarePluginBase::getContextDefinition | |||
ContextAwarePluginBase::getContextDefinitions | public | function | Overrides ContextAwarePluginBase::getContextDefinitions | |||
ContextAwarePluginBase::getContextMapping | public | function | Gets a mapping of the expected assignment names to their context names. | Overrides ContextAwarePluginInterface::getContextMapping | ||
ContextAwarePluginBase::getContexts | public | function | Gets the defined contexts. | Overrides ContextAwarePluginInterface::getContexts | ||
ContextAwarePluginBase::getContextValue | public | function | Gets the value for a defined context. | Overrides ContextAwarePluginInterface::getContextValue | ||
ContextAwarePluginBase::getContextValues | public | function | Gets the values for all defined contexts. | Overrides ContextAwarePluginInterface::getContextValues | ||
ContextAwarePluginBase::setContext | public | function | Set a context on this plugin. | Overrides ContextAwarePluginBase::setContext | 2 | |
ContextAwarePluginBase::setContextMapping | public | function | Sets a mapping of the expected assignment names to their context names. | Overrides ContextAwarePluginInterface::setContextMapping | ||
ContextAwarePluginBase::setContextValue | public | function | Sets the value for a defined context. | Overrides ContextAwarePluginBase::setContextValue | ||
ContextAwarePluginBase::validateContexts | public | function | Validates the set values for the defined contexts. | Overrides ContextAwarePluginInterface::validateContexts | ||
ContextAwarePluginBase::__construct | public | function | Overrides \Drupal\Component\Plugin\PluginBase::__construct(). | Overrides PluginBase::__construct | 4 | |
ContextAwarePluginBase::__get | public | function | Implements magic __get() method. | |||
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
DependencySerializationTrait::__sleep | public | function | 1 | |||
DependencySerializationTrait::__wakeup | public | function | 2 | |||
LayoutBuilderRoutesTrait::buildLayoutRoutes | protected | function | Builds the layout routes for the given values. | |||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | |||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | |||
PluginBase::$pluginId | protected | property | The plugin_id. | |||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | ||
PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | ||
PluginBase::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | ||
PluginBase::getPluginId | public | function | Gets the plugin_id of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | ||
PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | |||
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 | ||
SectionStorageBase::setSectionList | Deprecated | public | function | Sets the section list on the storage. | ||
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::extractIdFromRoute | Deprecated | public | function | Configures the plugin based on 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::getSectionListFromId | Deprecated | public | function | Derives the section list from the storage ID. | 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 | ||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | |||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | |||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | |||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | |||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | ||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | |||
TypedDataTrait::$typedDataManager | protected | property | The typed data manager used for creating the data types. | |||
TypedDataTrait::getTypedDataManager | public | function | Gets the typed data manager. | 2 | ||
TypedDataTrait::setTypedDataManager | public | function | Sets the typed data manager. | 2 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.