chevere/chevere

<?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\ClassMap\Interfaces;

use Chevere\DataStructure\Interfaces\MappedInterface;
use Chevere\Throwable\Exceptions\ClassNotExistsException;
use Chevere\Throwable\Exceptions\OutOfBoundsException;
use Chevere\Throwable\Exceptions\OverflowException;
use Iterator;

/**
 * Describes the component in charge of mapping classes to keys.
 */
interface ClassMapInterface extends MappedInterface
{
    /**
     * Return an instance with the specified className mapping.
     *
     * This method MUST retain the state of the current instance, and return
     * an instance that contains the specified className mapping.
     *
     * @throws ClassNotExistsException
     * @throws OverflowException
     */
    public function withPut(string $className, string $key): self;

    /**
     * Indicates whether the instance is mapping the given class name.
     */
    public function has(string $className): bool;

    /**
     * Indicates whether the instance maps the given key.
     */
    public function hasKey(string $key): bool;

    /**
     * Provides access to the class name mapping.
     *
     * @throws OutOfBoundsException
     */
    public function key(string $className): string;

    /**
     * Provides access to the class name mapped by key.
     *
     * @throws OutOfBoundsException
     */
    public function className(string $key): string;

    /**
     * Provides a traversable with `className => key`
     *
     * @return Iterator<string, string>
     */
    public function getIterator(): Iterator;

    /**
     * Provides access to the class map `className => key`
     *
     * @return array<string, string>
     */
    public function toArray(): array;
}