class SectionData

Same name in other branches
  1. 8.9.x core/modules/layout_builder/src/Plugin/DataType/SectionData.php \Drupal\layout_builder\Plugin\DataType\SectionData
  2. 10 core/modules/layout_builder/src/Plugin/DataType/SectionData.php \Drupal\layout_builder\Plugin\DataType\SectionData
  3. 11.x core/modules/layout_builder/src/Plugin/DataType/SectionData.php \Drupal\layout_builder\Plugin\DataType\SectionData

Provides a data type wrapping \Drupal\layout_builder\Section.

@DataType( id = "layout_section", label = @Translation("Layout Section"), description = @Translation("A layout section"), )

@internal Plugin classes are internal.

Hierarchy

Expanded class hierarchy of SectionData

File

core/modules/layout_builder/src/Plugin/DataType/SectionData.php, line 20

Namespace

Drupal\layout_builder\Plugin\DataType
View source 
class SectionData extends TypedData {
    
    /**
     * The section object.
     *
     * @var \Drupal\layout_builder\Section
     */
    protected $value;
    
    /**
     * {@inheritdoc}
     */
    public function setValue($value, $notify = TRUE) {
        if ($value && !$value instanceof Section) {
            throw new \InvalidArgumentException(sprintf('Value assigned to "%s" is not a valid section', $this->getName()));
        }
        parent::setValue($value, $notify);
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
SectionData::$value protected property The section object.
SectionData::setValue public function Sets the data value. Overrides TypedData::setValue
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.
TypedData::$definition protected property The data definition. 1
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::applyDefaultValue public function Applies the default value. Overrides TypedDataInterface::applyDefaultValue 3
TypedData::createInstance public static function Constructs a TypedData object given its definition and context. Overrides TypedDataInterface::createInstance
TypedData::getConstraints public function Gets a list of validation constraints. Overrides TypedDataInterface::getConstraints 9
TypedData::getDataDefinition public function Gets the data definition. Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Returns the name of a property or item. Overrides TypedDataInterface::getName
TypedData::getParent public function Returns the parent data structure; i.e. either complex data or a list. Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Returns the property path of the data. Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Returns the root of the typed data tree. Overrides TypedDataInterface::getRoot
TypedData::getString public function Returns a string representation of the data. Overrides TypedDataInterface::getString 6
TypedData::getValue public function Gets the data value. Overrides TypedDataInterface::getValue 10
TypedData::setContext public function Sets the context of a property or item via a context aware parent. Overrides TypedDataInterface::setContext
TypedData::validate public function Validates the currently set data value. Overrides TypedDataInterface::validate
TypedData::__construct public function Constructs a TypedData object given its definition and context. 3
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.