class 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 \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface- class \Drupal\Component\Plugin\ContextAwarePluginBase implements \Drupal\Component\Plugin\ContextAwarePluginInterface extends \Drupal\Component\Plugin\PluginBase- class \Drupal\Core\Plugin\ContextAwarePluginBase implements \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait extends \Drupal\Component\Plugin\ContextAwarePluginBase- 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\layout_builder\Routing\LayoutBuilderRoutesTrait, \Drupal\layout_builder\SectionStorage\SectionStorageTrait extends \Drupal\Core\Plugin\ContextAwarePluginBase
 
 
- class \Drupal\Core\Plugin\ContextAwarePluginBase implements \Drupal\Core\Plugin\ContextAwarePluginInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Core\TypedData\TypedDataTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait extends \Drupal\Component\Plugin\ContextAwarePluginBase
 
- class \Drupal\Component\Plugin\ContextAwarePluginBase implements \Drupal\Component\Plugin\ContextAwarePluginInterface extends \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of SimpleConfigSectionStorage
1 file declares its use of SimpleConfigSectionStorage
- SimpleConfigSectionStorageTest.php in core/modules/ layout_builder/ tests/ src/ Kernel/ SimpleConfigSectionStorageTest.php 
File
- 
              core/modules/ layout_builder/ tests/ modules/ layout_builder_test/ src/ Plugin/ SectionStorage/ SimpleConfigSectionStorage.php, line 32 
Namespace
Drupal\layout_builder_test\Plugin\SectionStorageView source
class SimpleConfigSectionStorage extends ContextAwarePluginBase implements SectionStorageInterface, SectionStorageLocalTaskProviderInterface, ContainerFactoryPluginInterface {
  use LayoutBuilderRoutesTrait;
  use SectionStorageTrait;
  
  /**
   * 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 getSectionListFromId($id) {
    @trigger_error('\\Drupal\\layout_builder\\SectionStorageInterface::getSectionListFromId() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. The section list should be derived from context. See https://www.drupal.org/node/3016262.', E_USER_DEPRECATED);
    return $this;
  }
  
  /**
   * {@inheritdoc}
   */
  public function extractIdFromRoute($value, $definition, $name, array $defaults) {
    @trigger_error('\\Drupal\\layout_builder\\SectionStorageInterface::extractIdFromRoute() is deprecated in Drupal 8.7.0 and will be removed before Drupal 9.0.0. \\Drupal\\layout_builder\\SectionStorageInterface::deriveContextsFromRoute() should be used instead. See https://www.drupal.org/node/3016262.', E_USER_DEPRECATED);
    return $value ?: $defaults['id'];
  }
  
  /**
   * {@inheritdoc}
   */
  public function isApplicable(RefinableCacheableDependencyInterface $cacheability) {
    return TRUE;
  }
}Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides | 
|---|---|---|---|---|---|---|
| ContextAwarePluginBase::$context | protected | property | The data objects representing the context of this plugin. | |||
| ContextAwarePluginBase::$contexts | Deprecated | private | property | Data objects representing the contexts passed in the plugin configuration. | ||
| ContextAwarePluginBase::contextHandler | protected | function | Wraps the context handler. | |||
| ContextAwarePluginBase::createContextFromConfiguration | protected | function | Overrides ContextAwarePluginBase::createContextFromConfiguration | |||
| ContextAwarePluginBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyInterface::getCacheContexts | 9 | |
| ContextAwarePluginBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyInterface::getCacheMaxAge | 7 | |
| ContextAwarePluginBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyInterface::getCacheTags | 4 | |
| ContextAwarePluginBase::getContext | public | function | This code is identical to the Component in order to pick up a different Context class. | Overrides ContextAwarePluginBase::getContext | ||
| ContextAwarePluginBase::getContextDefinition | public | function | Overrides ContextAwarePluginBase::getContextDefinition | |||
| ContextAwarePluginBase::getContextDefinitions | public | function | Overrides ContextAwarePluginBase::getContextDefinitions | |||
| ContextAwarePluginBase::getContextMapping | public | function | Gets a mapping of the expected assignment names to their context names. | Overrides ContextAwarePluginInterface::getContextMapping | ||
| ContextAwarePluginBase::getContexts | public | function | Gets the defined contexts. | Overrides ContextAwarePluginInterface::getContexts | ||
| ContextAwarePluginBase::getContextValue | public | function | Gets the value for a defined context. | Overrides ContextAwarePluginInterface::getContextValue | ||
| ContextAwarePluginBase::getContextValues | public | function | Gets the values for all defined contexts. | Overrides ContextAwarePluginInterface::getContextValues | ||
| ContextAwarePluginBase::setContext | public | function | Set a context on this plugin. | Overrides ContextAwarePluginBase::setContext | 2 | |
| ContextAwarePluginBase::setContextMapping | public | function | Sets a mapping of the expected assignment names to their context names. | Overrides ContextAwarePluginInterface::setContextMapping | ||
| ContextAwarePluginBase::setContextValue | public | function | Sets the value for a defined context. | Overrides ContextAwarePluginBase::setContextValue | ||
| ContextAwarePluginBase::validateContexts | public | function | Validates the set values for the defined contexts. | Overrides ContextAwarePluginInterface::validateContexts | ||
| ContextAwarePluginBase::__get | public | function | Implements magic __get() method. | |||
| 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 | 1 | |||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| LayoutBuilderRoutesTrait::buildLayoutRoutes | protected | function | Builds the layout routes for the given values. | |||
| 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::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | Overrides PluginInspectionInterface::getPluginDefinition | 3 | |
| 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. | |||
| SectionStorageTrait::addBlankSection | protected | function | Adds a blank section to the list. | |||
| SectionStorageTrait::appendSection | public | function | ||||
| SectionStorageTrait::count | public | function | ||||
| SectionStorageTrait::getSection | public | function | ||||
| SectionStorageTrait::hasBlankSection | protected | function | Indicates if this section list contains a blank section. | |||
| SectionStorageTrait::hasSection | protected | function | Indicates if there is a section at the specified delta. | |||
| SectionStorageTrait::insertSection | public | function | ||||
| SectionStorageTrait::removeAllSections | public | function | ||||
| SectionStorageTrait::removeSection | public | function | ||||
| SectionStorageTrait::setSection | protected | function | Sets the section for the given delta on the display. | |||
| SectionStorageTrait::__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::extractIdFromRoute | public | function | Configures the plugin based on route values. | Overrides SectionStorageInterface::extractIdFromRoute | ||
| 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::getSectionListFromId | public | function | Derives the section list from the storage ID. | Overrides SectionStorageInterface::getSectionListFromId | ||
| 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 SectionStorageTrait::setSections | ||
| SimpleConfigSectionStorage::__construct | public | function | Overrides \Drupal\Component\Plugin\PluginBase::__construct(). | Overrides ContextAwarePluginBase::__construct | ||
| StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 1 | ||
| 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. | |||
| TypedDataTrait::$typedDataManager | protected | property | The typed data manager used for creating the data types. | |||
| TypedDataTrait::getTypedDataManager | public | function | Gets the typed data manager. | 2 | ||
| TypedDataTrait::setTypedDataManager | public | function | Sets the typed data manager. | 2 | 
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.
