class LayoutSectionItemList
Same name in other branches
- 9 core/modules/layout_builder/src/Field/LayoutSectionItemList.php \Drupal\layout_builder\Field\LayoutSectionItemList
- 8.9.x core/modules/layout_builder/src/Field/LayoutSectionItemList.php \Drupal\layout_builder\Field\LayoutSectionItemList
- 10 core/modules/layout_builder/src/Field/LayoutSectionItemList.php \Drupal\layout_builder\Field\LayoutSectionItemList
Defines an item list class for layout section fields.
@internal Plugin classes are internal.
Hierarchy
- class \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\TypedDataInterface, \Drupal\Component\Plugin\PluginInspectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\TypedData\TypedDataTrait
- class \Drupal\Core\TypedData\Plugin\DataType\ItemList extends \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, \Drupal\Core\TypedData\ListInterface
- class \Drupal\Core\Field\FieldItemList extends \Drupal\Core\TypedData\Plugin\DataType\ItemList implements \Drupal\Core\Field\FieldItemListInterface
- class \Drupal\layout_builder\Field\LayoutSectionItemList extends \Drupal\Core\Field\FieldItemList implements \Drupal\layout_builder\SectionListInterface uses \Drupal\layout_builder\SectionListTrait
- class \Drupal\Core\Field\FieldItemList extends \Drupal\Core\TypedData\Plugin\DataType\ItemList implements \Drupal\Core\Field\FieldItemListInterface
- class \Drupal\Core\TypedData\Plugin\DataType\ItemList extends \Drupal\Core\TypedData\TypedData implements \Drupal\Core\TypedData\Plugin\DataType\IteratorAggregate, \Drupal\Core\TypedData\ListInterface
Expanded class hierarchy of LayoutSectionItemList
See also
\Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem
1 file declares its use of LayoutSectionItemList
- LayoutSectionItem.php in core/
modules/ layout_builder/ src/ Plugin/ Field/ FieldType/ LayoutSectionItem.php
File
-
core/
modules/ layout_builder/ src/ Field/ LayoutSectionItemList.php, line 21
Namespace
Drupal\layout_builder\FieldView source
class LayoutSectionItemList extends FieldItemList implements SectionListInterface {
use SectionListTrait;
/**
* Numerically indexed array of field items.
*
* @var \Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem[]
*/
protected $list = [];
/**
* {@inheritdoc}
*/
public function getSections() {
$sections = [];
foreach ($this->list as $delta => $item) {
$sections[$delta] = $item->section;
}
return $sections;
}
/**
* {@inheritdoc}
*/
protected function setSections(array $sections) {
$this->list = [];
$sections = array_values($sections);
/** @var \Drupal\layout_builder\Plugin\Field\FieldType\LayoutSectionItem $item */
foreach ($sections as $section) {
$item = $this->appendItem();
$item->section = $section;
}
return $this;
}
/**
* {@inheritdoc}
*/
public function getEntity() {
$entity = parent::getEntity();
// Ensure the entity is updated with the latest value.
$entity->set($this->getName(), $this->getValue());
return $entity;
}
/**
* {@inheritdoc}
*/
public function preSave() {
parent::preSave();
// Loop through each section and reconstruct it to ensure that all default
// values are present.
foreach ($this->list as $item) {
$item->section = Section::fromArray($item->section
->toArray());
}
}
/**
* {@inheritdoc}
*/
public function equals(FieldItemListInterface $list_to_compare) {
if (!$list_to_compare instanceof LayoutSectionItemList) {
return FALSE;
}
// Convert arrays of section objects to array values for comparison.
$convert = function (LayoutSectionItemList $list) {
return array_map(function (Section $section) {
return $section->toArray();
}, $list->getSections());
};
return $convert($this) === $convert($list_to_compare);
}
/**
* Overrides \Drupal\Core\Field\FieldItemListInterface::defaultAccess().
*
* @ingroup layout_builder_access
*/
public function defaultAccess($operation = 'view', ?AccountInterface $account = NULL) {
// @todo Allow access in https://www.drupal.org/node/2942975.
return AccessResult::forbidden();
}
}
Members
Title Sort descending | 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 | ||
FieldItemList::$langcode | protected | property | The langcode of the field values held in the object. | ||
FieldItemList::access | public | function | Checks data value access. | Overrides AccessibleInterface::access | 1 |
FieldItemList::applyDefaultValue | public | function | Applies the default value. | Overrides TypedData::applyDefaultValue | |
FieldItemList::createItem | protected | function | Helper for creating a list item object. | Overrides ItemList::createItem | |
FieldItemList::defaultValuesForm | public | function | Returns a form for the default value input. | Overrides FieldItemListInterface::defaultValuesForm | 2 |
FieldItemList::defaultValuesFormSubmit | public | function | Processes the submitted default value. | Overrides FieldItemListInterface::defaultValuesFormSubmit | 2 |
FieldItemList::defaultValuesFormValidate | public | function | Validates the submitted default value. | Overrides FieldItemListInterface::defaultValuesFormValidate | 2 |
FieldItemList::defaultValueWidget | protected | function | Returns the widget object used in default value form. | ||
FieldItemList::delegateMethod | protected | function | Calls a method on each FieldItem. | ||
FieldItemList::delete | public | function | Defines custom delete behavior for field values. | Overrides FieldItemListInterface::delete | 2 |
FieldItemList::deleteRevision | public | function | Defines custom revision delete behavior for field values. | Overrides FieldItemListInterface::deleteRevision | 1 |
FieldItemList::filterEmptyItems | public | function | Filters out empty field items and re-numbers the item deltas. | Overrides FieldItemListInterface::filterEmptyItems | |
FieldItemList::generateSampleItems | public | function | Populates a specified number of field items with valid sample data. | Overrides FieldItemListInterface::generateSampleItems | 1 |
FieldItemList::getConstraints | public | function | Gets a list of validation constraints. | Overrides TypedData::getConstraints | 1 |
FieldItemList::getFieldDefinition | public | function | Gets the field definition. | Overrides FieldItemListInterface::getFieldDefinition | |
FieldItemList::getLangcode | public | function | Gets the langcode of the field values held in the object. | Overrides FieldItemListInterface::getLangcode | |
FieldItemList::getSetting | public | function | Returns the value of a given field setting. | Overrides FieldItemListInterface::getSetting | |
FieldItemList::getSettings | public | function | Returns the array of field settings. | Overrides FieldItemListInterface::getSettings | |
FieldItemList::hasAffectingChanges | public | function | Determines whether the field has relevant changes. | Overrides FieldItemListInterface::hasAffectingChanges | 1 |
FieldItemList::postSave | public | function | Defines custom post-save behavior for field values. | Overrides FieldItemListInterface::postSave | 1 |
FieldItemList::processDefaultValue | public static | function | Processes the default value before being applied. | Overrides FieldItemListInterface::processDefaultValue | 2 |
FieldItemList::setLangcode | public | function | Sets the langcode of the field values held in the object. | Overrides FieldItemListInterface::setLangcode | |
FieldItemList::setValue | public | function | Overrides \Drupal\Core\TypedData\TypedData::setValue(). | Overrides ItemList::setValue | |
FieldItemList::view | public | function | Returns a renderable array for the field items. | Overrides FieldItemListInterface::view | |
FieldItemList::__get | public | function | Magic method: Gets a property value of to the first field item. | Overrides FieldItemListInterface::__get | |
FieldItemList::__isset | public | function | Magic method: Determines whether a property of the first field item is set. | Overrides FieldItemListInterface::__isset | |
FieldItemList::__set | public | function | Magic method: Sets a property value of the first field item. | Overrides FieldItemListInterface::__set | |
FieldItemList::__unset | public | function | Magic method: Unsets a property of the first field item. | Overrides FieldItemListInterface::__unset | |
ItemList::appendItem | public | function | Appends a new item to the list. | Overrides ListInterface::appendItem | |
ItemList::filter | public | function | Filters the items in the list using a custom callback. | Overrides ListInterface::filter | |
ItemList::first | public | function | Returns the first item in this list. | Overrides ListInterface::first | |
ItemList::get | public | function | Returns the item at the specified position in this list. | Overrides ListInterface::get | 2 |
ItemList::getItemDefinition | public | function | Gets the definition of a contained item. | Overrides ListInterface::getItemDefinition | |
ItemList::getIterator | public | function | |||
ItemList::getString | public | function | Returns a string representation of the data. | Overrides TypedData::getString | |
ItemList::getValue | public | function | Gets the data value. | Overrides TypedData::getValue | |
ItemList::isEmpty | public | function | Determines whether the list contains any non-empty items. | Overrides ListInterface::isEmpty | |
ItemList::last | public | function | Returns the last item in this list. | Overrides ListInterface::last | |
ItemList::offsetExists | public | function | 1 | ||
ItemList::offsetGet | public | function | |||
ItemList::offsetSet | public | function | |||
ItemList::offsetUnset | public | function | |||
ItemList::onChange | public | function | React to changes to a child property or item. | Overrides TraversableTypedDataInterface::onChange | 1 |
ItemList::rekey | protected | function | Renumbers the items in the list. | ||
ItemList::removeItem | public | function | Removes the item at the specified position. | Overrides ListInterface::removeItem | |
ItemList::set | public | function | Sets the value of the item at a given position in the list. | Overrides ListInterface::set | |
LayoutSectionItemList::$list | protected | property | Numerically indexed array of field items. | Overrides FieldItemList::$list | |
LayoutSectionItemList::defaultAccess | public | function | Overrides \Drupal\Core\Field\FieldItemListInterface::defaultAccess(). | Overrides FieldItemList::defaultAccess | |
LayoutSectionItemList::equals | public | function | Determines equality to another object implementing FieldItemListInterface. | Overrides FieldItemList::equals | |
LayoutSectionItemList::getEntity | public | function | Gets the entity that field belongs to. | Overrides FieldItemList::getEntity | |
LayoutSectionItemList::getSections | public | function | Gets the layout sections. | Overrides SectionListInterface::getSections | |
LayoutSectionItemList::preSave | public | function | Defines custom presave behavior for field values. | Overrides FieldItemList::preSave | |
LayoutSectionItemList::setSections | protected | function | Stores the information for all sections. | Overrides SectionListTrait::setSections | |
SectionListTrait::addBlankSection | protected | function | Adds a blank section to the list. | ||
SectionListTrait::appendSection | public | function | |||
SectionListTrait::count | public | function | |||
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. | ||
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::createInstance | public static | function | Constructs a TypedData object given its definition and context. | Overrides TypedDataInterface::createInstance | |
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::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. | 4 | |
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.