You are here

Home » API reference » Drupal 8 » LayoutBuilderContextTrait.php

trait LayoutBuilderContextTrait in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/layout_builder/src/Context/LayoutBuilderContextTrait.php \Drupal\layout_builder\Context\LayoutBuilderContextTrait

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

Hierarchy

3 files declare their use of LayoutBuilderContextTrait
ChooseBlockController.php in core/modules/layout_builder/src/Controller/ChooseBlockController.php
ConfigureBlockFormBase.php in core/modules/layout_builder/src/Form/ConfigureBlockFormBase.php
LayoutBuilder.php in core/modules/layout_builder/src/Element/LayoutBuilder.php

File

core/modules/layout_builder/src/Context/LayoutBuilderContextTrait.php, line 11

Namespace

Drupal\layout_builder\Context
View source 
trait LayoutBuilderContextTrait {

  /**
   * The context repository.
   *
   * @var \Drupal\Core\Plugin\Context\ContextRepositoryInterface
   */
  protected $contextRepository;

  /**
   * Gets the context repository service.
   *
   * @return \Drupal\Core\Plugin\Context\ContextRepositoryInterface
   *   The context repository service.
   */
  protected function contextRepository() {
    if (!$this->contextRepository) {
      $this->contextRepository = \Drupal::service('context.repository');
    }
    return $this->contextRepository;
  }

  /**
   * Provides all available contexts, both global and section_storage-specific.
   *
   * @param \Drupal\layout_builder\SectionStorageInterface $section_storage
   *   The section storage.
   *
   * @return \Drupal\Core\Plugin\Context\ContextInterface[]
   *   The array of context objects.
   */
  protected function getAvailableContexts(SectionStorageInterface $section_storage) {

    // Get all globally available contexts that have a defined value.
    $contexts = array_filter($this
      ->contextRepository()
      ->getAvailableContexts(), function (ContextInterface $context) {
      return $context
        ->hasContextValue();
    });

    // Add in the per-section_storage contexts.
    $contexts += $section_storage
      ->getContextsDuringPreview();
    return $contexts;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
LayoutBuilderContextTrait::$contextRepository protected property The context repository.
LayoutBuilderContextTrait::contextRepository protected function Gets the context repository service.
LayoutBuilderContextTrait::getAvailableContexts protected function Provides all available contexts, both global and section_storage-specific.