1. interface
  2. Drupal
  3. \
  4. layout_builder
  5. \
  6. SectionStorageInterface

SectionStorageInterface

interface SectionStorageInterface implements SectionListInterface, PluginInspectionInterface, ContextAwarePluginInterface, AccessibleInterface (View source)

Defines an interface for Section Storage type plugins.

Methods

Section[]
getSections()

Gets the layout sections.

from  SectionListInterface
Section
getSection(int $delta)

Gets a domain object for the layout section.

from  SectionListInterface
$this
appendSection(Section $section)

Appends a new section to the end of the list.

from  SectionListInterface
$this
insertSection(int $delta, Section $section)

Inserts a new section at a given delta.

from  SectionListInterface
$this
removeSection(int $delta)

Removes the section at the given delta.

from  SectionListInterface
$this
removeAllSections(bool $set_blank = FALSE)

Removes all of the sections.

from  SectionListInterface
string
getPluginId()

Gets the plugin_id of the plugin instance.

from  PluginInspectionInterface
array
getPluginDefinition()

Overrides \Drupal\Component\Plugin\PluginInspectionInterface::getPluginDefinition().

ContextDefinitionInterface[]
getContextDefinitions()

Gets the context definitions of the plugin.

from  ContextAwarePluginInterface
ContextDefinitionInterface
getContextDefinition(string $name)

Gets a specific context definition of the plugin.

from  ContextAwarePluginInterface
array
getContexts()

Gets the defined contexts.

from  ContextAwarePluginInterface
ContextInterface
getContext(string $name)

Gets a defined context.

from  ContextAwarePluginInterface
array
getContextValues()

Gets the values for all defined contexts.

from  ContextAwarePluginInterface
mixed
getContextValue(string $name)

Gets the value for a defined context.

from  ContextAwarePluginInterface
setContext(string $name, ContextInterface $context)

Set a context on this plugin.

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

Sets the value for a defined context.

from  ContextAwarePluginInterface
ConstraintViolationListInterface
validateContexts()

Validates the set values for the defined contexts.

from  ContextAwarePluginInterface
array
getContextMapping()

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

from  ContextAwarePluginInterface
$this
setContextMapping(array $context_mapping)

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

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

Overrides \Drupal\Core\Access\AccessibleInterface::access().

string
getStorageId()

Returns an identifier for this storage.

string
getStorageType()

Returns the type of this storage.

buildRoutes(RouteCollection $collection)

Provides the routes needed for Layout Builder UI.

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.

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

Derives the available plugin contexts from route values.

ContextInterface[]
getContextsDuringPreview()

Gets contexts for use during preview.

string
label()

Gets the label for the object using the sections.

int
save()

Saves the sections.

bool
isApplicable(RefinableCacheableDependencyInterface $cacheability)

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

Details

in SectionListInterface at line 18
Section[] getSections()

Gets the layout sections.

Return Value

Section[]

A sequentially and numerically keyed array of section objects.

in SectionListInterface at line 29
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.

in SectionListInterface at line 39
$this appendSection(Section $section)

Appends a new section to the end of the list.

Parameters

Section $section

The section to append.

Return Value

$this

in SectionListInterface at line 54
$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 SectionListInterface at line 67
$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 SectionListInterface at line 82
$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

in PluginInspectionInterface at line 21
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

at line 144
array getPluginDefinition()

Overrides \Drupal\Component\Plugin\PluginInspectionInterface::getPluginDefinition().

Return Value

array

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

in ContextAwarePluginInterface at line 23
ContextDefinitionInterface[] getContextDefinitions()

Gets the context definitions of the plugin.

Return Value

ContextDefinitionInterface[]

The array of context definitions, keyed by context name.

in ContextAwarePluginInterface at line 37
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

ContextException

in ContextAwarePluginInterface at line 48
array getContexts()

Gets the defined contexts.

Return Value

array

The set context objects.

Exceptions

ContextException

in ContextAwarePluginInterface at line 62
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

ContextException

in ContextAwarePluginInterface at line 71
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.

in ContextAwarePluginInterface at line 85
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

ContextException

in ContextAwarePluginInterface at line 95
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.

in ContextAwarePluginInterface at line 112
$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

ContextException

in ContextAwarePluginInterface at line 121
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.

in ContextAwarePluginInterface at line 132
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'.

in ContextAwarePluginInterface at line 145
$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

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

Overrides \Drupal\Core\Access\AccessibleInterface::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 23
string getStorageId()

Returns an identifier for this storage.

Return Value

string

The unique identifier for this storage.

at line 33
string getStorageType()

Returns the type of this storage.

Used in conjunction with the storage ID.

Return Value

string

The type of storage.

at line 47
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.

See also

RoutingEvents::ALTER

at line 55
Url getRedirectUrl()

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

Return Value

Url

The URL object.

at line 67
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 90
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.

See also

ParamConverterInterface::convert

at line 100
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.

at line 108
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 117
int save()

Saves the sections.

Return Value

int

SAVED_NEW or SAVED_UPDATED is returned depending on the operation performed.

at line 136
bool isApplicable(RefinableCacheableDependencyInterface $cacheability)

internal  This method is intended to be called by \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface::findByContext().
 

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.

See also

RefinableCacheableDependencyInterface