1. class
  2. Drupal
  3. \
  4. layout_builder
  5. \
  6. Plugin
  7. \
  8. SectionStorage
  9. \
  10. DefaultsSectionStorage

DefaultsSectionStorage

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

LayoutBuilderRoutesTrait

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

TypedDataTrait

Wrapper methods for classes that needs typed data manager object.

StringTranslationTrait

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

DependencySerializationTrait

Provides dependency injection friendly methods for serialization.

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 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 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)

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

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
array
getPluginDefinition()

Gets the definition of the plugin implementation.

from  PluginBase
bool
isConfigurable()

Determines if the plugin is configurable.

from  PluginBase
__get($name)

Implements magic __get() method.

from  ContextAwarePluginBase
ContextInterface[]
createContextFromConfiguration(array $context_configuration)

Creates context objects from any context mappings in configuration.

from  ContextAwarePluginBase
ContextDefinitionInterface[]
getContextDefinitions()

Gets the context definitions of the plugin.

from  ContextAwarePluginBase
ContextDefinitionInterface
getContextDefinition(string $name)

Gets a specific context definition of the plugin.

from  ContextAwarePluginBase
array
getContexts()

Gets the defined contexts.

from  ContextAwarePluginBase
ContextInterface
getContext(string $name)

Gets a defined context.

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

Set a context on this plugin.

array
getContextValues()

Gets the values for all defined contexts.

from  ContextAwarePluginBase
mixed
getContextValue(string $name)

Gets the value for a defined context.

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

Sets the value for a defined context.

from  ContextAwarePluginBase
ConstraintViolationListInterface
validateContexts()

Validates the set values for the defined contexts.

from  ContextAwarePluginBase
$this
setTypedDataManager(TypedDataManagerInterface $typed_data_manager)

Sets the typed data manager.

from  TypedDataTrait
TypedDataManagerInterface
getTypedDataManager()

Gets the typed data manager.

from  TypedDataTrait
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
array
getContextMapping()

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

from  ContextAwarePluginBase
$this
setContextMapping(array $context_mapping)

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

from  ContextAwarePluginBase
ContextHandlerInterface
contextHandler()

Wraps the context handler.

from  ContextAwarePluginBase
string[]
getCacheContexts()

The cache contexts associated with this object.

from  ContextAwarePluginBase
string[]
getCacheTags()

The cache tags associated with this object.

from  ContextAwarePluginBase
int
getCacheMaxAge()

The maximum age for which this object may be cached.

from  ContextAwarePluginBase
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
setSectionList(SectionListInterface $section_list) deprecated

Sets the section list on the storage.

from  SectionStorageBase
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.

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

Configures the plugin based on route values.

SectionListInterface
getSectionListFromId(string $id)

Derives the section list from the storage ID.

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)

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

in PluginBase at line 66
string getPluginId()

Gets the plugin_id of the plugin instance.

Return Value

string

The plugin_id of the plugin instance.

in PluginBase at line 73
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 84
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 PluginBase at line 96
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.

in PluginBase at line 106
bool isConfigurable()

Determines if the plugin is configurable.

Return Value

bool

A boolean indicating whether the plugin is configurable.

in ContextAwarePluginBase at line 67
__get($name)

Implements magic __get() method.

Parameters

$name

in ContextAwarePluginBase at line 30
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.

in ContextAwarePluginBase at line 105
ContextDefinitionInterface[] getContextDefinitions()

Gets the context definitions of the plugin.

Return Value

ContextDefinitionInterface[]

The array of context definitions, keyed by context name.

in ContextAwarePluginBase at line 114
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

in ContextAwarePluginBase at line 124
array getContexts()

Gets the defined contexts.

Return Value

array

The set context objects.

Exceptions

PluginException

in ContextAwarePluginBase at line 50
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

at line 440
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 ContextAwarePluginBase at line 153
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 ContextAwarePluginBase at line 164
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

in ContextAwarePluginBase at line 72
$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

in ContextAwarePluginBase at line 179
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 TypedDataTrait at line 25
$this setTypedDataManager(TypedDataManagerInterface $typed_data_manager)

Sets the typed data manager.

Parameters

TypedDataManagerInterface $typed_data_manager

The typed data manager.

Return Value

$this

in TypedDataTrait at line 36
TypedDataManagerInterface getTypedDataManager()

Gets the typed data manager.

Return Value

TypedDataManagerInterface

The typed data manager.

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 30
__sleep()

{@inheritdoc}

in DependencySerializationTrait at line 65
__wakeup()

{@inheritdoc}

in ContextAwarePluginBase at line 80
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 ContextAwarePluginBase at line 88
$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

in ContextAwarePluginBase at line 123
protected ContextHandlerInterface contextHandler()

Wraps the context handler.

Return Value

ContextHandlerInterface

in ContextAwarePluginBase at line 130
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.

in ContextAwarePluginBase at line 146
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.

in ContextAwarePluginBase at line 162
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.

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.

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

at line 95
protected SectionListInterface getSectionList()

Gets the section list.

Return Value

SectionListInterface

The section list.

in SectionStorageBase at line 53
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 60
count()

{@inheritdoc}

in SectionStorageBase at line 67
Section[] getSections()

Gets the layout sections.

Return Value

Section[]

A sequentially and numerically keyed array of section objects.

in SectionStorageBase at line 74
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 SectionStorageBase at line 81
$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 SectionStorageBase at line 89
$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 97
$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 105
$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 262
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 129
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 219
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.

at line 239
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

at line 276
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 335
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 342
int save()

Saves the sections.

Return Value

int

SAVED_NEW or SAVED_UPDATED is returned depending on the operation performed.

at line 349
bool isOverridable()

Determines if the defaults allow custom overrides.

Return Value

bool

TRUE if custom overrides are allowed, FALSE otherwise.

at line 356
$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 364
$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 372
bool isLayoutBuilderEnabled()

Determines if Layout Builder is enabled.

Return Value

bool

TRUE if Layout Builder is enabled, FALSE otherwise.

at line 379
$this enableLayoutBuilder()

Enables the Layout Builder.

Return Value

$this

at line 387
$this disableLayoutBuilder()

Disables the Layout Builder.

Return Value

$this

at line 395
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 402
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 409
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 417
array getThirdPartyProviders()

Gets the list of third parties that store information.

Return Value

array

The list of third parties.

at line 424
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 432
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.