SectionStorageBase
abstract class SectionStorageBase extends PluginBase implements SectionStorageInterface, TempStoreIdentifierInterface, CacheableDependencyInterface (View source)
Provides a base class for Section Storage types.
Traits
Provides a trait to add context-aware functionality to plugins.
Provides a trait for building routes for a Layout Builder UI.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides dependency injection friendly methods for serialization.
Provides a trait for the messenger service.
Constants
| DERIVATIVE_SEPARATOR |
A string which is used to separate base plugin IDs from the derivative ID. |
Properties
| protected string | $pluginId | The plugin_id. |
from PluginBase |
| protected array | $pluginDefinition | The plugin implementation definition. |
from PluginBase |
| protected array | $configuration | Configuration information passed into the plugin. |
from PluginBase |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected array | $_serviceIds | An array of service IDs keyed by property name used for serialization. |
from DependencySerializationTrait |
| protected array | $_entityStorages | An array of entity type IDs keyed by the property name of their storages. |
from DependencySerializationTrait |
| protected MessengerInterface | $messenger | The messenger. |
from MessengerTrait |
| protected ContextInterface[] | $context | The data objects representing the context of this plugin. |
from ContextAwarePluginTrait |
| protected bool internal | $initializedContextConfig | Tracks whether the context has been initialized from configuration. |
from ContextAwarePluginTrait |
Methods
Constructs a \Drupal\Component\Plugin\PluginBase object.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Builds the layout routes for the given values.
Gets the section list.
Returns the type of this storage.
{@inheritdoc}
Gets the layout sections.
Gets a domain object for the layout section.
Removes the section at the given delta.
Removes all of the sections.
Gets contexts for use during preview.
Gets a string suitable for use as a tempstore key.
Details
__construct(array $configuration, string $plugin_id, mixed $plugin_definition)
Constructs a \Drupal\Component\Plugin\PluginBase object.
string
getPluginId()
Gets the plugin_id of the plugin instance.
string
getBaseId()
Gets the base_plugin_id of the plugin instance.
string|null
getDerivativeId()
Gets the derivative_id of the plugin instance.
abstract protected
getPluginDefinition()
{@inheritdoc}
bool
isConfigurable()
Determines if the plugin is configurable.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
__sleep()
{@inheritdoc}
__wakeup()
{@inheritdoc}
setMessenger(MessengerInterface $messenger)
Sets the messenger.
MessengerInterface
messenger()
Gets the messenger.
getContexts()
{@inheritdoc}
ContextInterface
getContext($name)
{@inheritdoc}
setContext($name, ContextInterface $context)
{@inheritdoc}
getContextValues()
{@inheritdoc}
getContextValue($name)
{@inheritdoc}
setContextValue($name, $value)
{@inheritdoc}
getContextMapping()
{@inheritdoc}
setContextMapping(array $context_mapping)
{@inheritdoc}
ContextDefinitionInterface[]
getContextDefinitions()
{@inheritdoc}
ContextDefinitionInterface
getContextDefinition($name)
{@inheritdoc}
validateContexts()
{@inheritdoc}
getCacheContexts()
{@inheritdoc}
getCacheTags()
{@inheritdoc}
getCacheMaxAge()
{@inheritdoc}
protected
buildLayoutRoutes(RouteCollection $collection, SectionStorageDefinition $definition, string $path, array $defaults = [], array $requirements = [], array $options = [], string $route_name_prefix = '', string $entity_type_id = '')
Builds the layout routes for the given values.
abstract protected SectionListInterface
getSectionList()
Gets the section list.
string
getStorageType()
Returns the type of this storage.
Used in conjunction with the storage ID.
count()
{@inheritdoc}
Section[]
getSections()
Gets the layout sections.
Section
getSection(int $delta)
Gets a domain object for the layout section.
$this
appendSection(Section $section)
Appends a new section to the end of the list.
$this
insertSection(int $delta, Section $section)
Inserts a new section at a given delta.
If a section exists at the given index, the section at that position and others after it are shifted backward.
$this
removeSection(int $delta)
Removes the section at the given delta.
As sections are stored sequentially and numerically this will re-key every subsequent section, shifting them forward.
$this
removeAllSections(bool $set_blank = FALSE)
Removes all of the sections.
ContextInterface[]
getContextsDuringPreview()
Gets contexts for use during preview.
When not in preview, ::getContexts() will be used.
string
getTempstoreKey()
Gets a string suitable for use as a tempstore key.