function SectionStorageInterface::isApplicable

Same name in other branches
  1. 9 core/modules/layout_builder/src/SectionStorageInterface.php \Drupal\layout_builder\SectionStorageInterface::isApplicable()
  2. 8.9.x core/modules/layout_builder/src/SectionStorageInterface.php \Drupal\layout_builder\SectionStorageInterface::isApplicable()
  3. 10 core/modules/layout_builder/src/SectionStorageInterface.php \Drupal\layout_builder\SectionStorageInterface::isApplicable()

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

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

Parameters

\Drupal\Core\Cache\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

\Drupal\Core\Cache\RefinableCacheableDependencyInterface

5 methods override SectionStorageInterface::isApplicable()
DefaultsSectionStorage::isApplicable in core/modules/layout_builder/src/Plugin/SectionStorage/DefaultsSectionStorage.php
Determines if this section storage is applicable for the current contexts.
NavigationSectionStorage::isApplicable in core/modules/navigation/src/Plugin/SectionStorage/NavigationSectionStorage.php
Determines if this section storage is applicable for the current contexts.
OverridesSectionStorage::isApplicable in core/modules/layout_builder/src/Plugin/SectionStorage/OverridesSectionStorage.php
Determines if this section storage is applicable for the current contexts.
SimpleConfigSectionStorage::isApplicable in core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/SectionStorage/SimpleConfigSectionStorage.php
Determines if this section storage is applicable for the current contexts.
TestStateBasedSectionStorage::isApplicable in core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/SectionStorage/TestStateBasedSectionStorage.php
Determines if this section storage is applicable for the current contexts.

File

core/modules/layout_builder/src/SectionStorageInterface.php, line 136

Class

SectionStorageInterface
Defines an interface for Section Storage type plugins.

Namespace

Drupal\layout_builder

Code

public function isApplicable(RefinableCacheableDependencyInterface $cacheability);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.