Dash\RouteCollection\LazyRouteCollection

Complexity

Total Complexity

12

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	4
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
B	__construct()	0	24	5
A	get()	0	8	2
A	getIterator()	0	6	2
A	getInstance()	0	13	3

<?php
/**
 * Dash
 *
 * @link      http://github.com/DASPRiD/Dash For the canonical source repository
 * @copyright 2013-2015 Ben Scholzen 'DASPRiD'
 * @license   http://opensource.org/licenses/BSD-2-Clause Simplified BSD License
 */

namespace Dash\RouteCollection;

use Dash\Exception;
use Dash\Route\RouteInterface;
use Dash\Route\RouteManager;
use IteratorAggregate;

/**
 * Lazy route collection which only instantiates routes when required.
 */
class LazyRouteCollection implements IteratorAggregate, RouteCollectionInterface
{
    /**
     * @var RouteManager
     */
    protected $routeManager;

    /**
     * @var array
     */
    protected $routes = [];

    /**
     * @param RouteManager $routeManager
     * @param array[]      $routes
     */
    public function __construct(RouteManager $routeManager, array $routes)
    {
        $this->routeManager = $routeManager;
        $serial = 0;

        foreach ($routes as $name => $route) {
            if (!is_array($route)) {
                throw new Exception\UnexpectedValueException(sprintf(
                    'Route definition must be an array, %s given',
                    is_object($route) ? get_class($route) : gettype($route)
                ));
            }

            $this->routes[$name] = [
                'priority' => isset($route['priority']) ? $route['priority'] : 1,
                'serial'   => ++$serial,
                'options'  => $route,
                'instance' => null,
            ];
        }

        // Note: the order of the elements in the array is important for the sorting to work, do not change it!
        arsort($this->routes);
    }

    /**
     * {@inheritdoc}
     */
    public function get($name)
    {
        if (!isset($this->routes[$name])) {
            throw new Exception\OutOfBoundsException(sprintf('Route with name "%s" was not found', $name));
        }

        return $this->getInstance($name);
    }

    /**
     * {@inheritdoc}
     */
    public function getIterator()
    {
        foreach ($this->routes as $name => $route) {
            yield $name => $this->getInstance($name);
        }
    }

    /**
     * Returns an instance of a given route.
     *
     * We do not validate the existence of the route here again, as it is supposed to be checked by the calling method.
     *
     * @param  string $name
     * @return RouteInterface
     */
    protected function getInstance($name)
    {
        $route = &$this->routes[$name];

        if (null === $route['instance']) {
            $route['instance'] = $this->routeManager->build(
                !isset($route['options']['type']) ? 'Generic' : $route['options']['type'],
                $route['options']
            );
        }

        return $route['instance'];
    }
}