Veslo\AnthillBundle\Exception\Vacancy\ScannerNotFoundException

Complexity

Total Complexity

3

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

3 Methods

Rating	Name	Duplication	Size	Complexity
A	withRoadmapName()	0	5	1
A	__construct()	0	6	1
A	invalidLocation()	0	3	1

<?php

/*
 * This file is part of the Veslo project <https://github.com/symfony-doge/veslo>.
 *
 * (C) 2019 Pavel Petrov <itnelo@gmail.com>.
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @license https://opensource.org/licenses/GPL-3.0 GPL-3.0
 */

declare(strict_types=1);

namespace Veslo\AnthillBundle\Exception\Vacancy;

use RuntimeException;
use Symfony\Component\HttpFoundation\Response;
use Throwable;
use Veslo\AnthillBundle\Exception\AnthillBundleExceptionInterface;

/**
 * Will be thrown if roadmap is not found
 */
class ScannerNotFoundException extends RuntimeException implements AnthillBundleExceptionInterface
{
    /**
     * Default error message
     *
     * @const string
     */
    public const MESSAGE = 'Scanner is not found.';

    /**
     * Error message for context of invalid location dto structure
     *
     * @const string
     */
    public const MESSAGE_INVALID_LOCATION = 'Invalid vacancy location structure. Roadmap is not specified.';

    /**
     * Error message with name of unsupported roadmap
     *
     * @const string
     */
    public const MESSAGE_WITH_ROADMAP_NAME = "Scanner for roadmap '{roadmapName}' is not found. Declare it in roadmaps.yml";

    /**
     * {@inheritdoc}
     */
    public function __construct(
        string $message = self::MESSAGE,
        int $code = Response::HTTP_INTERNAL_SERVER_ERROR,
        Throwable $previous = null
    ) {
        parent::__construct($message, $code, $previous);
    }

    /**
     * Returns exception in context of unspecified roadmap in location dto
     *
     * @return ScannerNotFoundException
     */
    public static function invalidLocation(): ScannerNotFoundException
    {
        return new static(self::MESSAGE_INVALID_LOCATION);
    }

    /**
     * Returns exception in context of unsupported roadmap
     *
     * @param string $roadmapName Unsupported roadmap name
     *
     * @return ScannerNotFoundException
     */
    public static function withRoadmapName(string $roadmapName): ScannerNotFoundException
    {
        $message = str_replace('{roadmapName}', $roadmapName, self::MESSAGE_WITH_ROADMAP_NAME);

        return new static($message);
    }
}