⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
protected thirdPartySettings -> array (0)
⇄⧉public __construct($layout_id, array $layout_settings = array(), array $components = array(), array $third_party_settings = array()) Constructs a new Section.
/**
* Constructs a new Section.
*
* @param string $layout_id
* The layout plugin ID.
* @param array $layout_settings
* (optional) The layout plugin settings.
* @param \Drupal\layout_builder\SectionComponent[] $components
* (optional) The components.
* @param array[] $third_party_settings
* (optional) Any third party settings.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:65
⇄⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this section.
/**
* Returns the renderable array for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the section is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the section.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:85
⇄⧉public getLayout(array $contexts = array()): \Drupal\Core\Layout\LayoutInterface Gets the layout plugin for this section.
/**
* Gets the layout plugin for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
*
* @return \Drupal\Core\Layout\LayoutInterface
* The layout plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:115
⇄⧉public getLayoutId(): string Gets the layout plugin ID for this section.
/**
* Gets the layout plugin ID for this section.
*
* @return string
* The layout plugin ID.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:132
⇄⧉public getLayoutSettings(): mixed[] Gets the layout plugin settings for this section.
/**
* Gets the layout plugin settings for this section.
*
* @return mixed[]
* The layout plugin settings.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:145
⇄⧉public setLayoutSettings(array $layout_settings): $this Sets the layout plugin settings for this section.
/**
* Sets the layout plugin settings for this section.
*
* @param mixed[] $layout_settings
* The layout plugin settings.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:157
⇄⧉public getDefaultRegion(): string Gets the default region.
/**
* Gets the default region.
*
* @return string
* The machine-readable name of the default region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:168
⇄⧉public getComponents(): \Drupal\layout_builder\SectionComponent[] Returns the components of the section.
/**
* Returns the components of the section.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components, keyed by the component UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:178
⇄⧉public getComponent($uuid): \Drupal\layout_builder\SectionComponent Gets the component for a given UUID.
/**
* Gets the component for a given UUID.
*
* @param string $uuid
* The UUID of the component to retrieve.
*
* @return \Drupal\layout_builder\SectionComponent
* The component.
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:194
⇄⧉public removeComponent($uuid): $this Removes a given component from a region.
/**
* Removes a given component from a region.
*
* @param string $uuid
* The UUID of the component to remove.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:223
⇄⧉public appendComponent(Drupal\layout_builder\SectionComponent $component): $this Appends a component to the end of a region.
/**
* Appends a component to the end of a region.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component being appended.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:236
⇄⧉public getComponentsByRegion($region): \Drupal\layout_builder\SectionComponent[] Gets the components for a specific region.
/**
* Gets the components for a specific region.
*
* @param string $region
* The region name.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components in the specified region, sorted by weight.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:268
⇄⧉public insertAfterComponent($preceding_uuid, Drupal\layout_builder\SectionComponent $component): $this Inserts a component after a specified existing component.
/**
* Inserts a component after a specified existing component.
*
* @param string $preceding_uuid
* The UUID of the existing component to insert after.
* @param \Drupal\layout_builder\SectionComponent $component
* The component being inserted.
*
* @return $this
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:291
⇄⧉public insertComponent($delta, Drupal\layout_builder\SectionComponent $new_component): $this Inserts a component at a specified delta.
/**
* Inserts a component at a specified delta.
*
* @param int $delta
* The zero-based delta in which to insert the component.
* @param \Drupal\layout_builder\SectionComponent $new_component
* The component being inserted.
*
* @return $this
*
* @throws \OutOfBoundsException
* Thrown when the specified delta is invalid.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:314
⇄⧉public toArray(): array Returns an array representation of the section.
/**
* Returns an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:355
⇄⧉public __clone() Magic method: Implements a deep clone.
clone $0['layout_builder__layout'][0]['section']
/**
* Magic method: Implements a deep clone.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:396
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:440
⧉protected setComponent(Drupal\layout_builder\SectionComponent $component): $this Helper method to set a component.
/**
* Helper method to set a component.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:210
⧉protected getNextHighestWeight($region): int Returns the next highest weight of the component in a region.
/**
* Returns the next highest weight of the component in a region.
*
* @param string $region
* The region name.
*
* @return int
* A number higher than the highest weight of the component in the region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:251
⧉protected layoutPluginManager(): \Drupal\Core\Layout\LayoutPluginManagerInterface Wraps the layout plugin manager.
/**
* Wraps the layout plugin manager.
*
* @return \Drupal\Core\Layout\LayoutPluginManagerInterface
* The layout plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:343
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:450
⇄⧉public static fromArray(array $section): static Creates an object from an array representation of the section.
/**
* Creates an object from an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $section
* An array of section data in the format returned by ::toArray().
*
* @return static
* The section object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:377
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
views_label => string (22) "Stories From The Field"
items_per_page => string (1) "6"
context_mapping => array (0)
protected weight -> string (1) "3"
protected additional -> array (0)
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
⧉public __construct($uuid, $region, array $configuration = array(), array $additional = array()) Constructs a new SectionComponent.
/**
* Constructs a new SectionComponent.
*
* @param string $uuid
* The UUID.
* @param string $region
* The region.
* @param mixed[] $configuration
* The plugin configuration.
* @param mixed[] $additional
* An additional values.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:70
⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this component.
/**
* Returns the renderable array for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the component is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:88
⧉public get($property): mixed Gets any arbitrary property for the component.
/**
* Gets any arbitrary property for the component.
*
* @param string $property
* The property to retrieve.
*
* @return mixed
* The value for that property, or NULL if the property does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:105
⧉public set($property, $value): $this Sets a value to an arbitrary property for the component.
/**
* Sets a value to an arbitrary property for the component.
*
* @param string $property
* The property to use for the value.
* @param mixed $value
* The value to set.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:125
⧉public getRegion(): string Gets the region for the component.
/**
* Gets the region for the component.
*
* @return string
* The region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:141
⧉public setRegion($region): $this Sets the region for the component.
/**
* Sets the region for the component.
*
* @param string $region
* The region.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:153
⧉public getWeight(): int Gets the weight of the component.
/**
* Gets the weight of the component.
*
* @return int
* The zero-based weight of the component.
*
* @throws \UnexpectedValueException
* Thrown if the weight was never set.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:167
⧉public setWeight($weight): $this Sets the weight of the component.
/**
* Sets the weight of the component.
*
* @param int $weight
* The zero-based weight of the component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:179
⧉public setConfiguration(array $configuration): $this Sets the plugin configuration.
/**
* Sets the plugin configuration.
*
* @param mixed[] $configuration
* The plugin configuration.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:202
⧉public getPluginId(): string Gets the plugin ID.
/**
* Gets the plugin ID.
*
* @return string
* The plugin ID.
*
* @throws \Drupal\Component\Plugin\Exception\PluginException
* Thrown if the plugin ID cannot be found.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:216
⧉public getUuid(): string Gets the UUID for this component.
/**
* Gets the UUID for this component.
*
* @return string
* The UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:229
⧉public getPlugin(array $contexts = array()): \Drupal\Component\Plugin\PluginInspectionInterface Gets the plugin for this component.
/**
* Gets the plugin for this component.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of contexts to set on the plugin.
*
* @return \Drupal\Component\Plugin\PluginInspectionInterface
* The plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:242
⧉public toArray(): array Returns an array representation of the section component.
/**
* Returns an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:290
⧉protected getConfiguration(): mixed[] Gets the component plugin configuration.
/**
* Gets the component plugin configuration.
*
* @return mixed[]
* The component plugin configuration.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:190
⧉protected pluginManager(): \Drupal\Core\Block\BlockManagerInterface Wraps the component plugin manager.
/**
* Wraps the component plugin manager.
*
* @return \Drupal\Core\Block\BlockManagerInterface
* The plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:256
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:268
⧉protected eventDispatcher(): \Symfony\Contracts\EventDispatcher\EventDispatcherInterface Wraps the event dispatcher.
/**
* Wraps the event dispatcher.
*
* @return \Symfony\Contracts\EventDispatcher\EventDispatcherInterface
* The event dispatcher.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:278
⇄⧉public static fromArray(array $component): static Creates an object from an array representation of the section component.
/**
* Creates an object from an array representation of the section component.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $component
* An array of section component data in the format returned by ::toArray().
*
* @return static
* The section component object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/SectionComponent.php:311
protected thirdPartySettings -> array (0)
⇄⧉public __construct($layout_id, array $layout_settings = array(), array $components = array(), array $third_party_settings = array()) Constructs a new Section.
/**
* Constructs a new Section.
*
* @param string $layout_id
* The layout plugin ID.
* @param array $layout_settings
* (optional) The layout plugin settings.
* @param \Drupal\layout_builder\SectionComponent[] $components
* (optional) The components.
* @param array[] $third_party_settings
* (optional) Any third party settings.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:65
⇄⧉public toRenderArray(array $contexts = array(), $in_preview = false): array Returns the renderable array for this section.
/**
* Returns the renderable array for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
* @param bool $in_preview
* TRUE if the section is being previewed, FALSE otherwise.
*
* @return array
* A renderable array representing the content of the section.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:85
⇄⧉public getLayout(array $contexts = array()): \Drupal\Core\Layout\LayoutInterface Gets the layout plugin for this section.
/**
* Gets the layout plugin for this section.
*
* @param \Drupal\Core\Plugin\Context\ContextInterface[] $contexts
* An array of available contexts.
*
* @return \Drupal\Core\Layout\LayoutInterface
* The layout plugin.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:115
⇄⧉public getLayoutId(): string Gets the layout plugin ID for this section.
/**
* Gets the layout plugin ID for this section.
*
* @return string
* The layout plugin ID.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:132
⇄⧉public getLayoutSettings(): mixed[] Gets the layout plugin settings for this section.
/**
* Gets the layout plugin settings for this section.
*
* @return mixed[]
* The layout plugin settings.
*
* @internal
* This method should only be used by code responsible for storing the data.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:145
⇄⧉public setLayoutSettings(array $layout_settings): $this Sets the layout plugin settings for this section.
/**
* Sets the layout plugin settings for this section.
*
* @param mixed[] $layout_settings
* The layout plugin settings.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:157
⇄⧉public getDefaultRegion(): string Gets the default region.
/**
* Gets the default region.
*
* @return string
* The machine-readable name of the default region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:168
⇄⧉public getComponents(): \Drupal\layout_builder\SectionComponent[] Returns the components of the section.
/**
* Returns the components of the section.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components, keyed by the component UUID.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:178
⇄⧉public getComponent($uuid): \Drupal\layout_builder\SectionComponent Gets the component for a given UUID.
/**
* Gets the component for a given UUID.
*
* @param string $uuid
* The UUID of the component to retrieve.
*
* @return \Drupal\layout_builder\SectionComponent
* The component.
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:194
⇄⧉public removeComponent($uuid): $this Removes a given component from a region.
/**
* Removes a given component from a region.
*
* @param string $uuid
* The UUID of the component to remove.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:223
⇄⧉public appendComponent(Drupal\layout_builder\SectionComponent $component): $this Appends a component to the end of a region.
/**
* Appends a component to the end of a region.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component being appended.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:236
⇄⧉public getComponentsByRegion($region): \Drupal\layout_builder\SectionComponent[] Gets the components for a specific region.
/**
* Gets the components for a specific region.
*
* @param string $region
* The region name.
*
* @return \Drupal\layout_builder\SectionComponent[]
* An array of components in the specified region, sorted by weight.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:268
⇄⧉public insertAfterComponent($preceding_uuid, Drupal\layout_builder\SectionComponent $component): $this Inserts a component after a specified existing component.
/**
* Inserts a component after a specified existing component.
*
* @param string $preceding_uuid
* The UUID of the existing component to insert after.
* @param \Drupal\layout_builder\SectionComponent $component
* The component being inserted.
*
* @return $this
*
* @throws \InvalidArgumentException
* Thrown when the expected UUID does not exist.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:291
⇄⧉public insertComponent($delta, Drupal\layout_builder\SectionComponent $new_component): $this Inserts a component at a specified delta.
/**
* Inserts a component at a specified delta.
*
* @param int $delta
* The zero-based delta in which to insert the component.
* @param \Drupal\layout_builder\SectionComponent $new_component
* The component being inserted.
*
* @return $this
*
* @throws \OutOfBoundsException
* Thrown when the specified delta is invalid.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:314
⇄⧉public toArray(): array Returns an array representation of the section.
/**
* Returns an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @return array
* An array representation of the section component.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:355
⇄⧉public __clone() Magic method: Implements a deep clone.
clone $0['layout_builder__layout'][1]['section']
/**
* Magic method: Implements a deep clone.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:396
/**
* {@inheritdoc}
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:440
⧉protected setComponent(Drupal\layout_builder\SectionComponent $component): $this Helper method to set a component.
/**
* Helper method to set a component.
*
* @param \Drupal\layout_builder\SectionComponent $component
* The component.
*
* @return $this
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:210
⧉protected getNextHighestWeight($region): int Returns the next highest weight of the component in a region.
/**
* Returns the next highest weight of the component in a region.
*
* @param string $region
* The region name.
*
* @return int
* A number higher than the highest weight of the component in the region.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:251
⧉protected layoutPluginManager(): \Drupal\Core\Layout\LayoutPluginManagerInterface Wraps the layout plugin manager.
/**
* Wraps the layout plugin manager.
*
* @return \Drupal\Core\Layout\LayoutPluginManagerInterface
* The layout plugin manager.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:343
⧉protected contextHandler(): \Drupal\Core\Plugin\Context\ContextHandlerInterface Wraps the context handler.
/**
* Wraps the context handler.
*
* @return \Drupal\Core\Plugin\Context\ContextHandlerInterface
* The context handler.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:450
⇄⧉public static fromArray(array $section): static Creates an object from an array representation of the section.
/**
* Creates an object from an array representation of the section.
*
* Only use this method if you are implementing custom storage for sections.
*
* @param array $section
* An array of section data in the format returned by ::toArray().
*
* @return static
* The section object.
*/
Defined in <ROOT>/core/modules/layout_builder/src/Section.php:377
Donate today
Just £7 can help provide a week of hot meals for a child, and demonstrate the love of Jesus.
Can supply a family in crisis with a hygiene kit, restoring dignity and showing that the Lord has not forgotten them.
Can give a dairy goat to a family in poverty, along with training to care for them, providing an income to buy food, clothes, and other essentials.
A gift of just £7 over 12 months can help us provide life-saving medical care in the wake of a crisis.
Over a year, a monthly gift of £18 can provide up to six families with tarpaulin, a practical and important relief tool for emergency shelter.
£50 a month for a year could provide eight families with a BioSand water filter, gifting them with life-saving clean water.