LayoutSectionStorageParamConverter.php

Same filename and directory in other branches
  1. 10 core/modules/layout_builder/src/Routing/LayoutSectionStorageParamConverter.php
  2. 11.x core/modules/layout_builder/src/Routing/LayoutSectionStorageParamConverter.php

Namespace

Drupal\layout_builder\Routing

File

core/modules/layout_builder/src/Routing/LayoutSectionStorageParamConverter.php

View source
<?php

namespace Drupal\layout_builder\Routing;

use Drupal\Core\ParamConverter\ParamConverterInterface;
use Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface;
use Symfony\Component\Routing\Route;

/**
 * Loads the section storage from the routing defaults.
 *
 * @internal
 *   Tagged services are internal.
 */
class LayoutSectionStorageParamConverter implements ParamConverterInterface {
    
    /**
     * The section storage manager.
     *
     * @var \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface
     */
    protected $sectionStorageManager;
    
    /**
     * Constructs a new LayoutSectionStorageParamConverter.
     *
     * @param \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface $section_storage_manager
     *   The section storage manager.
     */
    public function __construct(SectionStorageManagerInterface $section_storage_manager) {
        $this->sectionStorageManager = $section_storage_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public function convert($value, $definition, $name, array $defaults) {
        // If no section storage type is specified or if it is invalid, return.
        if (!isset($defaults['section_storage_type']) || !$this->sectionStorageManager
            ->hasDefinition($defaults['section_storage_type'])) {
            return NULL;
        }
        $type = $defaults['section_storage_type'];
        // Load an empty instance and derive the available contexts.
        $contexts = $this->sectionStorageManager
            ->loadEmpty($type)
            ->deriveContextsFromRoute($value, $definition, $name, $defaults);
        // Attempt to load a full instance based on the context.
        return $this->sectionStorageManager
            ->load($type, $contexts);
    }
    
    /**
     * {@inheritdoc}
     */
    public function applies($definition, $name, Route $route) {
        return !empty($definition['layout_builder_section_storage']) || !empty($definition['layout_builder_tempstore']);
    }

}

Classes

Title Deprecated Summary
LayoutSectionStorageParamConverter Loads the section storage from the routing defaults.

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