RouteSubscriber.php

Same filename in this branch
  1. 11.x core/modules/media/tests/modules/media_test_embed/src/Routing/RouteSubscriber.php
  2. 11.x core/modules/config_translation/src/Routing/RouteSubscriber.php
  3. 11.x core/modules/media_library/src/Routing/RouteSubscriber.php
  4. 11.x core/modules/node/src/Routing/RouteSubscriber.php
  5. 11.x core/modules/views/src/EventSubscriber/RouteSubscriber.php
  6. 11.x core/modules/block_content/src/Routing/RouteSubscriber.php
Same filename and directory in other branches
  1. 9 core/modules/media/tests/modules/media_test_embed/src/Routing/RouteSubscriber.php
  2. 9 core/modules/config_translation/src/Routing/RouteSubscriber.php
  3. 9 core/modules/media_library/src/Routing/RouteSubscriber.php
  4. 9 core/modules/node/src/Routing/RouteSubscriber.php
  5. 9 core/modules/views/src/EventSubscriber/RouteSubscriber.php
  6. 9 core/modules/field_ui/src/Routing/RouteSubscriber.php
  7. 8.9.x core/modules/media/tests/modules/media_test_ckeditor/src/Routing/RouteSubscriber.php
  8. 8.9.x core/modules/config_translation/src/Routing/RouteSubscriber.php
  9. 8.9.x core/modules/media_library/src/Routing/RouteSubscriber.php
  10. 8.9.x core/modules/node/src/Routing/RouteSubscriber.php
  11. 8.9.x core/modules/views/src/EventSubscriber/RouteSubscriber.php
  12. 8.9.x core/modules/field_ui/src/Routing/RouteSubscriber.php
  13. 8.9.x core/modules/path/src/Routing/RouteSubscriber.php
  14. 10 core/modules/media/tests/modules/media_test_embed/src/Routing/RouteSubscriber.php
  15. 10 core/modules/config_translation/src/Routing/RouteSubscriber.php
  16. 10 core/modules/media_library/src/Routing/RouteSubscriber.php
  17. 10 core/modules/node/src/Routing/RouteSubscriber.php
  18. 10 core/modules/views/src/EventSubscriber/RouteSubscriber.php
  19. 10 core/modules/field_ui/src/Routing/RouteSubscriber.php
  20. 10 core/modules/block_content/src/Routing/RouteSubscriber.php

Namespace

Drupal\field_ui\Routing

File

core/modules/field_ui/src/Routing/RouteSubscriber.php

View source
<?php

namespace Drupal\field_ui\Routing;

use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Routing\RouteSubscriberBase;
use Drupal\Core\Routing\RoutingEvents;
use Drupal\field_ui\Controller\FieldConfigAddController;
use Symfony\Component\Routing\Route;
use Symfony\Component\Routing\RouteCollection;

/**
 * Subscriber for Field UI routes.
 */
class RouteSubscriber extends RouteSubscriberBase {
    
    /**
     * The entity type manager service.
     *
     * @var \Drupal\Core\Entity\EntityTypeManagerInterface
     */
    protected $entityTypeManager;
    
