class RouteSubscriber in Workflow 8

Subscriber for Workflow routes.

Hierarchy

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

See also

\Drupal\workflow\Plugin\Derivative\WorkflowLocalTask

1 string reference to 'RouteSubscriber'

workflow.services.yml in ./workflow.services.yml

workflow.services.yml

1 service uses RouteSubscriber

workflow.route_subscriber in ./workflow.services.yml

Drupal\workflow\Routing\RouteSubscriber

File

src/Routing/RouteSubscriber.php, line 16

Namespace

Drupal\workflow\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_manager
   *   The entity type manager.
   */
  public function __construct(EntityTypeManagerInterface $entity_manager) {
    $this->entityTypeManager = $entity_manager;
  }

  /**
   * {@inheritdoc}
   */
  protected function alterRoutes(RouteCollection $collection) {
    $field_list = workflow_get_workflow_fields_by_entity_type();
    foreach ($field_list as $entityTypeId => $fields) {

      /*
       * @todo For entities with multiple workflow fields, Create an
       *   Entity workflow field list page and a route
       *   that redirect to the correct page.
       * @todo Routes for multiple workflow fields on 3 different bundles of 1 entity type.
       */

      // Generate route for default field. Redirect to workflow/{field_name}.
      $path = "/{$entityTypeId}/{{$entityTypeId}}/workflow";
      $route = $this
        ->getEntityLoadRoute($entityTypeId, $path);
      $collection
        ->add("entity.{$entityTypeId}.workflow_history", $route);

      // Generate one route for each workflow field.
      foreach ($fields as $field_name => $field) {
        $path = "/{$entityTypeId}/{{$entityTypeId}}/workflow/{$field_name}";
        $route = $this
          ->getEntityLoadRoute($entityTypeId, $path);
        $collection
          ->add("entity.{$entityTypeId}.workflow_history.{$field_name}", $route);
      }
    }
  }

  /**
   * Gets the entity load route.
   *
   * @param string $entityTypeId
   *   The entity type id.
   * @param string $path
   *   The Path of the route.
   *
   * @return \Symfony\Component\Routing\Route|null
   *   The generated route, if available.
   */
  protected function getEntityLoadRoute($entityTypeId, $path) {

    /*
     * @todo Create the Route for taxonomy term like
     * '/taxonomy/term/{taxonomy_term}/workflow/{field_name}'
     *
     */
    $route = new Route($path, [
      '_controller' => '\\Drupal\\workflow\\Controller\\WorkflowTransitionListController::historyOverview',
      '_title' => 'Workflow history',
    ], [
      '_custom_access' => '\\Drupal\\workflow\\Access\\WorkflowHistoryAccess::access',
    ], [
      '_admin_route' => TRUE,
      '_workflow_entity_type_id' => $entityTypeId,
      // @todo Remove this.
      'parameters' => [
        $entityTypeId => [
          'type' => 'entity:' . $entityTypeId,
        ],
      ],
    ]);
    return $route;
  }

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

  /**
   * Get all field of type workflow.
   *
   * @return array
   *   Return all workflow fields.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public function listWorkflowFields() {
    $fieldType = 'workflow';
    $fieldStorageConfigs = $this->entityTypeManager
      ->getStorage('field_storage_config')
      ->loadByProperties([
      'type' => $fieldType,
    ]);
    if (!$fieldStorageConfigs) {
      return [];
    }
    $availableItems = [];
    foreach ($fieldStorageConfigs as $fieldStorage) {
      $availableItems[] = $fieldStorage;
    }
    return $availableItems;
  }

}

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::getEntityLoadRoute	protected	function	Gets the entity load route.
RouteSubscriber::getSubscribedEvents	public static	function	Returns an array of event names this subscriber wants to listen to. Overrides RouteSubscriberBase::getSubscribedEvents
RouteSubscriber::listWorkflowFields	public	function	Get all field of type workflow.
RouteSubscriber::__construct	public	function	Constructs a new RouteSubscriber object.
RouteSubscriberBase::onAlterRoutes	public	function	Delegates the route altering to self::alterRoutes().	1