1. class
  2. Drupal
  3. \
  4. layout_builder
  5. \
  6. Controller
  7. \
  8. ChooseSectionController

ChooseSectionController

class ChooseSectionController implements ContainerInjectionInterface (View source)

internal  Controller classes are internal.
 

Defines a controller to choose a new section.

Traits

AjaxHelperTrait

Provides a helper to determine if the current request is via AJAX.

LayoutBuilderContextTrait

Provides a wrapper around getting contexts from a section storage object.

LayoutBuilderHighlightTrait

A trait for generating IDs used to highlight active UI elements.

StringTranslationTrait

Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.

Properties

protected ContextRepositoryInterface $contextRepository

The context repository.

 from  LayoutBuilderContextTrait
protected TranslationInterface $stringTranslation

The string translation service.

 from  StringTranslationTrait
protected LayoutPluginManagerInterface $layoutManager

The layout manager.

Methods

bool
isAjax()

Determines if the current request is via AJAX.

from  AjaxHelperTrait
string|null
getRequestWrapperFormat()

Gets the wrapper format of the current request.

from  AjaxHelperTrait
ContextRepositoryInterface
contextRepository()

Gets the context repository service.

from  LayoutBuilderContextTrait
ContextInterface[]
getAvailableContexts(SectionStorageInterface $section_storage) deprecated

Provides all available contexts, both global and section_storage-specific.

from  LayoutBuilderContextTrait
array
getPopulatedContexts(SectionStorageInterface $section_storage)

Returns all populated contexts, both global and section-storage-specific.

from  LayoutBuilderContextTrait
string
blockAddHighlightId(string $delta, string $region)

Provides the ID used to highlight the active Layout Builder UI element.

from  LayoutBuilderHighlightTrait
string
blockUpdateHighlightId(string $uuid)

Provides the ID used to highlight the active Layout Builder UI element.

from  LayoutBuilderHighlightTrait
string
sectionAddHighlightId(string $delta)

Provides the ID used to highlight the active Layout Builder UI element.

from  LayoutBuilderHighlightTrait
string
sectionUpdateHighlightId(string $delta)

Provides the ID used to highlight the active Layout Builder UI element.

from  LayoutBuilderHighlightTrait
TranslatableMarkup
t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

from  StringTranslationTrait
formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

from  StringTranslationTrait
getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

from  StringTranslationTrait
TranslationInterface
getStringTranslation()

Gets the string translation service.

from  StringTranslationTrait
$this
setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

from  StringTranslationTrait
__construct(LayoutPluginManagerInterface $layout_manager)

ChooseSectionController constructor.

static 
create(ContainerInterface $container)

Instantiates a new instance of this class.

array
build(SectionStorageInterface $section_storage, int $delta)

Choose a layout plugin to add as a section.

Details

in AjaxHelperTrait at line 20
protected bool isAjax()

Determines if the current request is via AJAX.

Return Value

bool

TRUE if the current request is via AJAX, FALSE otherwise.

in AjaxHelperTrait at line 33
protected string|null getRequestWrapperFormat()

Gets the wrapper format of the current request.

Return Value

string|null

The wrapper format. NULL if the wrapper format is not set.

in LayoutBuilderContextTrait at line 26
protected ContextRepositoryInterface contextRepository()

Gets the context repository service.

Return Value

ContextRepositoryInterface

The context repository service.

in LayoutBuilderContextTrait at line 48
protected ContextInterface[] getAvailableContexts(SectionStorageInterface $section_storage) deprecated

deprecated in drupal:9.3.0 and is removed from drupal:10.0.0. Use \Drupal\layout_builder\Context\LayoutBuilderContextTrait::getPopulatedContexts() instead.

Provides all available contexts, both global and section_storage-specific.

Parameters

SectionStorageInterface $section_storage

The section storage.

Return Value

ContextInterface[]

The array of context objects.

See also

https://www.drupal.org/node/3195121

