class OverridesSectionStorage extends SectionStorageBase implements ContainerFactoryPluginInterface, OverridesSectionStorageInterface, SectionStorageLocalTaskProviderInterface (View source)

internal  Plugin classes are internal.
 

Defines the 'overrides' section storage type.

OverridesSectionStorage uses a negative weight because:

  • It must be picked before \Drupal\layout_builder\Plugin\SectionStorage\DefaultsSectionStorage.
  • The default weight is 0, so custom implementations will not take precedence unless otherwise specified.

Traits

Provides a trait for building routes for a Layout Builder UI.

Wrapper methods for classes that needs typed data manager object.

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

Provides dependency injection friendly methods for serialization.

Constants

DERIVATIVE_SEPARATOR

A string which is used to separate base plugin IDs from the derivative ID.

FIELD_NAME

The field name used by this storage.

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 ContextInterface[] $context

The data objects representing the context of this plugin.

from  ContextAwarePluginBase
protected TypedDataManagerInterface $typedDataManager

The typed data manager used for creating the data types.

from  TypedDataTrait
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 EntityTypeManagerInterface $entityTypeManager

The entity type manager.

protected EntityFieldManagerInterface $entityFieldManager

The entity field manager.

protected SectionStorageManagerInterface $sectionStorageManager

The section storage manager.

protected EntityRepositoryInterface $entityRepository

The entity repository.

protected AccountInterface $currentUser

The current user.

Methods

__construct(array $configuration, string $plugin_id, mixed $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager, SectionStorageManagerInterface $section_storage_manager, EntityRepositoryInterface $entity_repository, AccountInterface $current_user = NULL)

Overrides \Drupal\Component\Plugin\PluginBase::__construct().

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.

array
getPluginDefinition()

Gets the definition of the plugin implementation.

bool
isConfigurable()

Determines if the plugin is configurable.

__get($name)

Implements magic __get() method.

createContextFromConfiguration(array $context_configuration)

Creates context objects from any context mappings in configuration.

getContextDefinitions()

Gets the context definitions of the plugin.

getContextDefinition(string $name)

Gets a specific context definition of the plugin.

array
getContexts()

Gets the defined contexts.

getContext(string $name)

Gets a defined context.

setContext(string $name, ContextInterface $context)

Set a context on this plugin.

array
getContextValues()

Gets the values for all defined contexts.

mixed
getContextValue(string $name)

Gets the value for a defined context.

$this
setContextValue(string $name, mixed $value)

Sets the value for a defined context.

ConstraintViolationListInterface
validateContexts()

Validates the set values for the defined contexts.

$this
setTypedDataManager(TypedDataManagerInterface $typed_data_manager)

Sets the typed data manager.

getTypedDataManager()

Gets the typed data manager.

t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

getStringTranslation()

Gets the string translation service.

$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

__sleep()

{@inheritdoc}

__wakeup()

{@inheritdoc}

array
getContextMapping()

Gets a mapping of the expected assignment names to their context names.

$this
setContextMapping(array $context_mapping)

Sets a mapping of the expected assignment names to their context names.

string[]
getCacheContexts()

The cache contexts associated with this object.

string[]
getCacheTags()

The cache tags associated with this object.

int
getCacheMaxAge()

The maximum age for which this object may be cached.

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.

setSectionList(SectionListInterface $section_list) deprecated

Sets the section list on the storage.

getSectionList()

Gets the section list.

string
getStorageType()

Returns the type of this storage.

count()

{@inheritdoc}

getSections()

Gets the layout sections.

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.

$this
removeSection(int $delta)

Removes the section at the given delta.

$this
removeAllSections(bool $set_blank = FALSE)

Removes all of the sections.

getContextsDuringPreview()

Gets contexts for use during preview.

string
getTempstoreKey()

Gets a string suitable for use as a tempstore key.

create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)

Creates an instance of the plugin.

getEntity()

Gets the entity storing the overrides.

string
getStorageId()

Returns an identifier for this storage.

string|null
extractIdFromRoute(mixed $value, mixed $definition, string $name, array $defaults)

Configures the plugin based on route values.

getSectionListFromId(string $id)

Derives the section list from the storage ID.

deriveContextsFromRoute(mixed $value, mixed $definition, string $name, array $defaults)

Derives the available plugin contexts from route values.

buildRoutes(RouteCollection $collection)

Provides the routes needed for Layout Builder UI.

array
buildLocalTasks(mixed $base_plugin_definition)

Provides the local tasks dynamically for Layout Builder plugins.

