trait LayoutBuilderContextTrait in Drupal 9
Same name and namespace in other branches
- 8 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
- trait \Drupal\layout_builder\Context\LayoutBuilderContextTrait
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 
File
- core/modules/ layout_builder/ src/ Context/ LayoutBuilderContextTrait.php, line 11 
Namespace
Drupal\layout_builder\ContextView 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.
   *
   * @deprecated in drupal:9.3.0 and is removed from drupal:10.0.0. Use
   *   \Drupal\layout_builder\Context\LayoutBuilderContextTrait::getPopulatedContexts()
   *   instead.
   *
   * @see https://www.drupal.org/node/3195121
   */
  protected function getAvailableContexts(SectionStorageInterface $section_storage) {
    @trigger_error('\\Drupal\\layout_builder\\Context\\LayoutBuilderContextTrait::getAvailableContexts() is deprecated in drupal:9.3.0 and is removed from drupal:10.0.0. Use \\Drupal\\layout_builder\\Context\\LayoutBuilderContextTrait::getPopulatedContexts() instead. See https://www.drupal.org/node/3195121', E_USER_DEPRECATED);
    return self::getPopulatedContexts($section_storage);
  }
  /**
   * 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
| Name   | Modifiers | Type | Description | Overrides | 
|---|---|---|---|---|
| LayoutBuilderContextTrait:: | protected | property | The context repository. | |
| LayoutBuilderContextTrait:: | protected | function | Gets the context repository service. | |
| LayoutBuilderContextTrait:: | protected | function | Provides all available contexts, both global and section_storage-specific. | |
| LayoutBuilderContextTrait:: | protected | function | Returns all populated contexts, both global and section-storage-specific. | 
