class RouteSubscriber in Transaction 8

Subscriber for transaction routes.

Hierarchy

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

1 string reference to 'RouteSubscriber'

transaction.services.yml in ./transaction.services.yml

transaction.services.yml

1 service uses RouteSubscriber

transaction.route_subscriber in ./transaction.services.yml

Drupal\transaction\Routing\RouteSubscriber

File

src/Routing/RouteSubscriber.php, line 14

Namespace

Drupal\transaction\Routing

class RouteSubscriber extends RouteSubscriberBase {

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

  /**
   * Constructs a new 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) {

    // Add transaction collection route for transaction types with a link
    // template for it.
    foreach ($this->entityTypeManager
      ->getStorage('transaction_type')
      ->loadMultiple() as $transaction_type_id => $transaction_type) {

      /** @var \Drupal\transaction\TransactionTypeInterface $transaction_type */
      if ($route_path = $this->entityTypeManager
        ->getDefinition($target_entity_type_id = $transaction_type
        ->getTargetEntityTypeId())
        ->getLinkTemplate("transaction-{$transaction_type_id}")) {
        $route = new Route($route_path);
        $route
          ->addDefaults([
          '_entity_list' => 'transaction',
          '_title' => 'Transactions',
          '_title_callback' => '\\Drupal\\transaction\\Controller\\TransactionController::transactionCollectionTitle',
        ])
          ->addRequirements([
          '_permission' => "view any {$transaction_type_id} transaction",
          '_entity_access' => "{$target_entity_type_id}.view",
          $target_entity_type_id => '\\d+',
          '_applicable_transaction_type' => 'TRUE',
        ])
          ->setOption('_admin_route', TRUE)
          ->setOption('_transaction_transaction_type_id', $transaction_type_id)
          ->setOption('_transaction_target_entity_type_id', $target_entity_type_id)
          ->setOption('parameters', [
          $target_entity_type_id => [
            'type' => 'entity:' . $target_entity_type_id,
          ],
          'transaction_type' => [
            'type' => 'entity:transaction_type',
          ],
        ]);
        $collection
          ->add("entity.{$target_entity_type_id}.{$transaction_type_id}-transaction", $route);

        // Transaction creation route variant. The name of the target entity
        // parameter must match the target entity id.
        $route = clone $collection
          ->get('entity.transaction.add_form');
        $route
          ->setPath("/transaction/add/{transaction_type}/{target_entity_type}/{{$target_entity_type_id}}")
          ->setOption('_transaction_target_entity_type_id', $target_entity_type_id);
        $route_options = $route
          ->getOptions();
        unset($route_options['parameters']['target_entity']);
        $route_options['parameters'][$target_entity_type_id]['type'] = 'entity:' . $target_entity_type_id;
        $route
          ->setOptions($route_options);
        $route_requirements = $route
          ->getRequirements();
        $route_requirements['_entity_access'] = $target_entity_type_id . '.view';
        $route_requirements[$target_entity_type_id] = '\\d+';
        unset($route_requirements['target_entity']);
        $route
          ->setRequirements($route_requirements);
        $collection
          ->add("entity.transaction.{$target_entity_type_id}.{$transaction_type_id}.add_form", $route);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events = parent::getSubscribedEvents();
    $events[RoutingEvents::ALTER] = [
      'onAlterRoutes',
      100,
    ];
    return $events;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
RouteSubscriber::$entityTypeManager	protected	property	The entity type manager service.
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 new RouteSubscriber object.
RouteSubscriberBase::onAlterRoutes	public	function	Delegates the route altering to self::alterRoutes().	1