bool
hasIntegerId(EntityTypeInterface $entity_type)

Determines if this entity type's ID is stored as an integer.

getEntityTypes()

Returns an array of relevant entity types.

getDefaultSectionStorage()

Returns the corresponding defaults section storage for this override.

Url
getRedirectUrl()

Gets the URL used when redirecting away from the Layout Builder UI.

Url
getLayoutBuilderUrl(string $rel = 'view')

Gets the URL used to display the Layout Builder UI.

string
label()

Gets the label for the object using the sections.

int
save()

Saves the sections.

access(string $operation, AccountInterface $account = NULL, bool $return_as_object = FALSE)

Checks data value access.

handleTranslationAccess(AccessResult $result, string $operation, AccountInterface $account)

Handles access checks related to translations.

bool
isApplicable(RefinableCacheableDependencyInterface $cacheability)

Determines if this section storage is applicable for the current contexts.

bool
isOverridden()

Indicates if overrides are in use.

Details

__construct(array $configuration, string $plugin_id, mixed $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityFieldManagerInterface $entity_field_manager, SectionStorageManagerInterface $section_storage_manager, EntityRepositoryInterface $entity_repository, AccountInterface $current_user = NULL)

Overrides \Drupal\Component\Plugin\PluginBase::__construct().

Overrides the construction of context aware plugins to allow for unvalidated constructor based injection of contexts.

Parameters

array $configuration

A configuration array containing information about the plugin instance.

string $plugin_id

The plugin_id for the plugin instance.

mixed $plugin_definition

The plugin implementation definition.

EntityTypeManagerInterface $entity_type_manager
EntityFieldManagerInterface $entity_field_manager
SectionStorageManagerInterface $section_storage_manager
EntityRepositoryInterface $entity_repository
AccountInterface $current_user

string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

string getBaseId()

Gets the base_plugin_id of the plugin instance.

Return Value

string

The base_plugin_id of the plugin instance.

string|null getDerivativeId()

Gets the derivative_id of the plugin instance.

Return Value

string|null

The derivative_id of the plugin instance NULL otherwise.

array getPluginDefinition()

Gets the definition of the plugin implementation.

Return Value

array

The plugin definition, as returned by the discovery object used by the plugin manager.

bool isConfigurable()

Determines if the plugin is configurable.

Return Value

bool

A boolean indicating whether the plugin is configurable.

__get($name)

Implements magic __get() method.

Parameters

$name

protected ContextInterface[] createContextFromConfiguration(array $context_configuration)

Creates context objects from any context mappings in configuration.

Parameters

array $context_configuration

An associative array of context names and values.

Return Value

ContextInterface[]

An array of context objects.

ContextDefinitionInterface[] getContextDefinitions()

Gets the context definitions of the plugin.

Return Value

ContextDefinitionInterface[]

The array of context definitions, keyed by context name.

ContextDefinitionInterface getContextDefinition(string $name)

Gets a specific context definition of the plugin.

Parameters

string $name

The name of the context in the plugin definition.

Return Value

ContextDefinitionInterface

The definition against which the context value must validate.

Exceptions

PluginException

array getContexts()

Gets the defined contexts.

Return Value

array

The set context objects.

Exceptions

PluginException

ContextInterface getContext(string $name)

Gets a defined context.

Parameters

string $name

The name of the context in the plugin definition.

Return Value

ContextInterface

The context object.

Exceptions

PluginException

setContext(string $name, ContextInterface $context)

Set a context on this plugin.

Parameters

string $name

The name of the context in the plugin configuration.

ContextInterface $context

The context object to set.

array getContextValues()

Gets the values for all defined contexts.

Return Value

array

An array of set context values, keyed by context name. If a context is unset its value is returned as NULL.

mixed getContextValue(string $name)

Gets the value for a defined context.

Parameters

string $name

The name of the context in the plugin configuration.

Return Value

mixed

The currently set context value.

Exceptions

PluginException

$this setContextValue(string $name, mixed $value)

Sets the value for a defined context.

Parameters

string $name

The name of the context in the plugin definition.

mixed $value

The value to set the context to. The value has to validate against the provided context definition.

Return Value

$this

A context aware plugin object for chaining.

Exceptions

PluginException

ConstraintViolationListInterface validateContexts()

Validates the set values for the defined contexts.

Return Value

ConstraintViolationListInterface

A list of constraint violations. If the list is empty, validation succeeded.

$this setTypedDataManager(TypedDataManagerInterface $typed_data_manager)

Sets the typed data manager.

Parameters

TypedDataManagerInterface $typed_data_manager

