SectionStorage.php

Same filename in other branches
  1. 8.9.x core/modules/layout_builder/src/Annotation/SectionStorage.php
  2. 10 core/modules/layout_builder/src/Annotation/SectionStorage.php
  3. 11.x core/modules/layout_builder/src/Annotation/SectionStorage.php
  4. 11.x core/modules/layout_builder/src/Attribute/SectionStorage.php
  5. 10 core/modules/layout_builder/src/Attribute/SectionStorage.php

Namespace

Drupal\layout_builder\Annotation

File

core/modules/layout_builder/src/Annotation/SectionStorage.php

View source
<?php

namespace Drupal\layout_builder\Annotation;

use Drupal\Component\Annotation\Plugin;
use Drupal\layout_builder\SectionStorage\SectionStorageDefinition;

/**
 * Defines a Section Storage type annotation object.
 *
 * @see \Drupal\layout_builder\SectionStorage\SectionStorageManager
 * @see plugin_api
 *
 * @Annotation
 */
class SectionStorage extends Plugin {
    
    /**
     * The plugin ID.
     *
     * @var string
     */
    public $id;
    
    /**
     * The plugin weight, optional (defaults to 0).
     *
     * When an entity with layout is rendered, section storage plugins are
     * checked, in order of their weight, to determine which one should be used
     * to render the layout.
     *
     * @var int
     */
    public $weight = 0;
    
    /**
     * Any required context definitions, optional.
     *
     * When an entity with layout is rendered, all section storage plugins which
     * match a particular set of contexts are checked, in order of their weight,
     * to determine which plugin should be used to render the layout.
     *
     * @var array
     *
     * @see \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface::findByContext()
     */
    public $context_definitions = [];
    
    /**
     * Indicates that this section storage handles its own permission checking.
     *
     * If FALSE, the 'configure any layout' permission will be required during
     * routing access. If TRUE, Layout Builder will not enforce any access
     * restrictions for the storage, so the section storage's implementation of
     * access() must perform the access checking itself. Defaults to FALSE.
     *
     * @var bool
     *
     * @see \Drupal\layout_builder\Access\LayoutBuilderAccessCheck
     */
    public $handles_permission_check = FALSE;
    
    /**
     * {@inheritdoc}
     */
    public function get() {
        return new SectionStorageDefinition($this->definition);
    }

}

Classes

Title Deprecated Summary
SectionStorage Defines a Section Storage type annotation object.

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