class SimpleConfigSectionStorage in Drupal 9
Same name and namespace in other branches
- 8 core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/SectionStorage/SimpleConfigSectionStorage.php \Drupal\layout_builder_test\Plugin\SectionStorage\SimpleConfigSectionStorage
- 10 core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/SectionStorage/SimpleConfigSectionStorage.php \Drupal\layout_builder_test\Plugin\SectionStorage\SimpleConfigSectionStorage
Provides section storage utilizing simple config.
Plugin annotation
@SectionStorage(
id = "test_simple_config",
context_definitions = {
"config_id" = @ContextDefinition("string"),
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\layout_builder_test\Plugin\SectionStorage\SimpleConfigSectionStorage implements ContainerFactoryPluginInterface, SectionStorageLocalTaskProviderInterface, SectionStorageInterface uses ContextAwarePluginTrait, LayoutBuilderRoutesTrait, SectionListTrait
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of SimpleConfigSectionStorage
1 file declares its use of SimpleConfigSectionStorage
- SimpleConfigSectionListTest.php in core/
modules/ layout_builder/ tests/ src/ Kernel/ SimpleConfigSectionListTest.php
File
- core/
modules/ layout_builder/ tests/ modules/ layout_builder_test/ src/ Plugin/ SectionStorage/ SimpleConfigSectionStorage.php, line 33
Namespace
Drupal\layout_builder_test\Plugin\SectionStorageView source
class SimpleConfigSectionStorage extends PluginBase implements SectionStorageInterface, SectionStorageLocalTaskProviderInterface, ContainerFactoryPluginInterface {
use ContextAwarePluginTrait;
use LayoutBuilderRoutesTrait;
use SectionListTrait;
/**
* The config factory.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $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) {
return new static($configuration, $plugin_id, $plugin_definition, $container
->get('config.factory'));
}
/**
* {@inheritdoc}
*/
public function getStorageType() {
return $this
->getPluginId();
}
/**
* {@inheritdoc}
*/
public function getStorageId() {
return $this
->getContextValue('config_id');
}
/**
* {@inheritdoc}
*/
public function label() {
return $this
->getStorageId();
}
/**
* Returns the name to be used to store in the config system.
*/
protected function getConfigName() {
return 'layout_builder_test.' . $this
->getStorageType() . '.' . $this
->getStorageId();
}
/**
* {@inheritdoc}
*/
public function getSections() {
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) {
$this->sections = array_values($sections);
return $this;
}
/**
* {@inheritdoc}
*/
public function save() {
$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) {
$this
->buildLayoutRoutes($collection, $this
->getPluginDefinition(), 'layout-builder-test-simple-config/{id}');
}
/**
* {@inheritdoc}
*/
public function deriveContextsFromRoute($value, $definition, $name, array $defaults) {
$contexts['config_id'] = new Context(new ContextDefinition('string'), $value ?: $defaults['id']);
return $contexts;
}
/**
* {@inheritdoc}
*/
public function buildLocalTasks($base_plugin_definition) {
$type = $this
->getStorageType();
$local_tasks = [];
$local_tasks["layout_builder.{$type}.view"] = $base_plugin_definition + [
'route_name' => "layout_builder.{$type}.view",
'title' => $this
->t('Layout'),
'base_route' => "layout_builder.{$type}.view",
];
$local_tasks["layout_builder.{$type}.view__child"] = $base_plugin_definition + [
'route_name' => "layout_builder.{$type}.view",
'title' => $this
->t('Layout'),
'parent_id' => "layout_builder_ui:layout_builder.{$type}.view",
];
$local_tasks["layout_builder.{$type}.discard_changes"] = $base_plugin_definition + [
'route_name' => "layout_builder.{$type}.discard_changes",
'title' => $this
->t('Discard changes'),
'parent_id' => "layout_builder_ui:layout_builder.{$type}.view",
'weight' => 5,
];
return $local_tasks;
}
/**
* {@inheritdoc}
*/
public function getLayoutBuilderUrl($rel = 'view') {
return Url::fromRoute("layout_builder.{$this->getStorageType()}.{$rel}", [
'id' => $this
->getStorageId(),
]);
}
/**
* {@inheritdoc}
*/
public function getRedirectUrl() {
return $this
->getLayoutBuilderUrl();
}
/**
* {@inheritdoc}
*/
public function access($operation, AccountInterface $account = NULL, $return_as_object = FALSE) {
$result = AccessResult::allowed();
return $return_as_object ? $result : $result
->isAllowed();
}
/**
* {@inheritdoc}
*/
public function getContextsDuringPreview() {
return $this
->getContexts();
}
/**
* {@inheritdoc}
*/
public function isApplicable(RefinableCacheableDependencyInterface $cacheability) {
return TRUE;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ContextAwarePluginTrait:: |
protected | property | The data objects representing the context of this plugin. | |
ContextAwarePluginTrait:: |
protected | property | Tracks whether the context has been initialized from configuration. | |
ContextAwarePluginTrait:: |
public | function | 9 | |
ContextAwarePluginTrait:: |
public | function | 7 | |
ContextAwarePluginTrait:: |
public | function | 4 | |
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
abstract protected | function | 1 | |
ContextAwarePluginTrait:: |
public | function | 1 | |
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
ContextAwarePluginTrait:: |
public | function | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
LayoutBuilderRoutesTrait:: |
protected | function | Builds the layout routes for the given values. | |
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
SectionListTrait:: |
protected | function | Adds a blank section to the list. | |
SectionListTrait:: |
public | function | ||
SectionListTrait:: |
public | function | ||
SectionListTrait:: |
public | function | ||
SectionListTrait:: |
protected | function | Indicates if this section list contains a blank section. | |
SectionListTrait:: |
protected | function | Indicates if there is a section at the specified delta. | |
SectionListTrait:: |
public | function | ||
SectionListTrait:: |
public | function | ||
SectionListTrait:: |
public | function | ||
SectionListTrait:: |
protected | function | Sets the section for the given delta on the display. | |
SectionListTrait:: |
public | function | Magic method: Implements a deep clone. | |
SimpleConfigSectionStorage:: |
protected | property | The config factory. | |
SimpleConfigSectionStorage:: |
protected | property | An array of sections. | |
SimpleConfigSectionStorage:: |
public | function |
Overrides \Drupal\Core\Access\AccessibleInterface::access(). Overrides SectionStorageInterface:: |
|
SimpleConfigSectionStorage:: |
public | function |
Provides the local tasks dynamically for Layout Builder plugins. Overrides SectionStorageLocalTaskProviderInterface:: |
|
SimpleConfigSectionStorage:: |
public | function |
Provides the routes needed for Layout Builder UI. Overrides SectionStorageInterface:: |
|
SimpleConfigSectionStorage:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
SimpleConfigSectionStorage:: |
public | function |
Derives the available plugin contexts from route values. Overrides SectionStorageInterface:: |
|
SimpleConfigSectionStorage:: |
protected | function | Returns the name to be used to store in the config system. | |
SimpleConfigSectionStorage:: |
public | function |
Gets contexts for use during preview. Overrides SectionStorageInterface:: |
|
SimpleConfigSectionStorage:: |
public | function |
Gets the URL used to display the Layout Builder UI. Overrides SectionStorageInterface:: |
|
SimpleConfigSectionStorage:: |
public | function |
Gets the URL used when redirecting away from the Layout Builder UI. Overrides SectionStorageInterface:: |
|
SimpleConfigSectionStorage:: |
public | function |
Gets the layout sections. Overrides SectionListInterface:: |
|
SimpleConfigSectionStorage:: |
public | function |
Returns an identifier for this storage. Overrides SectionStorageInterface:: |
|
SimpleConfigSectionStorage:: |
public | function |
Returns the type of this storage. Overrides SectionStorageInterface:: |
|
SimpleConfigSectionStorage:: |
public | function |
Determines if this section storage is applicable for the current contexts. Overrides SectionStorageInterface:: |
|
SimpleConfigSectionStorage:: |
public | function |
Gets the label for the object using the sections. Overrides SectionStorageInterface:: |
|
SimpleConfigSectionStorage:: |
public | function |
Saves the sections. Overrides SectionStorageInterface:: |
|
SimpleConfigSectionStorage:: |
protected | function |
Stores the information for all sections. Overrides SectionListTrait:: |
|
SimpleConfigSectionStorage:: |
public | function |
Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |