biurad/php-dependency-injection

<?php

declare(strict_types=1);

/*
 * This file is part of Biurad opensource projects.
 *
 * PHP version 7.2 and above required
 *
 * @author    Divine Niiquaye Ibok <divineibok@gmail.com>
 * @copyright 2019 Biurad Group (https://biurad.com/)
 * @license   https://opensource.org/licenses/BSD-3-Clause License
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Biurad\DependencyInjection\Exceptions;

use InvalidArgumentException;
use Psr\Container\NotFoundExceptionInterface;
use Throwable;

/**
 * This exception is thrown when a non-existent parameter is used.
 *
 * @author Fabien Potencier <fabien@symfony.com>
 */
class ParameterNotFoundException extends InvalidArgumentException implements NotFoundExceptionInterface
{
    /** @var string */
    private $key;

    /** @var array */
    private $alternatives;

    /** @var array */
    private $nonNestedAlternative;

    /**
     * @param string      $key                  The requested parameter key
     * @param Throwable   $previous             The previous exception
     * @param string[]    $alternatives         Some parameter name alternatives
     * @param null|string $nonNestedAlternative The alternative parameter name when the user
     *                                          expected dot notation for nested parameters
     */
    public function __construct(
        string $key,
        Throwable $previous = null,
        array $alternatives = [],
        string $nonNestedAlternative = null
    ) {
        $this->key                  = $key;
        $this->alternatives         = $alternatives;
        $this->nonNestedAlternative = $nonNestedAlternative;

        parent::__construct('', 0, $previous);

        $this->updateRepr();
    }

    public function updateRepr(): void
    {
        $this->message = \sprintf('You have requested a non-existent parameter "%s".', $this->key);

        if ($this->alternatives) {
            if (1 == \count($this->alternatives)) {
                $this->message .= ' Did you mean this: "';
            } else {
                $this->message .= ' Did you mean one of these: "';
            }
            $this->message .= \implode('", "', $this->alternatives) . '"?';
        } elseif (null !== $this->nonNestedAlternative) {
            $this->message .= ' You cannot access nested array items, do you want to inject "' .
            $this->nonNestedAlternative . '" instead?';
        }
    }

    public function getKey()
    {
        return $this->key;
    }
}