    /**
     * Constructs a RouteSubscriber object.
     *
     * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
     *   The entity type manager service.
     */
    public function __construct(EntityTypeManagerInterface $entity_type_manager) {
        $this->entityTypeManager = $entity_type_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function alterRoutes(RouteCollection $collection) {
        foreach ($this->entityTypeManager
            ->getDefinitions() as $entity_type_id => $entity_type) {
            if ($route_name = $entity_type->get('field_ui_base_route')) {
                // Try to get the route from the current collection.
                if (!($entity_route = $collection->get($route_name))) {
                    continue;
                }
                $path = $entity_route->getPath();
                $options = $entity_route->getOptions();
                if ($bundle_entity_type = $entity_type->getBundleEntityType()) {
                    $options['parameters'][$bundle_entity_type] = [
                        'type' => 'entity:' . $bundle_entity_type,
                    ];
                }
                // Special parameter used to easily recognize all Field UI routes.
                $options['_field_ui'] = TRUE;
                $defaults = [
                    'entity_type_id' => $entity_type_id,
                ];
                // If the entity type has no bundles and it doesn't use {bundle} in its
                // admin path, use the entity type.
                if (!str_contains($path, '{bundle}')) {
                    $defaults['bundle'] = !$entity_type->hasKey('bundle') ? $entity_type_id : '';
                }
                $route = new Route("{$path}/fields/{field_config}", [
                    '_entity_form' => 'field_config.edit',
                    '_title_callback' => '\\Drupal\\field_ui\\Form\\FieldConfigEditForm::getTitle',
                ] + $defaults, [
                    '_entity_access' => 'field_config.update',
                ], $options);
                $collection->add("entity.field_config.{$entity_type_id}_field_edit_form", $route);
                $route = new Route("{$path}/fields/{field_config}/delete", [
                    '_entity_form' => 'field_config.delete',
                ] + $defaults, [
                    '_entity_access' => 'field_config.delete',
                ], $options);
                $collection->add("entity.field_config.{$entity_type_id}_field_delete_form", $route);
                $route = new Route("{$path}/fields", [
                    '_controller' => '\\Drupal\\field_ui\\Controller\\FieldConfigListController::listing',
                    '_title' => 'Manage fields',
                ] + $defaults, [
                    '_permission' => 'administer ' . $entity_type_id . ' fields',
                ], $options);
                $collection->add("entity.{$entity_type_id}.field_ui_fields", $route);
                $route = new Route("{$path}/fields/add-field", [
                    '_form' => '\\Drupal\\field_ui\\Form\\FieldStorageAddForm',
                    '_title' => 'Add field',
                ] + $defaults, [
                    '_permission' => 'administer ' . $entity_type_id . ' fields',
                ], $options);
                $collection->add("field_ui.field_storage_config_add_{$entity_type_id}", $route);
                $route = new Route("{$path}/add-field/{entity_type}/{field_name}", [
                    '_controller' => FieldConfigAddController::class . '::fieldConfigAddConfigureForm',
                    '_title' => 'Add field',
                ] + $defaults, [
                    '_permission' => 'administer ' . $entity_type_id . ' fields',
                ], $options);
                $collection->add("field_ui.field_add_{$entity_type_id}", $route);
                $route = new Route("{$path}/fields/reuse", [
                    '_form' => '\\Drupal\\field_ui\\Form\\FieldStorageReuseForm',
                    '_title' => 'Re-use an existing field',
                ] + $defaults, [
                    '_field_ui_field_reuse_access' => 'administer ' . $entity_type_id . ' fields',
                ], $options);
                $collection->add("field_ui.field_storage_config_reuse_{$entity_type_id}", $route);
                $route = new Route("{$path}/form-display", [
                    '_entity_form' => 'entity_form_display.edit',
                    '_title' => 'Manage form display',
                    'form_mode_name' => 'default',
                ] + $defaults, [
                    '_field_ui_form_mode_access' => 'administer ' . $entity_type_id . ' form display',
                ], $options);
                $collection->add("entity.entity_form_display.{$entity_type_id}.default", $route);
                $route = new Route("{$path}/form-display/{form_mode_name}", [
                    '_entity_form' => 'entity_form_display.edit',
                    '_title' => 'Manage form display',
                ] + $defaults, [
                    '_field_ui_form_mode_access' => 'administer ' . $entity_type_id . ' form display',
                ], $options);
                $collection->add("entity.entity_form_display.{$entity_type_id}.form_mode", $route);
                $route = new Route("{$path}/display", [
                    '_entity_form' => 'entity_view_display.edit',
                    '_title' => 'Manage display',
                    'view_mode_name' => 'default',
                ] + $defaults, [
                    '_field_ui_view_mode_access' => 'administer ' . $entity_type_id . ' display',
                ], $options);
                $collection->add("entity.entity_view_display.{$entity_type_id}.default", $route);
                $route = new Route("{$path}/display/{view_mode_name}", [
                    '_entity_form' => 'entity_view_display.edit',
                    '_title' => 'Manage display',
                ] + $defaults, [
                    '_field_ui_view_mode_access' => 'administer ' . $entity_type_id . ' display',
                ], $options);
                $collection->add("entity.entity_view_display.{$entity_type_id}.view_mode", $route);
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents() : array {
        $events = parent::getSubscribedEvents();
        $events[RoutingEvents::ALTER] = [
            'onAlterRoutes',
            -100,
        ];
        return $events;
    }

}

Classes

Title Deprecated Summary
RouteSubscriber Subscriber for Field UI routes.

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