The typed data manager.

Return Value

$this

TypedDataManagerInterface getTypedDataManager()

Gets the typed data manager.

Return Value

TypedDataManagerInterface

The typed data manager.

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

Parameters

string $string

A string containing the English text to translate.

array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.

array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

__sleep()

{@inheritdoc}

__wakeup()

{@inheritdoc}

array getContextMapping()

Gets a mapping of the expected assignment names to their context names.

Return Value

array

A mapping of the expected assignment names to their context names. For example, if one of the $contexts is named 'user.current_user', but the plugin expects a context named 'user', then this map would contain 'user' => 'user.current_user'.

$this setContextMapping(array $context_mapping)

Sets a mapping of the expected assignment names to their context names.

Parameters

array $context_mapping

A mapping of the expected assignment names to their context names. For example, if one of the $contexts is named 'user.current_user', but the plugin expects a context named 'user', then this map would contain 'user' => 'user.current_user'.

Return Value

$this

protected ContextHandlerInterface contextHandler()

Wraps the context handler.

string[] getCacheContexts()

The cache contexts associated with this object.

These identify a specific variation/representation of the object.

Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.

Return Value

string[]

An array of cache context tokens, used to generate a cache ID.

string[] getCacheTags()

The cache tags associated with this object.

When this object is modified, these cache tags will be invalidated.

Return Value

string[]

A set of cache tags.

int getCacheMaxAge()

The maximum age for which this object may be cached.

Return Value

int

The maximum time in seconds that this object may be cached.

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.

Parameters

RouteCollection $collection

The route collection.

SectionStorageDefinition $definition

The definition of the section storage.

string $path

The path patten for the routes.

array $defaults

(optional) An array of default parameter values.

array $requirements

(optional) An array of requirements for parameters.

array $options

(optional) An array of options.

string $route_name_prefix

(optional) The prefix to use for the route name.

string $entity_type_id

(optional) The entity type ID, if available.

setSectionList(SectionListInterface $section_list) deprecated

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.

internal  As of Drupal 8.7.0, this method should no longer be used. It previously should only have been used during storage instantiation.
 

Sets the section list on the storage.

Parameters

SectionListInterface $section_list

The section list.

Exceptions

Exception

protected SectionListInterface getSectionList()

Gets the section list.

Return Value

SectionListInterface

The section list.

string getStorageType()

Returns the type of this storage.

Used in conjunction with the storage ID.

Return Value

string

The type of storage.

count()

{@inheritdoc}

Section[] getSections()

Gets the layout sections.

Return Value

Section[]

A sequentially and numerically keyed array of section objects.

Section getSection(int $delta)

Gets a domain object for the layout section.

Parameters

int $delta

The delta of the section.

Return Value

Section

The layout section.

$this appendSection(Section $section)

Appends a new section to the end of the list.

Parameters

Section $section

The section to append.

Return Value

$this

$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.

Parameters

int $delta

The delta of the section.

Section $section

The section to insert.

Return Value

$this

$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.

Parameters

int $delta

The delta of the section.

Return Value

$this

$this removeAllSections(bool $set_blank = FALSE)

Removes all of the sections.

Parameters

bool $set_blank

(optional) The default implementation of section lists differentiates between a list that has never contained any sections and a list that has purposefully had all sections removed in order to remain blank. Passing TRUE will mirror ::removeSection() by tracking this as a blank list. Passing FALSE will reset the list as though it had never contained any sections at all. Defaults to FALSE.

Return Value

$this

ContextInterface[] getContextsDuringPreview()

Gets contexts for use during preview.

When not in preview, ::getContexts() will be used.

Return Value

ContextInterface[]

The plugin contexts suitable for previewing.

string getTempstoreKey()

Gets a string suitable for use as a tempstore key.

Return Value

string

A string to be used as the key for a tempstore item.

static ContainerFactoryPluginInterface create(ContainerInterface $container, array $configuration, string $plugin_id, mixed $plugin_definition)

Creates an instance of the plugin.

Parameters

ContainerInterface $container

The container to pull out services used in the plugin.

array $configuration

A configuration array containing information about the plugin instance.

string $plugin_id

The plugin ID for the plugin instance.

mixed $plugin_definition

The plugin implementation definition.

Return Value

ContainerFactoryPluginInterface

Returns an instance of this plugin.

protected FieldableEntityInterface getEntity()

Gets the entity storing the overrides.

Return Value

FieldableEntityInterface

The entity storing the overrides.

string getStorageId()

Returns an identifier for this storage.

Return Value

string

The unique identifier for this storage.

