class LayoutSectionItem

Same name and namespace in other branches
  1. 11.x core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php \Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem
  2. 10 core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php \Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem
  3. 9 core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php \Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem
  4. 8.9.x core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php \Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem

Plugin implementation of the 'layout_section' field type.

@internal Plugin classes are internal.

@property \Drupal\layout_builder\Section $section

Attributes

#[FieldType(id: "layout_section", label: new TranslatableMarkup("Layout Section"), description: new TranslatableMarkup("Layout Section"), no_ui: TRUE, list_class: LayoutSectionItemList::class, cardinality: FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED)]

Hierarchy

Expanded class hierarchy of LayoutSectionItem

1 file declares its use of LayoutSectionItem
DefaultContentSubscriber.php in core/modules/layout_builder/src/EventSubscriber/DefaultContentSubscriber.php

File

core/modules/layout_builder/src/Plugin/Field/FieldType/LayoutSectionItem.php, line 22

Namespace

Drupal\layout_builder\Plugin\Field\FieldType
View source
class LayoutSectionItem extends FieldItemBase {
  
  /**
   * {@inheritdoc}
   */
  public static function propertyDefinitions(FieldStorageDefinitionInterface $field_definition) {
    $properties['section'] = DataDefinition::create('layout_section')->setLabel(new TranslatableMarkup('Layout Section'))
      ->setRequired(FALSE);
    return $properties;
  }
  
  /**
   * {@inheritdoc}
   */
  public function __get($name) {
    // @todo \Drupal\Core\Field\FieldItemBase::__get() does not return default
    //   values for un-instantiated properties. This will forcibly instantiate
    //   all properties with the side-effect of a performance hit, resolve
    //   properly in https://www.drupal.org/node/2413471.
    $this->getProperties();
    return parent::__get($name);
  }
  
  /**
   * {@inheritdoc}
   */
  public static function mainPropertyName() {
    return 'section';
  }
  
  /**
   * {@inheritdoc}
   */
  public static function schema(FieldStorageDefinitionInterface $field_definition) {
    $schema = [
      'columns' => [
        'section' => [
          'type' => 'blob',
          'size' => 'normal',
          'serialize' => TRUE,
        ],
      ],
    ];
    return $schema;
  }
  
  /**
   * {@inheritdoc}
   */
  public static function generateSampleValue(FieldDefinitionInterface $field_definition) {
    // @todo Expand this in https://www.drupal.org/node/2912331.
    $values['section'] = new Section('layout_onecol');
    return $values;
  }
  
