<?php

/*
 * This file is part of Chevere.
 *
 * (c) Rodolfo Berrios <rodolfo@chevere.org>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Chevere\Router\Interfaces;

/**
 * Describes the component in charge of indexing named routes.
 */
interface IndexInterface
{
    /**
     * Return an instance with the specified `$route` added.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified `$route` added.
     */
    public function withRoute(RouteInterface $route, string $group): self;

    /**
     * Indicates whether the instance has a route identified by its `$name`.
     */
    public function hasRouteName(string $name): bool;

    /**
     * Returns the route identifier for the given route `$name`.
     */
    public function getRouteIdentifier(string $name): IdentifierInterface;

    /**
     * Indicates whether the instance has routes for the given `$group`.
     */
    public function hasGroup(string $group): bool;

    /**
     * Returns an array containing the route names for the given `$group`.
     *
     * @return array<string>
     */
    public function getGroupRouteNames(string $group): array;

    /**
     * Returns the route group for the route identified by its `$name`.
     */
    public function getRouteGroup(string $name): string;

    /**
     * @return array<string, array<string, string>>
     */
    public function toArray(): array;
}