1. interface
  2. Drupal
  3. \
  4. layout_builder
  5. \
  6. SectionStorage
  7. \
  8. SectionStorageManagerInterface

SectionStorageManagerInterface

interface SectionStorageManagerInterface implements DiscoveryInterface (View source)

Provides the interface for a plugin manager of section storage types.

Methods

mixed
getDefinition(string $plugin_id, bool $exception_on_invalid = TRUE)

Gets a specific plugin definition.

from  DiscoveryInterface
array
getDefinitions()

Gets the definition of all plugins for this type.

from  DiscoveryInterface
bool
hasDefinition(string $plugin_id)

Indicates if a specific plugin definition exists.

from  DiscoveryInterface
SectionStorageInterface|null
load(string $type, array $contexts = [])

Loads a section storage with the provided contexts applied.

SectionStorageInterface|null
findByContext(array $contexts, RefinableCacheableDependencyInterface $cacheability)

Finds the section storage to load based on available contexts.

SectionStorageInterface
loadEmpty(string $type)

Loads a section storage with no associated section list.

SectionStorageInterface
loadFromStorageId(string $type, string $id) deprecated

Loads a section storage populated with an existing section list.

SectionStorageInterface|null
loadFromRoute(string $type, string $value, mixed $definition, string $name, array $defaults) deprecated

Loads a section storage populated with a section list derived from a route.

Details

in DiscoveryInterface at line 28
mixed getDefinition(string $plugin_id, bool $exception_on_invalid = TRUE)

Gets a specific plugin definition.

Parameters

string $plugin_id

A plugin id.
bool $exception_on_invalid

(optional) If TRUE, an invalid plugin ID will throw an exception.

Return Value

mixed

A plugin definition, or NULL if the plugin ID is invalid and $exception_on_invalid is FALSE.

Exceptions

PluginNotFoundException

in DiscoveryInterface at line 39
array getDefinitions()

Gets the definition of all plugins for this type.

Return Value

array

An array of plugin definitions (empty array if no definitions were found). Keys are plugin IDs.

See also

FilteredPluginManagerInterface::getFilteredDefinitions

in DiscoveryInterface at line 50
bool hasDefinition(string $plugin_id)

Indicates if a specific plugin definition exists.

Parameters

string $plugin_id

A plugin ID.

Return Value

bool

TRUE if the definition exists, FALSE otherwise.

at line 24
SectionStorageInterface|null load(string $type, array $contexts = [])

Loads a section storage with the provided contexts applied.

Parameters

string $type

The section storage type.
array $contexts

(optional) The contexts available for this storage to use.

Return Value

SectionStorageInterface|null

The section storage or NULL if its context requirements are not met.

at line 43
SectionStorageInterface|null findByContext(array $contexts, RefinableCacheableDependencyInterface $cacheability)

Finds the section storage to load based on available contexts.

Parameters

array $contexts

The contexts which should be used to determine which storage to return.
RefinableCacheableDependencyInterface $cacheability

Refinable cacheability object, which will be populated based on the cacheability of each section storage candidate. After calling this method this parameter will reflect the cacheability information used to determine the correct section storage. This must be associated with any output that uses the result of this method.

Return Value

SectionStorageInterface|null

The section storage if one matched all contexts, or NULL otherwise.

See also

RefinableCacheableDependencyInterface

at line 60
SectionStorageInterface loadEmpty(string $type)

internal  Section storage relies on context to load section lists. Use ::load() when that context is available. This method is intended for use by collaborators of the plugins in build-time situations when section storage type must be consulted.
 

Loads a section storage with no associated section list.

Parameters

string $type

The type of the section storage being instantiated.

Return Value

SectionStorageInterface

The section storage.

at line 80
SectionStorageInterface loadFromStorageId(string $type, string $id) deprecated

deprecated in drupal:8.7.0 and is removed from drupal:9.0.0. \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface::load() should be used instead. See https://www.drupal.org/node/3012353.

Loads a section storage populated with an existing section list.

Parameters

string $type

The section storage type.
string $id

The section list ID.

Return Value

SectionStorageInterface

The section storage.

Exceptions

InvalidArgumentException

at line 106
SectionStorageInterface|null loadFromRoute(string $type, string $value, mixed $definition, string $name, array $defaults) deprecated

deprecated in drupal:8.7.0 and is removed from drupal:9.0.0. \Drupal\layout_builder\SectionStorageInterface::deriveContextsFromRoute() and \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface::load() should be used instead. See https://www.drupal.org/node/3012353.

Loads a section storage populated with a section list derived from a route.

Parameters

string $type

The section storage type.
string $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

SectionStorageInterface|null

The section storage if it could be loaded, or NULL otherwise.

See also

ParamConverterInterface::convert