You are here

class RouteProcessorManager in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/RouteProcessor/RouteProcessorManager.php \Drupal\Core\RouteProcessor\RouteProcessorManager

Route processor manager.

Holds an array of route processor objects and uses them to sequentially process an outbound route, in order of processor priority.

Hierarchy

Expanded class hierarchy of RouteProcessorManager

1 file declares its use of RouteProcessorManager
RouteProcessorManagerTest.php in core/tests/Drupal/Tests/Core/RouteProcessor/RouteProcessorManagerTest.php
Contains \Drupal\Tests\Core\RouteProcessor\RouteProcessorManagerTest.
1 string reference to 'RouteProcessorManager'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses RouteProcessorManager
route_processor_manager in core/core.services.yml
Drupal\Core\RouteProcessor\RouteProcessorManager

File

core/lib/Drupal/Core/RouteProcessor/RouteProcessorManager.php, line 19
Contains \Drupal\Core\RouteProcessor\RouteProcessorManager.

Namespace

Drupal\Core\RouteProcessor
View source
class RouteProcessorManager implements OutboundRouteProcessorInterface {

  /**
   * Holds the array of outbound processors to cycle through.
   *
   * @var array
   *   An array whose keys are priorities and whose values are arrays of path
   *   processor objects.
   */
  protected $outboundProcessors = array();

  /**
   * Holds the array of outbound processors, sorted by priority.
   *
   * @var array
   *   An array of path processor objects.
   */
  protected $sortedOutbound = array();

  /**
   * Adds an outbound processor object to the $outboundProcessors property.
   *
   * @param \Drupal\Core\RouteProcessor\OutboundRouteProcessorInterface $processor
   *   The processor object to add.
   * @param int $priority
   *   The priority of the processor being added.
   */
  public function addOutbound(OutboundRouteProcessorInterface $processor, $priority = 0) {
    $this->outboundProcessors[$priority][] = $processor;
    $this->sortedOutbound = array();
  }

  /**
   * {@inheritdoc}
   */
  public function processOutbound($route_name, Route $route, array &$parameters, BubbleableMetadata $bubbleable_metadata = NULL) {
    $processors = $this
      ->getOutbound();
    foreach ($processors as $processor) {
      $processor
        ->processOutbound($route_name, $route, $parameters, $bubbleable_metadata);
    }
  }

  /**
   * Returns the sorted array of outbound processors.
   *
   * @return array
   *   An array of processor objects.
   */
  protected function getOutbound() {
    if (empty($this->sortedOutbound)) {
      $this->sortedOutbound = $this
        ->sortProcessors();
    }
    return $this->sortedOutbound;
  }

  /**
   * Sorts the processors according to priority.
   */
  protected function sortProcessors() {
    $sorted = array();
    krsort($this->outboundProcessors);
    foreach ($this->outboundProcessors as $processors) {
      $sorted = array_merge($sorted, $processors);
    }
    return $sorted;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
RouteProcessorManager::$outboundProcessors protected property Holds the array of outbound processors to cycle through.
RouteProcessorManager::$sortedOutbound protected property Holds the array of outbound processors, sorted by priority.
RouteProcessorManager::addOutbound public function Adds an outbound processor object to the $outboundProcessors property.
RouteProcessorManager::getOutbound protected function Returns the sorted array of outbound processors.
RouteProcessorManager::processOutbound public function Processes the outbound route. Overrides OutboundRouteProcessorInterface::processOutbound
RouteProcessorManager::sortProcessors protected function Sorts the processors according to priority.