Chris@14: <?php
Chris@14: 
Chris@14: namespace Drupal\layout_builder\Routing;
Chris@14: 
Chris@14: use Drupal\Component\Utility\NestedArray;
Chris@14: use Drupal\layout_builder\OverridesSectionStorageInterface;
Chris@14: use Drupal\layout_builder\SectionStorage\SectionStorageDefinition;
Chris@14: use Symfony\Component\Routing\Route;
Chris@14: use Symfony\Component\Routing\RouteCollection;
Chris@14: 
Chris@14: /**
Chris@14:  * Provides a trait for building routes for a Layout Builder UI.
Chris@14:  *
Chris@14:  * @internal
Chris@14:  *   Layout Builder is currently experimental and should only be leveraged by
Chris@14:  *   experimental modules and development releases of contributed modules.
Chris@14:  *   See https://www.drupal.org/core/experimental for more information.
Chris@14:  */
Chris@14: trait LayoutBuilderRoutesTrait {
Chris@14: 
Chris@14:   /**
Chris@14:    * Builds the layout routes for the given values.
Chris@14:    *
Chris@14:    * @param \Symfony\Component\Routing\RouteCollection $collection
Chris@14:    *   The route collection.
Chris@14:    * @param \Drupal\layout_builder\SectionStorage\SectionStorageDefinition $definition
Chris@14:    *   The definition of the section storage.
Chris@14:    * @param string $path
Chris@14:    *   The path patten for the routes.
Chris@14:    * @param array $defaults
Chris@14:    *   (optional) An array of default parameter values.
Chris@14:    * @param array $requirements
Chris@14:    *   (optional) An array of requirements for parameters.
Chris@14:    * @param array $options
Chris@14:    *   (optional) An array of options.
Chris@14:    * @param string $route_name_prefix
Chris@14:    *   (optional) The prefix to use for the route name.
Chris@14:    */
Chris@14:   protected function buildLayoutRoutes(RouteCollection $collection, SectionStorageDefinition $definition, $path, array $defaults = [], array $requirements = [], array $options = [], $route_name_prefix = '') {
Chris@14:     $type = $definition->id();
Chris@14:     $defaults['section_storage_type'] = $type;
Chris@14:     // Provide an empty value to allow the section storage to be upcast.
Chris@14:     $defaults['section_storage'] = '';
Chris@14:     // Trigger the layout builder access check.
Chris@14:     $requirements['_has_layout_section'] = 'true';
Chris@14:     // Trigger the layout builder RouteEnhancer.
Chris@14:     $options['_layout_builder'] = TRUE;
Chris@14:     // Trigger the layout builder param converter.
Chris@14:     $parameters['section_storage']['layout_builder_tempstore'] = TRUE;
Chris@14:     // Merge the passed in options in after Layout Builder's parameters.
Chris@14:     $options = NestedArray::mergeDeep(['parameters' => $parameters], $options);
Chris@14: 
Chris@14:     if ($route_name_prefix) {
Chris@14:       $route_name_prefix = "layout_builder.$type.$route_name_prefix";
Chris@14:     }
Chris@14:     else {
Chris@14:       $route_name_prefix = "layout_builder.$type";
Chris@14:     }
Chris@14: 
Chris@14:     $main_defaults = $defaults;
Chris@14:     $main_defaults['is_rebuilding'] = FALSE;
Chris@14:     $main_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::layout';
Chris@14:     $main_defaults['_title_callback'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::title';
Chris@14:     $route = (new Route($path))
Chris@14:       ->setDefaults($main_defaults)
Chris@14:       ->setRequirements($requirements)
Chris@14:       ->setOptions($options);
Chris@14:     $collection->add("$route_name_prefix.view", $route);
Chris@14: 
Chris@14:     $save_defaults = $defaults;
Chris@14:     $save_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::saveLayout';
Chris@14:     $route = (new Route("$path/save"))
Chris@14:       ->setDefaults($save_defaults)
Chris@14:       ->setRequirements($requirements)
Chris@14:       ->setOptions($options);
Chris@14:     $collection->add("$route_name_prefix.save", $route);
Chris@14: 
Chris@14:     $cancel_defaults = $defaults;
Chris@14:     $cancel_defaults['_controller'] = '\Drupal\layout_builder\Controller\LayoutBuilderController::cancelLayout';
Chris@14:     $route = (new Route("$path/cancel"))
Chris@14:       ->setDefaults($cancel_defaults)
Chris@14:       ->setRequirements($requirements)
Chris@14:       ->setOptions($options);
Chris@14:     $collection->add("$route_name_prefix.cancel", $route);
Chris@14: 
Chris@14:     if (is_subclass_of($definition->getClass(), OverridesSectionStorageInterface::class)) {
Chris@14:       $revert_defaults = $defaults;
Chris@14:       $revert_defaults['_form'] = '\Drupal\layout_builder\Form\RevertOverridesForm';
Chris@14:       $route = (new Route("$path/revert"))
Chris@14:         ->setDefaults($revert_defaults)
Chris@14:         ->setRequirements($requirements)
Chris@14:         ->setOptions($options);
Chris@14:       $collection->add("$route_name_prefix.revert", $route);
Chris@14:     }
Chris@14:   }
Chris@14: 
Chris@14: }