1. interface
  2. Drupal
  3. \
  4. layout_builder
  5. \
  6. SectionListInterface

SectionListInterface

interface SectionListInterface implements Countable (View source)

Defines the interface for an object that stores layout sections.

Methods

Section[]
getSections()

Gets the layout sections.

Section
getSection(int $delta)

Gets a domain object for the layout section.

$this
appendSection(Section $section)

Appends a new section to the end of the list.

$this
insertSection(int $delta, Section $section)

Inserts a new section at a given delta.

$this
removeSection(int $delta)

Removes the section at the given delta.

$this
removeAllSections(bool $set_blank = FALSE)

Removes all of the sections.

Details

at line 18
Section[] getSections()

Gets the layout sections.

Return Value

Section[]

A sequentially and numerically keyed array of section objects.

at line 29
Section getSection(int $delta)

Gets a domain object for the layout section.

Parameters

int $delta

The delta of the section.

Return Value

Section

The layout section.

at line 39
$this appendSection(Section $section)

Appends a new section to the end of the list.

Parameters

Section $section

The section to append.

Return Value

$this

at line 54
$this insertSection(int $delta, 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.

Parameters

int $delta

The delta of the section.
Section $section

The section to insert.

Return Value

$this

at line 67
$this removeSection(int $delta)

Removes the section at the given delta.

As sections are stored sequentially and numerically this will re-key every subsequent section, shifting them forward.

Parameters

int $delta

The delta of the section.

Return Value

$this

at line 82
$this removeAllSections(bool $set_blank = FALSE)

Removes all of the sections.

Parameters

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 Value

$this