Drupal\layout_builder\Plugin\SectionStorage\DefaultsSectionStorage | Drupal Core API Explorer

class DefaultsSectionStorage extends SectionStorageBase implements ContainerFactoryPluginInterface, DefaultsSectionStorageInterface (View source)

internal

Plugin classes are internal.

Defines the 'defaults' section storage type.

DefaultsSectionStorage uses a positive weight because:

It must be picked after \Drupal\layout_builder\Plugin\SectionStorage\OverridesSectionStorage.
The default weight is 0, so other custom implementations will also take precedence unless otherwise specified.

Traits

ContextAwarePluginTrait

Provides a trait to add context-aware functionality to plugins.

LayoutBuilderRoutesTrait

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

StringTranslationTrait

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

DependencySerializationTrait

Provides dependency injection friendly methods for serialization.

MessengerTrait

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
protected EntityTypeManagerInterface	$entityTypeManager	The entity type manager.
protected EntityTypeBundleInfoInterface	$entityTypeBundleInfo	The entity type bundle info.
protected SampleEntityGeneratorInterface	$sampleEntityGenerator	The sample entity generator.

Methods

__construct(array $configuration, string $plugin_id, mixed $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, SampleEntityGeneratorInterface $sample_entity_generator)

Constructs a \Drupal\Component\Plugin\PluginBase object.

string

getPluginId()

Gets the plugin_id of the plugin instance.

from PluginBase

string

getBaseId()

Gets the base_plugin_id of the plugin instance.

from PluginBase

string|null

getDerivativeId()

Gets the derivative_id of the plugin instance.

from PluginBase

getPluginDefinition()

{@inheritdoc}

from ContextAwarePluginTrait

bool

isConfigurable()

Determines if the plugin is configurable.

from PluginBase

TranslatableMarkup

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

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

from StringTranslationTrait

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

Formats a string containing a count of items.

from StringTranslationTrait

getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from StringTranslationTrait

TranslationInterface

getStringTranslation()

Gets the string translation service.

from StringTranslationTrait

$this

setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from StringTranslationTrait

__sleep()

{@inheritdoc}

from DependencySerializationTrait

__wakeup()

{@inheritdoc}

from DependencySerializationTrait

setMessenger(MessengerInterface $messenger)

Sets the messenger.

from MessengerTrait

MessengerInterface

messenger()

Gets the messenger.

from MessengerTrait

getContexts()

{@inheritdoc}

from ContextAwarePluginTrait

ContextInterface

getContext($name)

{@inheritdoc}

from ContextAwarePluginTrait

setContext($name, ContextInterface $context)

{@inheritdoc}

getContextValues()

{@inheritdoc}

from ContextAwarePluginTrait

getContextValue($name)

{@inheritdoc}

from ContextAwarePluginTrait

setContextValue($name, $value)

{@inheritdoc}

from ContextAwarePluginTrait

getContextMapping()

{@inheritdoc}

from ContextAwarePluginTrait

setContextMapping(array $context_mapping)

{@inheritdoc}

from ContextAwarePluginTrait

ContextDefinitionInterface[]

getContextDefinitions()

{@inheritdoc}

from ContextAwarePluginTrait

ContextDefinitionInterface

getContextDefinition($name)

{@inheritdoc}

from ContextAwarePluginTrait

validateContexts()

{@inheritdoc}

from ContextAwarePluginTrait

getCacheContexts()

{@inheritdoc}

from ContextAwarePluginTrait

getCacheTags()

{@inheritdoc}

from ContextAwarePluginTrait

getCacheMaxAge()

{@inheritdoc}

from ContextAwarePluginTrait

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.

from LayoutBuilderRoutesTrait

SectionListInterface

getSectionList()

Gets the section list.

string

getStorageType()

Returns the type of this storage.

from SectionStorageBase

count()

{@inheritdoc}

from SectionStorageBase

Section[]

getSections()

Gets the layout sections.

from SectionStorageBase

Section

getSection(int $delta)

Gets a domain object for the layout section.

from SectionStorageBase

$this

appendSection(Section $section)

Appends a new section to the end of the list.

from SectionStorageBase

$this

insertSection(int $delta, Section $section)

Inserts a new section at a given delta.

from SectionStorageBase

$this

removeSection(int $delta)

Removes the section at the given delta.

from SectionStorageBase

$this

removeAllSections(bool $set_blank = FALSE)

Removes all of the sections.

from SectionStorageBase

ContextInterface[]

getContextsDuringPreview()

Gets contexts for use during preview.

string

getTempstoreKey()

Gets a string suitable for use as a tempstore key.

from SectionStorageBase

static ContainerFactoryPluginInterface

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

Creates an instance of the plugin.