string|null extractIdFromRoute(mixed $value, mixed $definition, string $name, array $defaults)

Configures the plugin based on route values.

Parameters

mixed $value

The raw value.

mixed $definition

The parameter definition provided in the route options.

string $name

The name of the parameter.

array $defaults

The route defaults array.

Return Value

string|null

The section storage ID if it could be extracted, NULL otherwise.

SectionListInterface getSectionListFromId(string $id)

Derives the section list from the storage ID.

Parameters

string $id

The storage ID, see ::getStorageId().

Return Value

SectionListInterface

The section list.

Exceptions

InvalidArgumentException

ContextInterface[] deriveContextsFromRoute(mixed $value, mixed $definition, string $name, array $defaults)

Derives the available plugin contexts from route values.

This should only be called during section storage instantiation, specifically for use by the routing system. For all non-routing usages, use \Drupal\Component\Plugin\ContextAwarePluginInterface::getContextValue().

Parameters

mixed $value

The raw value.

mixed $definition

The parameter definition provided in the route options.

string $name

The name of the parameter.

array $defaults

The route defaults array.

Return Value

ContextInterface[]

The available plugin contexts.

buildRoutes(RouteCollection $collection)

Provides the routes needed for Layout Builder UI.

Allows the plugin to add or alter routes during the route building process. \Drupal\layout_builder\Routing\LayoutBuilderRoutesTrait is provided for the typical use case of building a standard Layout Builder UI.

Parameters

RouteCollection $collection

The route collection.

array buildLocalTasks(mixed $base_plugin_definition)

Provides the local tasks dynamically for Layout Builder plugins.

Parameters

mixed $base_plugin_definition

The definition of the base plugin.

Return Value

array

An array of full derivative definitions keyed on derivative ID.

protected bool hasIntegerId(EntityTypeInterface $entity_type)

Determines if this entity type's ID is stored as an integer.

Parameters

EntityTypeInterface $entity_type

An entity type.

Return Value

bool

TRUE if this entity type's ID key is always an integer, FALSE otherwise.

protected EntityTypeInterface[] getEntityTypes()

Returns an array of relevant entity types.

Return Value

EntityTypeInterface[]

An array of entity types.

DefaultsSectionStorageInterface getDefaultSectionStorage()

Returns the corresponding defaults section storage for this override.

Return Value

DefaultsSectionStorageInterface

The defaults section storage.

Url getRedirectUrl()

Gets the URL used when redirecting away from the Layout Builder UI.

Return Value

Url

The URL object.

Url getLayoutBuilderUrl(string $rel = 'view')

Gets the URL used to display the Layout Builder UI.

Parameters

string $rel

(optional) The link relationship type, for example: 'view' or 'disable'. Defaults to 'view'.

Return Value

Url

The URL object.

string label()

Gets the label for the object using the sections.

Return Value

string

The label, or NULL if there is no label defined.

int save()

Saves the sections.

Return Value

int

SAVED_NEW or SAVED_UPDATED is returned depending on the operation performed.

bool|AccessResultInterface access(string $operation, AccountInterface $account = NULL, bool $return_as_object = FALSE)

Checks data value access.

Parameters

string $operation

The operation to be performed.

AccountInterface $account

(optional) The user for which to check access, or NULL to check access for the current user. Defaults to NULL.

bool $return_as_object

(optional) Defaults to FALSE.

Return Value

bool|AccessResultInterface

The access result. Returns a boolean if $return_as_object is FALSE (this is the default) and otherwise an AccessResultInterface object. When a boolean is returned, the result of AccessInterface::isAllowed() is returned, i.e. TRUE means access is explicitly allowed, FALSE means access is either explicitly forbidden or "no opinion".

protected AccessResultInterface handleTranslationAccess(AccessResult $result, string $operation, AccountInterface $account)

Handles access checks related to translations.

Parameters

AccessResult $result

The access result.

string $operation

The operation to be performed.

AccountInterface $account

The user for which to check access.

Return Value

AccessResultInterface

The access result.

bool isApplicable(RefinableCacheableDependencyInterface $cacheability)

Determines if this section storage is applicable for the current contexts.

Parameters

RefinableCacheableDependencyInterface $cacheability

Refinable cacheability object, typically provided by the section storage manager. When implementing this method, populate $cacheability with any information that affects whether this storage is applicable.

Return Value

bool

TRUE if this section storage is applicable, FALSE otherwise.

bool isOverridden()

Indicates if overrides are in use.

Return Value

bool

TRUE if this overrides section storage is in use, otherwise FALSE.