class EnhanceEntityRouteSubscriber in Form mode manager 8.2

Listens to the dynamic route event and enhance existing routes.

To provide a more flexible system as possible we need to add some, parameters dynamically onto each entities using form modes to, applies our logic. In the current case Form Mode Manager provide, ability to add more access granularity to `Default` entity routes.

Hierarchy

• class \Drupal\Core\Routing\RouteSubscriberBase implements \Symfony\Component\EventDispatcher\EventSubscriberInterface
  • class \Drupal\form_mode_manager\Routing\EventSubscriber\EnhanceEntityRouteSubscriber

1 string reference to 'EnhanceEntityRouteSubscriber'

form_mode_manager.services.yml in ./form_mode_manager.services.yml

form_mode_manager.services.yml

1 service uses EnhanceEntityRouteSubscriber

form_mode_manager.default_routes_subscriber in ./form_mode_manager.services.yml

Drupal\form_mode_manager\Routing\EventSubscriber\EnhanceEntityRouteSubscriber

File

src/Routing/EventSubscriber/EnhanceEntityRouteSubscriber.php, line 19

Namespace

Drupal\form_mode_manager\Routing\EventSubscriber

class EnhanceEntityRouteSubscriber extends RouteSubscriberBase {

  /**
   * The entity type definitions.
   *
   * @var \Drupal\Core\Entity\EntityTypeInterface
   */
  protected $entityDefinition;

  /**
   * The Routes Manager Plugin.
   *
   * @var \Drupal\form_mode_manager\EntityRoutingMapBase
   */
  protected $entityRoutingDefinition;

  /**
   * The Routes Manager Plugin.
   *
   * @var \Drupal\form_mode_manager\EntityRoutingMapManager
   */
  protected $entityRoutingMap;

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

  /**
   * The entity display repository.
   *
   * @var \Drupal\form_mode_manager\FormModeManagerInterface
   */
  protected $formModeManager;

  /**
   * The route collection to add routes.
   *
   * @var \Symfony\Component\Routing\RouteCollection
   */
  protected $routeCollection;

  /**
   * Constructs a new RouteSubscriber object.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager
   *   The entity type manager.
   * @param \Drupal\form_mode_manager\FormModeManagerInterface $form_mode_manager
   *   The form mode manager.
   * @param \Drupal\form_mode_manager\EntityRoutingMapManager $plugin_routes_manager
   *   Plugin EntityRoutingMap to retrieve entity form operation routes.
   */
  public function __construct(EntityTypeManagerInterface $entity_manager, FormModeManagerInterface $form_mode_manager, EntityRoutingMapManager $plugin_routes_manager) {
    $this->entityTypeManager = $entity_manager;
    $this->formModeManager = $form_mode_manager;
    $this->entityRoutingMap = $plugin_routes_manager;
  }

  /**
   * Add form mode manager requirements to add more access granularity.
   *
   * {@inheritdoc}
   */
  protected function alterRoutes(RouteCollection $collection) {
    $entity_type_ids = array_keys($this->formModeManager
      ->getAllFormModesDefinitions());
    $this->routeCollection = $collection;
    foreach ($entity_type_ids as $entity_type_id) {
      $this->entityDefinition = $this->entityTypeManager
        ->getDefinition($entity_type_id);
      $this->entityRoutingDefinition = $this->entityRoutingMap
        ->createInstance($entity_type_id, [
        'entityTypeId' => $entity_type_id,
      ]);
      $this
        ->enhanceDefaultEntityRoute('add_form');
      $this
        ->enhanceDefaultEntityRoute('edit_form');

      // This operation doesn't exist for unbundled entities.
      if (!empty($this->entityDefinition
        ->getKey('bundle'))) {
        $this
          ->enhanceDefaultEntityRoute('add_page');
      }
    }
  }

  /**
   * Enhance existing route for given operation name.
   *
   * @param string $operation_name
   *   The entity operation name.
   */
  public function enhanceDefaultEntityRoute($operation_name) {
    $entity_add_page = $this->entityRoutingDefinition
      ->getOperation($operation_name);
    if ($entity_add_page && ($route = $this->routeCollection
      ->get($entity_add_page))) {
      $route
        ->setRequirement('_permission', "use {$this->entityDefinition->id()}.default form mode");
      $route
        ->setOption('form_mode_theme', NULL);
      $this->routeCollection
        ->add($entity_add_page, $route);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EnhanceEntityRouteSubscriber::$entityDefinition	protected	property	The entity type definitions.
EnhanceEntityRouteSubscriber::$entityRoutingDefinition	protected	property	The Routes Manager Plugin.
EnhanceEntityRouteSubscriber::$entityRoutingMap	protected	property	The Routes Manager Plugin.
EnhanceEntityRouteSubscriber::$entityTypeManager	protected	property	The entity type manager service.
EnhanceEntityRouteSubscriber::$formModeManager	protected	property	The entity display repository.
EnhanceEntityRouteSubscriber::$routeCollection	protected	property	The route collection to add routes.
EnhanceEntityRouteSubscriber::alterRoutes	protected	function	Add form mode manager requirements to add more access granularity. Overrides RouteSubscriberBase::alterRoutes
EnhanceEntityRouteSubscriber::enhanceDefaultEntityRoute	public	function	Enhance existing route for given operation name.
EnhanceEntityRouteSubscriber::__construct	public	function	Constructs a new RouteSubscriber object.
RouteSubscriberBase::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to.	5
RouteSubscriberBase::onAlterRoutes	public	function	Delegates the route altering to self::alterRoutes().	1