LayoutEntityDisplayInterface

getDisplay()

Gets the entity storing the defaults.

string

getStorageId()

Returns an identifier for this storage.

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.

array

getRouteParameters()

Provides the route parameters needed to generate a URL for this object.

buildRoutes(RouteCollection $collection)

Provides the routes needed for Layout Builder UI.

EntityTypeInterface[]

getEntityTypes()

Returns an array of relevant entity types.

ContextInterface[]

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

Derives the available plugin contexts from route values.

string

label()

Gets the label for the object using the sections.

int

save()

Saves the sections.

bool

isOverridable()

Determines if the defaults allow custom overrides.

$this

setOverridable(bool $overridable = TRUE)

Sets the defaults to allow or disallow overrides.

$this

setThirdPartySetting(string $module, string $key, mixed $value)

Sets the value of a third-party setting.

bool

isLayoutBuilderEnabled()

Determines if Layout Builder is enabled.

$this

enableLayoutBuilder()

Enables the Layout Builder.

$this

disableLayoutBuilder()

Disables the Layout Builder.

mixed

getThirdPartySetting(string $module, string $key, mixed $default = NULL)

Gets the value of a third-party setting.

array

getThirdPartySettings(string $module)

Gets all third-party settings of a given module.

mixed

unsetThirdPartySetting(string $module, string $key)

Unsets a third-party setting.

array

getThirdPartyProviders()

Gets the list of third parties that store information.

bool|AccessResultInterface

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

Checks data value access.

bool

isApplicable(RefinableCacheableDependencyInterface $cacheability)

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

Details

at line 70
`__construct(array $configuration, string $plugin_id, mixed $plugin_definition, EntityTypeManagerInterface $entity_type_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info, SampleEntityGeneratorInterface $sample_entity_generator)`

Constructs a \Drupal\Component\Plugin\PluginBase object.

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
EntityTypeBundleInfoInterface	$entity_type_bundle_info
SampleEntityGeneratorInterface	$sample_entity_generator

in PluginBase at line 62
`string getPluginId()`

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginBase at line 69
`string getBaseId()`

Gets the base_plugin_id of the plugin instance.

Return Value

string

The base_plugin_id of the plugin instance.

in PluginBase at line 80
`string|null getDerivativeId()`

Gets the derivative_id of the plugin instance.

Return Value

string|null

The derivative_id of the plugin instance NULL otherwise.

in ContextAwarePluginTrait at line 153
`abstract protected getPluginDefinition()`

{@inheritdoc}

in PluginBase at line 102
`bool isConfigurable()`

Determines if the plugin is configurable.

Return Value

bool	A boolean indicating whether the plugin is configurable.

in StringTranslationTrait at line 70
`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

in StringTranslationTrait at line 79
`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

in StringTranslationTrait at line 88
`protected getNumberOfPlurals($langcode = NULL)`

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
`protected TranslationInterface getStringTranslation()`

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
`$this setStringTranslation(TranslationInterface $translation)`

Sets the string translation service to use.

Parameters

TranslationInterface

$translation

The string translation service.

Return Value

$this

in DependencySerializationTrait at line 32
`__sleep()`

{@inheritdoc}

in DependencySerializationTrait at line 67
`__wakeup()`

{@inheritdoc}

in MessengerTrait at line 23
`setMessenger(MessengerInterface $messenger)`

Sets the messenger.

Parameters

MessengerInterface

$messenger

The messenger.

in MessengerTrait at line 33
`MessengerInterface messenger()`

Gets the messenger.

Return Value

MessengerInterface

The messenger.

in ContextAwarePluginTrait at line 46
`getContexts()`

{@inheritdoc}

in ContextAwarePluginTrait at line 60
`ContextInterface getContext($name)`

{@inheritdoc}

Parameters

$name

Return Value

ContextInterface

The context object.

at line 397
`setContext($name, ContextInterface $context)`

{@inheritdoc}

Parameters

	$name
ContextInterface	$context

in ContextAwarePluginTrait at line 104
`getContextValues()`

{@inheritdoc}

in ContextAwarePluginTrait at line 115
`getContextValue($name)`

{@inheritdoc}

Parameters

$name

in ContextAwarePluginTrait at line 122
`setContextValue($name, $value)`

{@inheritdoc}

Parameters

	$name
	$value

in ContextAwarePluginTrait at line 130
`getContextMapping()`

{@inheritdoc}

in ContextAwarePluginTrait at line 138
`setContextMapping(array $context_mapping)`

{@inheritdoc}

Parameters

array

$context_mapping

in ContextAwarePluginTrait at line 160
`ContextDefinitionInterface[] getContextDefinitions()`

{@inheritdoc}

