Spiral\Router\RouteCollection

Complexity

Total Complexity

14

Size/Duplication

Total Lines	87
Duplicated Lines	0 %

Test Coverage

Coverage

75%

Importance

Changes	1
Bugs	0	Features	0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	group()	0	4	2
A	all()	0	3	1
A	getIterator()	0	3	1
A	add()	0	3	1
A	count()	0	3	1
A	__clone()	0	4	2
A	get()	0	3	1
A	addCollection()	0	4	2
A	has()	0	3	1
A	remove()	0	4	2

<?php

declare(strict_types=1);

namespace Spiral\Router;

use Spiral\Router\Loader\Configurator\RouteConfigurator;

class RouteCollection implements \IteratorAggregate, \Countable
{
    /** @var array<string, RouteConfigurator> */
    private array $routes = [];

    public function __clone()
    {
        foreach ($this->routes as $name => $route) {
            $this->routes[$name] = clone $route;
        }
    }

    /**
     * Gets the current RouteCollection as an Iterator that includes all routes.
     *
     * @return \ArrayIterator<string, RouteConfigurator>
     */
    public function getIterator(): \ArrayIterator
    {
        return new \ArrayIterator($this->all());
    }

    /**
     * Gets the number of Routes in this collection.
     */
    public function count(): int
    {
        return \count($this->routes);
    }

    public function add(string $name, RouteConfigurator $route)
    {
        $this->routes[$name] = $route;
    }

    /**
     * Returns all routes in this collection.
     *
     * @return array<string, RouteConfigurator>
     */
    public function all(): array
    {
        return $this->routes;
    }

    /**
     * Gets a route by name.
     */
    public function get(string $name): ?RouteConfigurator
    {
        return $this->routes[$name] ?? null;
    }

    /**
     * Check a route by name.
     */
    public function has(string $name): bool
    {
        return isset($this->routes[$name]);
    }

    /**
     * Removes a route or an array of routes by name from the collection.
     *
     * @param string|string[] $name The route name or an array of route names
     */
    public function remove(string|array $name)
    {
        foreach ((array) $name as $n) {
            unset($this->routes[$n]);
        }
    }

    public function addCollection(self $collection)
    {
        foreach ($collection->all() as $name => $route) {
            $this->routes[$name] = $route;
        }
    }

    /**
     * Adds a specific group to a route.
     */
    public function group(string $group)
    {
        foreach ($this->routes as $route) {
            $route->group($group);
        }
    }
}