class SimpleConfigSectionStorage
Same name and namespace in other branches
- 11.x core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/SectionStorage/SimpleConfigSectionStorage.php \Drupal\layout_builder_test\Plugin\SectionStorage\SimpleConfigSectionStorage
- 9 core/modules/layout_builder/tests/modules/layout_builder_test/src/Plugin/SectionStorage/SimpleConfigSectionStorage.php \Drupal\layout_builder_test\Plugin\SectionStorage\SimpleConfigSectionStorage
- 8.9.x 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.
Attributes
#[SectionStorage(id: "test_simple_config", context_definitions: [
"config_id" => new ContextDefinition(data_type: "string", label: new TranslatableMarkup("Configuration ID")),
])]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
- class \Drupal\layout_builder_test\Plugin\SectionStorage\SimpleConfigSectionStorage implements \Drupal\layout_builder\SectionStorageInterface, \Drupal\layout_builder\Plugin\SectionStorage\SectionStorageLocalTaskProviderInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface uses \Drupal\Core\Plugin\ContextAwarePluginTrait, \Drupal\layout_builder\Routing\LayoutBuilderRoutesTrait, \Drupal\layout_builder\SectionListTrait extends \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait extends \Drupal\Component\Plugin\PluginBase
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 28
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
| Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
|---|---|---|---|---|---|
| ContextAwarePluginTrait::$context | protected | property | The data objects representing the context of this plugin. | ||
| ContextAwarePluginTrait::getCacheContexts | public | function | 10 | ||
| ContextAwarePluginTrait::getCacheMaxAge | public | function | 6 | ||
| ContextAwarePluginTrait::getCacheTags | public | function | 3 | ||
| ContextAwarePluginTrait::getContext | public | function | |||
| ContextAwarePluginTrait::getContextDefinition | public | function | |||
| ContextAwarePluginTrait::getContextDefinitions | public | function | |||
| ContextAwarePluginTrait::getContextMapping | public | function | 1 | ||
| ContextAwarePluginTrait::getContexts | public | function | |||
| ContextAwarePluginTrait::getContextValue | public | function | |||
| ContextAwarePluginTrait::getContextValues | public | function | |||
| ContextAwarePluginTrait::getPluginDefinition | abstract public | function | 1 | ||
| ContextAwarePluginTrait::setContext | public | function | 1 | ||
| ContextAwarePluginTrait::setContextMapping | public | function | |||
| ContextAwarePluginTrait::setContextValue | public | function | |||
| ContextAwarePluginTrait::validateContexts | public | function | |||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | ||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | ||
| DependencySerializationTrait::__sleep | public | function | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | #[\ReturnTypeWillChange] | 2 | |
| LayoutBuilderRoutesTrait::buildLayoutRoutes | protected | function | Builds the layout routes for the given values. | ||
| MessengerTrait::$messenger | protected | property | The messenger. | 25 | |
| MessengerTrait::messenger | public | function | Gets the messenger. | 25 | |
| MessengerTrait::setMessenger | public | function | Sets the messenger. | ||
| PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | |
| PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | |
| PluginBase::$pluginId | protected | property | The plugin ID. | ||
| PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | |||
| PluginBase::getBaseId | public | function | Gets the base_plugin_id of the plugin instance. | Overrides DerivativeInspectionInterface::getBaseId | |
| PluginBase::getDerivativeId | public | function | Gets the derivative_id of the plugin instance. | Overrides DerivativeInspectionInterface::getDerivativeId | |
| PluginBase::getPluginId | public | function | Gets the plugin ID of the plugin instance. | Overrides PluginInspectionInterface::getPluginId | |
| PluginBase::isConfigurable | public | function | Determines if the plugin is configurable. | ||
| SectionListTrait::addBlankSection | protected | function | Adds a blank section to the list. | ||
| SectionListTrait::appendSection | public | function | |||
| SectionListTrait::count | public | function | #[\ReturnTypeWillChange] | ||
| SectionListTrait::getSection | public | function | |||
| SectionListTrait::hasBlankSection | protected | function | Indicates if this section list contains a blank section. | ||
| SectionListTrait::hasSection | protected | function | Indicates if there is a section at the specified delta. | ||
| SectionListTrait::insertSection | public | function | |||
| SectionListTrait::removeAllSections | public | function | |||
| SectionListTrait::removeSection | public | function | |||
| SectionListTrait::setSection | protected | function | Sets the section for the given delta on the display. | ||
| SectionListTrait::__clone | public | function | Magic method: Implements a deep clone. | ||
| SimpleConfigSectionStorage::$configFactory | protected | property | The config factory. | ||
| SimpleConfigSectionStorage::$sections | protected | property | An array of sections. | ||
| SimpleConfigSectionStorage::access | public | function | Overrides \Drupal\Core\Access\AccessibleInterface::access(). | Overrides SectionStorageInterface::access | |
| SimpleConfigSectionStorage::buildLocalTasks | public | function | Provides the local tasks dynamically for Layout Builder plugins. | Overrides SectionStorageLocalTaskProviderInterface::buildLocalTasks | |
| SimpleConfigSectionStorage::buildRoutes | public | function | Provides the routes needed for Layout Builder UI. | Overrides SectionStorageInterface::buildRoutes | |
| SimpleConfigSectionStorage::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | |
| SimpleConfigSectionStorage::deriveContextsFromRoute | public | function | Derives the available plugin contexts from route values. | Overrides SectionStorageInterface::deriveContextsFromRoute | |
| SimpleConfigSectionStorage::getConfigName | protected | function | Returns the name to be used to store in the config system. | ||
| SimpleConfigSectionStorage::getContextsDuringPreview | public | function | Gets contexts for use during preview. | Overrides SectionStorageInterface::getContextsDuringPreview | |
| SimpleConfigSectionStorage::getLayoutBuilderUrl | public | function | Gets the URL used to display the Layout Builder UI. | Overrides SectionStorageInterface::getLayoutBuilderUrl | |
| SimpleConfigSectionStorage::getRedirectUrl | public | function | Gets the URL used when redirecting away from the Layout Builder UI. | Overrides SectionStorageInterface::getRedirectUrl | |
| SimpleConfigSectionStorage::getSections | public | function | Gets the layout sections. | Overrides SectionListInterface::getSections | |
| SimpleConfigSectionStorage::getStorageId | public | function | Returns an identifier for this storage. | Overrides SectionStorageInterface::getStorageId | |
| SimpleConfigSectionStorage::getStorageType | public | function | Returns the type of this storage. | Overrides SectionStorageInterface::getStorageType | |
| SimpleConfigSectionStorage::isApplicable | public | function | Determines if this section storage is applicable for the current contexts. | Overrides SectionStorageInterface::isApplicable | |
| SimpleConfigSectionStorage::label | public | function | Gets the label for the object using the sections. | Overrides SectionStorageInterface::label | |
| SimpleConfigSectionStorage::save | public | function | Saves the sections. | Overrides SectionStorageInterface::save | |
| SimpleConfigSectionStorage::setSections | protected | function | Stores the information for all sections. | Overrides SectionListTrait::setSections | |
| SimpleConfigSectionStorage::__construct | public | function | Constructs a \Drupal\Component\Plugin\PluginBase object. | Overrides PluginBase::__construct | |
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
| StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
| StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
| StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
| StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
| StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.