Return Value

ContextDefinitionInterface[]

in ContextAwarePluginTrait at line 174
`ContextDefinitionInterface getContextDefinition($name)`

{@inheritdoc}

Parameters

$name

Return Value

ContextDefinitionInterface

in ContextAwarePluginTrait at line 190
`validateContexts()`

{@inheritdoc}

in ContextAwarePluginTrait at line 205
`getCacheContexts()`

{@inheritdoc}

in ContextAwarePluginTrait at line 221
`getCacheTags()`

{@inheritdoc}

in ContextAwarePluginTrait at line 237
`getCacheMaxAge()`

{@inheritdoc}

in LayoutBuilderRoutesTrait at line 37
`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.

at line 95
`protected SectionListInterface getSectionList()`

Gets the section list.

Return Value

SectionListInterface

The section list.

in SectionStorageBase at line 34
`string getStorageType()`

Returns the type of this storage.

Used in conjunction with the storage ID.

Return Value

string

The type of storage.

in SectionStorageBase at line 41
`count()`

{@inheritdoc}

in SectionStorageBase at line 49
`Section[] getSections()`

Gets the layout sections.

Return Value

A sequentially and numerically keyed array of section objects.

in SectionStorageBase at line 56
`Section getSection(int $delta)`

Gets a domain object for the layout section.

Parameters

int

$delta

The delta of the section.

Return Value

The layout section.

in SectionStorageBase at line 63
`$this appendSection(Section $section)`

Appends a new section to the end of the list.

Parameters

$section

The section to append.

Return Value

$this

in SectionStorageBase at line 71
`$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

in SectionStorageBase at line 79
`$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

in SectionStorageBase at line 87
`$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

at line 219
`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.

in SectionStorageBase at line 111
`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.

at line 81
`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.

at line 105
`protected LayoutEntityDisplayInterface getDisplay()`

Gets the entity storing the defaults.

Return Value

LayoutEntityDisplayInterface

The entity storing the defaults.

at line 112
`string getStorageId()`

Returns an identifier for this storage.

Return Value

string

The unique identifier for this storage.

at line 119
`Url getRedirectUrl()`

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

Return Value

Url	The URL object.

at line 126
`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.

at line 136
`protected array getRouteParameters()`

Provides the route parameters needed to generate a URL for this object.

Return Value

array

An associative array of parameter names and values.

at line 147
`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.

at line 210
`protected EntityTypeInterface[] getEntityTypes()`

Returns an array of relevant entity types.

Return Value

EntityTypeInterface[]

An array of entity types.

at line 233
`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.

at line 292
`string label()`

Gets the label for the object using the sections.

Return Value

string

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

at line 299
`int save()`

Saves the sections.

Return Value

int	SAVED_NEW or SAVED_UPDATED is returned depending on the operation performed.

at line 306
`bool isOverridable()`

Determines if the defaults allow custom overrides.

Return Value

bool	TRUE if custom overrides are allowed, FALSE otherwise.

at line 313
`$this setOverridable(bool $overridable = TRUE)`

Sets the defaults to allow or disallow overrides.

Parameters

bool

$overridable

TRUE if the display should allow overrides, FALSE otherwise.

Return Value

$this

at line 321
`$this setThirdPartySetting(string $module, string $key, mixed $value)`

Sets the value of a third-party setting.

Parameters

string	$module	The module providing the third-party setting.
string	$key	The setting name.
mixed	$value	The setting value.

Return Value

$this

at line 329
`bool isLayoutBuilderEnabled()`

Determines if Layout Builder is enabled.

Return Value

bool	TRUE if Layout Builder is enabled, FALSE otherwise.

at line 336
`$this enableLayoutBuilder()`

Enables the Layout Builder.

Return Value

$this

at line 344
`$this disableLayoutBuilder()`

Disables the Layout Builder.

Return Value

$this

at line 352
`mixed getThirdPartySetting(string $module, string $key, mixed $default = NULL)`

Gets the value of a third-party setting.

Parameters

string	$module	The module providing the third-party setting.
string	$key	The setting name.
mixed	$default	The default value

Return Value

mixed

The value.

at line 359
`array getThirdPartySettings(string $module)`

Gets all third-party settings of a given module.

Parameters

string

$module

The module providing the third-party settings.

Return Value

array

An array of key-value pairs.

at line 366
`mixed unsetThirdPartySetting(string $module, string $key)`

Unsets a third-party setting.

Parameters

string	$module	The module providing the third-party setting.
string	$key	The setting name.

Return Value

mixed

The value.

at line 374
`array getThirdPartyProviders()`

Gets the list of third parties that store information.

Return Value

array

The list of third parties.

at line 381
`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".

at line 389
`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.