class NavigationSectionStorage
Same name in other branches
- 11.x core/modules/navigation/src/Plugin/SectionStorage/NavigationSectionStorage.php \Drupal\navigation\Plugin\SectionStorage\NavigationSectionStorage
Provides navigation section storage.
@internal The navigation module is experimental.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\navigation\Plugin\SectionStorage\NavigationSectionStorage extends \Drupal\Core\Plugin\PluginBase implements \Drupal\layout_builder\SectionStorageInterface, \Drupal\layout_builder\Plugin\SectionStorage\SectionStorageLocalTaskProviderInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\layout_builder\Routing\LayoutBuilderRoutesTrait, \Drupal\layout_builder\SectionListTrait
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of NavigationSectionStorage
2 files declare their use of NavigationSectionStorage
- navigation.module in core/
modules/ navigation/ navigation.module - Primary module hooks for navigation module.
- RenderCallbacks.php in core/
modules/ navigation/ src/ RenderCallbacks.php
File
-
core/
modules/ navigation/ src/ Plugin/ SectionStorage/ NavigationSectionStorage.php, line 33
Namespace
Drupal\navigation\Plugin\SectionStorageView source
final class NavigationSectionStorage extends PluginBase implements SectionStorageInterface, SectionStorageLocalTaskProviderInterface, ContainerFactoryPluginInterface, CacheableDependencyInterface {
const STORAGE_ID = 'navigation.block_layout';
use ContextAwarePluginTrait;
use LayoutBuilderRoutesTrait;
use SectionListTrait;
/**
* The config factory.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected ConfigFactoryInterface $configFactory;
/**
* An array of sections.
*
* @var \Drupal\layout_builder\Section[]|null
*/
protected $sections;
/**
* {@inheritdoc}
*/
public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->configFactory = $config_factory;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) : static {
return new static($configuration, $plugin_id, $plugin_definition, $container->get('config.factory'));
}
/**
* {@inheritdoc}
*/
public function getStorageType() : string {
return $this->getPluginId();
}
/**
* {@inheritdoc}
*/
public function getStorageId() : string {
return self::STORAGE_ID;
}
/**
* {@inheritdoc}
*/
public function label() : string {
return 'Navigation layout';
}
/**
* Returns the name to be used to store in the config system.
*/
protected function getConfigName() : string {
return self::STORAGE_ID;
}
/**
* {@inheritdoc}
*/
public function getSections() : array {
if (is_null($this->sections)) {
$sections = $this->configFactory
->get($this->getConfigName())
->get('sections') ?: [];
$this->setSections(array_map([
Section::class,
'fromArray',
], $sections));
}
return $this->sections;
}
/**
* {@inheritdoc}
*/
protected function setSections(array $sections) : static {
$this->sections = array_values($sections);
return $this;
}
/**
* {@inheritdoc}
*/
public function save() : int {
$sections = array_map(function (Section $section) {
return $section->toArray();
}, $this->getSections());
$config = $this->configFactory
->getEditable($this->getConfigName());
$return = $config->get('sections') ? SAVED_UPDATED : SAVED_NEW;
$config->set('sections', $sections)
->save();
return $return;
}
/**
* {@inheritdoc}
*/
public function buildRoutes(RouteCollection $collection) : void {
$this->buildLayoutRoutes($collection, $this->getPluginDefinition(), '/admin/config/user-interface/navigation-block');
$default_route = 'layout_builder.' . $this->getPluginDefinition()
->id() . '.view';
$route = $collection->get($default_route);
// Use a form for editing the layout instead of a controller.
$defaults = $route->getDefaults();
$defaults['_form'] = LayoutForm::class;
unset($defaults['_controller']);
$route->setDefaults($defaults);
}
/**
* {@inheritdoc}
*/
public function deriveContextsFromRoute($value, $definition, $name, array $defaults) : array {
return [
'navigation' => new Context(new ContextDefinition('string'), 'navigation'),
];
}
/**
* {@inheritdoc}
*/
public function buildLocalTasks($base_plugin_definition) : array {
return [];
}
/**
* {@inheritdoc}
*/
public function getLayoutBuilderUrl($rel = 'view') : Url {
return Url::fromRoute("layout_builder.{$this->getStorageType()}.{$rel}", [
'id' => $this->getStorageId(),
]);
}
/**
* {@inheritdoc}
*/
public function getRedirectUrl() : Url {
return $this->getLayoutBuilderUrl();
}
/**
* {@inheritdoc}
*/
public function access($operation, ?AccountInterface $account = NULL, $return_as_object = FALSE) : AccessResultInterface|bool {
$result = AccessResult::allowedIfHasPermission($account, 'configure navigation layout');
return $return_as_object ? $result : $result->isAllowed();
}
/**
* {@inheritdoc}
*/
public function getContextsDuringPreview() : array {
return $this->getContexts();
}
/**
* {@inheritdoc}
*/
public function isApplicable(RefinableCacheableDependencyInterface $cacheability) : bool {
return TRUE;
}
/**
* {@inheritdoc}
*/
public function getContextMapping() : array {
return [
'navigation' => 'navigation',
];
}
}
Members
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.