interface SectionListInterface
Same name in other branches
- 8.9.x core/modules/layout_builder/src/SectionListInterface.php \Drupal\layout_builder\SectionListInterface
- 10 core/modules/layout_builder/src/SectionListInterface.php \Drupal\layout_builder\SectionListInterface
- 11.x core/modules/layout_builder/src/SectionListInterface.php \Drupal\layout_builder\SectionListInterface
Defines the interface for an object that stores layout sections.
Hierarchy
- interface \Drupal\layout_builder\SectionListInterface extends \Drupal\layout_builder\Countable
Expanded class hierarchy of SectionListInterface
All classes that implement SectionListInterface
See also
\Drupal\layout_builder\Section
3 files declare their use of SectionListInterface
- LayoutEntityDisplayInterface.php in core/
modules/ layout_builder/ src/ Entity/ LayoutEntityDisplayInterface.php - LayoutSectionItemList.php in core/
modules/ layout_builder/ src/ Field/ LayoutSectionItemList.php - SectionListTraitTest.php in core/
modules/ layout_builder/ tests/ src/ Kernel/ SectionListTraitTest.php
File
-
core/
modules/ layout_builder/ src/ SectionListInterface.php, line 10
Namespace
Drupal\layout_builderView source
interface SectionListInterface extends \Countable {
/**
* Gets the layout sections.
*
* @return \Drupal\layout_builder\Section[]
* A sequentially and numerically keyed array of section objects.
*/
public function getSections();
/**
* Gets a domain object for the layout section.
*
* @param int $delta
* The delta of the section.
*
* @return \Drupal\layout_builder\Section
* The layout section.
*/
public function getSection($delta);
/**
* Appends a new section to the end of the list.
*
* @param \Drupal\layout_builder\Section $section
* The section to append.
*
* @return $this
*/
public function appendSection(Section $section);
/**
* Inserts a new section at a given delta.
*
* If a section exists at the given index, the section at that position and
* others after it are shifted backward.
*
* @param int $delta
* The delta of the section.
* @param \Drupal\layout_builder\Section $section
* The section to insert.
*
* @return $this
*/
public function insertSection($delta, Section $section);
/**
* Removes the section at the given delta.
*
* As sections are stored sequentially and numerically this will re-key every
* subsequent section, shifting them forward.
*
* @param int $delta
* The delta of the section.
*
* @return $this
*/
public function removeSection($delta);
/**
* Removes all of the sections.
*
* @param bool $set_blank
* (optional) The default implementation of section lists differentiates
* between a list that has never contained any sections and a list that has
* purposefully had all sections removed in order to remain blank. Passing
* TRUE will mirror ::removeSection() by tracking this as a blank list.
* Passing FALSE will reset the list as though it had never contained any
* sections at all. Defaults to FALSE.
*
* @return $this
*/
public function removeAllSections($set_blank = FALSE);
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
SectionListInterface::appendSection | public | function | Appends a new section to the end of the list. | 1 |
SectionListInterface::getSection | public | function | Gets a domain object for the layout section. | 1 |
SectionListInterface::getSections | public | function | Gets the layout sections. | 5 |
SectionListInterface::insertSection | public | function | Inserts a new section at a given delta. | 1 |
SectionListInterface::removeAllSections | public | function | Removes all of the sections. | 1 |
SectionListInterface::removeSection | public | function | Removes the section at the given delta. | 1 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.