trait LayoutBuilderContextTrait

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

Hierarchy

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

... See full list

File

View on git.drupalcode.org

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;
  }
  
  /**
   * Returns all populated 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 getPopulatedContexts(SectionStorageInterface $section_storage) : array {
    // Get all known globally available contexts IDs.
    $available_context_ids = array_keys($this->contextRepository()
      ->getAvailableContexts());
    // Filter to those that are populated.
    $contexts = array_filter($this->contextRepository()
      ->getRuntimeContexts($available_context_ids), function (ContextInterface $context) {
      return $context->hasContextValue();
    });
    // Add in the per-section_storage contexts.
    $contexts += $section_storage->getContextsDuringPreview();
    return $contexts;
  }

}

Members

Title Modifiers Object type Summary
LayoutBuilderContextTrait::$contextRepository protected property The context repository.
LayoutBuilderContextTrait::contextRepository protected function Gets the context repository service.
LayoutBuilderContextTrait::getPopulatedContexts protected function Returns all populated contexts, both global and section-storage-specific.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.