in LayoutBuilderContextTrait at line 62
protected array getPopulatedContexts(SectionStorageInterface $section_storage)

Returns all populated contexts, both global and section-storage-specific.

Parameters

SectionStorageInterface $section_storage

The section storage.

Return Value

array

The array of context objects.

in LayoutBuilderHighlightTrait at line 21
protected string blockAddHighlightId(string $delta, string $region)

Provides the ID used to highlight the active Layout Builder UI element.

Parameters

string $delta

The section the block is in.
string $region

The section region in which the block is placed.

Return Value

string

The highlight ID of the block.

in LayoutBuilderHighlightTrait at line 34
protected string blockUpdateHighlightId(string $uuid)

Provides the ID used to highlight the active Layout Builder UI element.

Parameters

string $uuid

The uuid of the block.

Return Value

string

The highlight ID of the block.

in LayoutBuilderHighlightTrait at line 47
protected string sectionAddHighlightId(string $delta)

Provides the ID used to highlight the active Layout Builder UI element.

Parameters

string $delta

The location of the section.

Return Value

string

The highlight ID of the section.

in LayoutBuilderHighlightTrait at line 60
protected string sectionUpdateHighlightId(string $delta)

Provides the ID used to highlight the active Layout Builder UI element.

Parameters

string $delta

The location of the section.

Return Value

string

The highlight ID of the section.

in StringTranslationTrait at line 70
protected TranslatableMarkup t(string $string, array $args = [], array $options = [])

Translates a string to the current language or to a given language.

See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.

In order for strings to be localized, make them available in one of the ways supported by the

Parameters

string $string

A string containing the English text to translate.
array $args

(optional) An associative array of replacements to make after translation. Based on the first character of the key, the value is escaped and/or themed. See \Drupal\Component\Render\FormattableMarkup::placeholderFormat() for details.
array $options

(optional) An associative array of additional options, with the following elements:

  • 'langcode' (defaults to the current language): A language code, to translate to a language other than what is used to display the page.
  • 'context' (defaults to the empty context): The context the source string belongs to. See the @link i18n Internationalization topic @endlink for more information about string contexts.

Return Value

TranslatableMarkup

An object that, when cast to a string, returns the translated string.

See also

FormattableMarkup::placeholderFormat
TranslatableMarkup::__construct

in StringTranslationTrait at line 79
protected formatPlural($count, $singular, $plural, array $args = [], array $options = [])

Formats a string containing a count of items.

Parameters

$count
$singular
$plural
array $args
array $options

See also

TranslationInterface::formatPlural

in StringTranslationTrait at line 88
protected getNumberOfPlurals($langcode = NULL)

Returns the number of plurals supported by a given language.

Parameters

$langcode

See also

PluralFormulaInterface::getNumberOfPlurals

in StringTranslationTrait at line 102
protected TranslationInterface getStringTranslation()

Gets the string translation service.

Return Value

TranslationInterface

The string translation service.

in StringTranslationTrait at line 118
$this setStringTranslation(TranslationInterface $translation)

Sets the string translation service to use.

Parameters

TranslationInterface $translation

The string translation service.

Return Value

$this

at line 42
__construct(LayoutPluginManagerInterface $layout_manager)

ChooseSectionController constructor.

Parameters

LayoutPluginManagerInterface $layout_manager

The layout manager.

at line 49
static create(ContainerInterface $container)

Instantiates a new instance of this class.

This is a factory method that returns a new instance of this class. The factory should pass any needed dependencies into the constructor of this class, but not the container itself. Every call to this method must return a new instance of this class; that is, it may not implement a singleton.

Parameters

ContainerInterface $container

The service container this instance should use.

at line 66
array build(SectionStorageInterface $section_storage, int $delta)

Choose a layout plugin to add as a section.

Parameters

SectionStorageInterface $section_storage

The section storage.
int $delta

The delta of the section to splice.

Return Value

array

The render array.