class RouteSubscriber in Field Group 8.3

Subscriber for Field group routes.

Hierarchy

• class \Drupal\Core\Routing\RouteSubscriberBase implements \Symfony\Component\EventDispatcher\EventSubscriberInterface
  • class \Drupal\field_group\Routing\RouteSubscriber

1 string reference to 'RouteSubscriber'

field_group.services.yml in ./field_group.services.yml

field_group.services.yml

1 service uses RouteSubscriber

field_group.subscriber in ./field_group.services.yml

Drupal\field_group\Routing\RouteSubscriber

File

src/Routing/RouteSubscriber.php, line 14

Namespace

Drupal\field_group\Routing

class RouteSubscriber extends RouteSubscriberBase {

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a RouteSubscriber object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_type_manager) {
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  protected function alterRoutes(RouteCollection $collection) {

    // Create fieldgroup routes for every entity.
    foreach ($this->entityTypeManager
      ->getDefinitions() as $entity_type_id => $entity_type) {
      $defaults = [];
      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();

        // Special parameter used to easily recognize all Field UI routes.
        $options['_field_ui'] = TRUE;
        if (($bundle_entity_type = $entity_type
          ->getBundleEntityType()) && $bundle_entity_type !== 'bundle') {
          $options['parameters'][$entity_type
            ->getBundleEntityType()] = [
            'type' => 'entity:' . $entity_type
              ->getBundleEntityType(),
          ];
        }
        $options['parameters']['field_group'] = [
          'type' => 'field_group',
          'entity_type' => $entity_type
            ->getBundleEntityType(),
        ];
        $defaults_delete = [
          'entity_type_id' => $entity_type_id,
          '_form' => '\\Drupal\\field_group\\Form\\FieldGroupDeleteForm',
        ];
        $defaults_add = [
          'entity_type_id' => $entity_type_id,
          '_form' => '\\Drupal\\field_group\\Form\\FieldGroupAddForm',
          '_title' => 'Add field group',
        ];

        // If the entity type has no bundles and it doesn't use {bundle} in its
        // admin path, use the entity type.
        if (strpos($path, '{bundle}') === FALSE) {
          $defaults_add['bundle'] = !$entity_type
            ->hasKey('bundle') ? $entity_type_id : '';
          $defaults_delete['bundle'] = $defaults_add['bundle'];
        }

        // Routes to delete field groups.
        $route = new Route("{$path}/form-display/{field_group_name}/delete", [
          'context' => 'form',
        ] + $defaults_delete, [
          '_permission' => 'administer ' . $entity_type_id . ' form display',
        ], $options);
        $collection
          ->add("field_ui.field_group_delete_{$entity_type_id}.form_display", $route);
        $route = new Route("{$path}/form-display/{form_mode_name}/{field_group_name}/delete", [
          'context' => 'form',
        ] + $defaults_delete, [
          '_permission' => 'administer ' . $entity_type_id . ' form display',
        ], $options);
        $collection
          ->add("field_ui.field_group_delete_{$entity_type_id}.form_display.form_mode", $route);
        $route = new Route("{$path}/display/{field_group_name}/delete", [
          'context' => 'view',
        ] + $defaults_delete, [
          '_permission' => 'administer ' . $entity_type_id . ' display',
        ], $options);
        $collection
          ->add("field_ui.field_group_delete_{$entity_type_id}.display", $route);
        $route = new Route("{$path}/display/{view_mode_name}/{field_group_name}/delete", [
          'context' => 'view',
        ] + $defaults_delete, [
          '_permission' => 'administer ' . $entity_type_id . ' display',
        ], $options);
        $collection
          ->add("field_ui.field_group_delete_{$entity_type_id}.display.view_mode", $route);

        // Routes to add field groups.
        $route = new Route("{$path}/form-display/add-group", [
          'context' => 'form',
        ] + $defaults_add, [
          '_permission' => 'administer ' . $entity_type_id . ' form display',
        ], $options);
        $collection
          ->add("field_ui.field_group_add_{$entity_type_id}.form_display", $route);
        $route = new Route("{$path}/form-display/{form_mode_name}/add-group", [
          'context' => 'form',
        ] + $defaults_add, [
          '_permission' => 'administer ' . $entity_type_id . ' form display',
        ], $options);
        $collection
          ->add("field_ui.field_group_add_{$entity_type_id}.form_display.form_mode", $route);
        $route = new Route("{$path}/display/add-group", [
          'context' => 'view',
        ] + $defaults_add, [
          '_permission' => 'administer ' . $entity_type_id . ' display',
        ], $options);
        $collection
          ->add("field_ui.field_group_add_{$entity_type_id}.display", $route);
        $route = new Route("{$path}/display/{view_mode_name}/add-group", [
          'context' => 'view',
        ] + $defaults_add, [
          '_permission' => 'administer ' . $entity_type_id . ' display',
        ], $options);
        $collection
          ->add("field_ui.field_group_add_{$entity_type_id}.display.view_mode", $route);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {

    // $events = parent::getSubscribedEvents();
    // Come after field_ui, config_translation.
    $events[RoutingEvents::ALTER] = [
      'onAlterRoutes',
      -210,
    ];
    return $events;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RouteSubscriber::$entityTypeManager	protected	property	The entity type manager.
RouteSubscriber::alterRoutes	protected	function	Alters existing routes for a specific collection. Overrides RouteSubscriberBase::alterRoutes
RouteSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to. Overrides RouteSubscriberBase::getSubscribedEvents
RouteSubscriber::__construct	public	function	Constructs a RouteSubscriber object.
RouteSubscriberBase::onAlterRoutes	public	function	Delegates the route altering to self::alterRoutes().	1