1. class
  2. Drupal
  3. \
  4. layout_builder
  5. \
  6. Section

Section

class Section implements ThirdPartySettingsInterface (View source)

Provides a domain object for layout sections.

A section consists of three parts:

  • The layout plugin ID for the layout applied to the section (for example, 'layout_onecol').
  • An array of settings for the layout plugin.
  • An array of components that can be rendered in the section.

Properties

protected string $layoutId

The layout plugin ID.
protected array $layoutSettings

The layout plugin settings.
protected SectionComponent[] $components

An array of components, keyed by UUID.
protected array[] $thirdPartySettings

Third party settings.

Methods

__construct(string $layout_id, array $layout_settings = [], array $components = [], array $third_party_settings = [])

Constructs a new Section.

array
toRenderArray(array $contexts = [], bool $in_preview = FALSE)

Returns the renderable array for this section.

LayoutInterface
getLayout()

Gets the layout plugin for this section.

string
getLayoutId()

Gets the layout plugin ID for this section.

array
getLayoutSettings()

Gets the layout plugin settings for this section.

$this
setLayoutSettings(array $layout_settings)

Sets the layout plugin settings for this section.

string
getDefaultRegion()

Gets the default region.

SectionComponent[]
getComponents()

Returns the components of the section.

SectionComponent
getComponent(string $uuid)

Gets the component for a given UUID.

$this
setComponent(SectionComponent $component)

Helper method to set a component.

$this
removeComponent(string $uuid)

Removes a given component from a region.

$this
appendComponent(SectionComponent $component)

Appends a component to the end of a region.

int
getNextHighestWeight(string $region)

Returns the next highest weight of the component in a region.

SectionComponent[]
getComponentsByRegion(string $region)

Gets the components for a specific region.

$this
insertAfterComponent(string $preceding_uuid, SectionComponent $component)

Inserts a component after a specified existing component.

$this
insertComponent(int $delta, SectionComponent $new_component)

Inserts a component at a specified delta.

LayoutPluginManagerInterface
layoutPluginManager()

Wraps the layout plugin manager.

array
toArray()

Returns an array representation of the section.

static Section
fromArray(array $section)

Creates an object from an array representation of the section.

__clone()

Magic method: Implements a deep clone.

mixed
getThirdPartySetting($provider, string $key, mixed $default = NULL)

Gets the value of a third-party setting.

array
getThirdPartySettings($provider)

Gets all third-party settings of a given module.

$this
setThirdPartySetting($provider, string $key, mixed $value)

Sets the value of a third-party setting.

mixed
unsetThirdPartySetting($provider, string $key)

Unsets a third-party setting.

array
getThirdPartyProviders()

Gets the list of third parties that store information.

Details

at line 63
__construct(string $layout_id, array $layout_settings = [], array $components = [], array $third_party_settings = [])

Constructs a new Section.

Parameters

string $layout_id

The layout plugin ID.
array $layout_settings

(optional) The layout plugin settings.
array $components

(optional) The components.
array $third_party_settings

(optional) Any third party settings.

at line 83
array toRenderArray(array $contexts = [], bool $in_preview = FALSE)

Returns the renderable array for this section.

Parameters

array $contexts

An array of available contexts.
bool $in_preview

TRUE if the section is being previewed, FALSE otherwise.

Return Value

array

A renderable array representing the content of the section.

at line 100
LayoutInterface getLayout()

Gets the layout plugin for this section.

Return Value

LayoutInterface

The layout plugin.

at line 113
string getLayoutId()

internal  This method should only be used by code responsible for storing the data.
 

Gets the layout plugin ID for this section.

Return Value

string

The layout plugin ID.

at line 126
array getLayoutSettings()

internal  This method should only be used by code responsible for storing the data.
 

Gets the layout plugin settings for this section.

Return Value

array

The layout plugin settings.

at line 138
$this setLayoutSettings(array $layout_settings)

Sets the layout plugin settings for this section.

Parameters

array $layout_settings

The layout plugin settings.

Return Value

$this

at line 149
string getDefaultRegion()

Gets the default region.

Return Value

string

The machine-readable name of the default region.

at line 159
SectionComponent[] getComponents()

Returns the components of the section.

Return Value

SectionComponent[]

The components.

at line 175
SectionComponent getComponent(string $uuid)

Gets the component for a given UUID.

Parameters

string $uuid

The UUID of the component to retrieve.

Return Value

SectionComponent

The component.

Exceptions

InvalidArgumentException

at line 191
protected $this setComponent(SectionComponent $component)

Helper method to set a component.

Parameters

SectionComponent $component

The component.

Return Value

$this

at line 204
$this removeComponent(string $uuid)

Removes a given component from a region.

Parameters

string $uuid

The UUID of the component to remove.

Return Value

$this

at line 217
$this appendComponent(SectionComponent $component)

Appends a component to the end of a region.

Parameters

SectionComponent $component

The component being appended.

Return Value

$this

at line 232
protected int getNextHighestWeight(string $region)

Returns the next highest weight of the component in a region.

Parameters

string $region

The region name.

Return Value

int

A number higher than the highest weight of the component in the region.

at line 249
SectionComponent[] getComponentsByRegion(string $region)

Gets the components for a specific region.

Parameters

string $region

The region name.

Return Value

SectionComponent[]

An array of components in the specified region, sorted by weight.

at line 272
$this insertAfterComponent(string $preceding_uuid, SectionComponent $component)

Inserts a component after a specified existing component.

Parameters

string $preceding_uuid

The UUID of the existing component to insert after.
SectionComponent $component

The component being inserted.

Return Value

$this

Exceptions

InvalidArgumentException

at line 295
$this insertComponent(int $delta, SectionComponent $new_component)

Inserts a component at a specified delta.

Parameters

int $delta

The zero-based delta in which to insert the component.
SectionComponent $new_component

The component being inserted.

Return Value

$this

Exceptions

OutOfBoundsException

at line 324
protected LayoutPluginManagerInterface layoutPluginManager()

Wraps the layout plugin manager.

Return Value

LayoutPluginManagerInterface

The layout plugin manager.

at line 336
array toArray()

Returns an array representation of the section.

Only use this method if you are implementing custom storage for sections.

Return Value

array

An array representation of the section component.

at line 358
static Section fromArray(array $section)

Creates an object from an array representation of the section.

Only use this method if you are implementing custom storage for sections.

Parameters

array $section

An array of section data in the format returned by ::toArray().

Return Value

Section

The section object.

at line 377
__clone()

Magic method: Implements a deep clone.

at line 386
mixed getThirdPartySetting($provider, string $key, mixed $default = NULL)

Gets the value of a third-party setting.

Parameters

$provider
string $key

The setting name.
mixed $default

The default value

Return Value

mixed

The value.

at line 393
array getThirdPartySettings($provider)

Gets all third-party settings of a given module.

Parameters

$provider

Return Value

array

An array of key-value pairs.

at line 400
$this setThirdPartySetting($provider, string $key, mixed $value)

Sets the value of a third-party setting.

Parameters

$provider
string $key

The setting name.
mixed $value

The setting value.

Return Value

$this

at line 408
mixed unsetThirdPartySetting($provider, string $key)

Unsets a third-party setting.

Parameters

$provider
string $key

The setting name.

Return Value

mixed

The value.

at line 421
array getThirdPartyProviders()

Gets the list of third parties that store information.

Return Value

array

The list of third parties.