  /**
   * {@inheritdoc}
   */
  public function isEmpty() {
    return empty($this->section);
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
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 2
FieldItemBase::calculateDependencies public static function Overrides FieldItemInterface::calculateDependencies 3
FieldItemBase::calculateStorageDependencies public static function Overrides FieldItemInterface::calculateStorageDependencies 1
FieldItemBase::defaultFieldSettings public static function Overrides FieldItemInterface::defaultFieldSettings 7
FieldItemBase::defaultStorageSettings public static function Overrides FieldItemInterface::defaultStorageSettings 10
FieldItemBase::delete public function Overrides FieldItemInterface::delete 2
FieldItemBase::deleteRevision public function Overrides FieldItemInterface::deleteRevision
FieldItemBase::fieldSettingsForm public function Overrides FieldItemInterface::fieldSettingsForm 7
FieldItemBase::fieldSettingsFromConfigData public static function Overrides FieldItemInterface::fieldSettingsFromConfigData 1
FieldItemBase::fieldSettingsSummary public static function Overrides FieldItemInterface::fieldSettingsSummary 1
FieldItemBase::fieldSettingsToConfigData public static function Overrides FieldItemInterface::fieldSettingsToConfigData 1
FieldItemBase::getEntity public function Overrides FieldItemInterface::getEntity
FieldItemBase::getFieldDefinition public function Overrides FieldItemInterface::getFieldDefinition
FieldItemBase::getLangcode public function Overrides FieldItemInterface::getLangcode
FieldItemBase::getSetting protected function Returns the value of a field setting.
FieldItemBase::getSettings protected function Returns the array of field settings.
FieldItemBase::onDependencyRemoval public static function Overrides FieldItemInterface::onDependencyRemoval 1
FieldItemBase::postSave public function Overrides FieldItemInterface::postSave 2
FieldItemBase::preSave public function Overrides FieldItemInterface::preSave 7
FieldItemBase::setValue public function Overrides Map::setValue 4
FieldItemBase::storageSettingsForm public function Overrides FieldItemInterface::storageSettingsForm 8
FieldItemBase::storageSettingsFromConfigData public static function Overrides FieldItemInterface::storageSettingsFromConfigData 2
FieldItemBase::storageSettingsSummary public static function Overrides FieldItemInterface::storageSettingsSummary 1
FieldItemBase::storageSettingsToConfigData public static function Overrides FieldItemInterface::storageSettingsToConfigData 2
FieldItemBase::view public function Overrides FieldItemInterface::view
FieldItemBase::writePropertyValue protected function Different to the parent Map class, we avoid creating property objects as
far as possible in order to optimize performance. Thus we just update
$this->values if no property object has been created yet.
Overrides Map::writePropertyValue
FieldItemBase::__construct public function Overrides TypedData::__construct 3
FieldItemBase::__isset public function Overrides FieldItemInterface::__isset
FieldItemBase::__set public function Overrides FieldItemInterface::__set 1
FieldItemBase::__unset public function Overrides FieldItemInterface::__unset
LayoutSectionItem::generateSampleValue public static function Overrides FieldItemBase::generateSampleValue
LayoutSectionItem::isEmpty public function Overrides Map::isEmpty
LayoutSectionItem::mainPropertyName public static function Overrides FieldItemBase::mainPropertyName
LayoutSectionItem::propertyDefinitions public static function Overrides FieldItemInterface::propertyDefinitions
LayoutSectionItem::schema public static function Overrides FieldItemInterface::schema
LayoutSectionItem::__get public function Overrides FieldItemBase::__get
Map::$definition protected property The data definition. Overrides TypedData::$definition
Map::$properties protected property The array of properties.
Map::$values protected property An array of values for the contained properties.
Map::applyDefaultValue public function Overrides TypedData::applyDefaultValue 4
Map::get public function Overrides ComplexDataInterface::get
Map::getIterator public function Retrieves the iterator for the object.
Map::getProperties public function Overrides ComplexDataInterface::getProperties
Map::getString public function Overrides TypedData::getString
Map::getValue public function Overrides TypedData::getValue 1
Map::onChange public function Overrides TraversableTypedDataInterface::onChange 4
Map::set public function Overrides ComplexDataInterface::set
Map::toArray public function Overrides ComplexDataInterface::toArray 1
Map::__clone public function Magic method: Implements a deep clone.
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. 1
TypedData::$name protected property The property name.
TypedData::$parent protected property The parent typed data object.
TypedData::createInstance public static function Overrides TypedDataInterface::createInstance
TypedData::getConstraints public function Overrides TypedDataInterface::getConstraints 9
TypedData::getDataDefinition public function Overrides TypedDataInterface::getDataDefinition
TypedData::getName public function Overrides TypedDataInterface::getName
TypedData::getParent public function Overrides TypedDataInterface::getParent
TypedData::getPluginDefinition public function Overrides PluginInspectionInterface::getPluginDefinition
TypedData::getPluginId public function Overrides PluginInspectionInterface::getPluginId
TypedData::getPropertyPath public function Overrides TypedDataInterface::getPropertyPath
TypedData::getRoot public function Overrides TypedDataInterface::getRoot
TypedData::setContext public function Overrides TypedDataInterface::setContext
TypedData::validate public function Overrides TypedDataInterface::validate
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.