symfony-doge/veslo

<?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\Vacancy;

use Veslo\AnthillBundle\Exception\Vacancy\Roadmap\ConfigurationNotSupportedException;
use Veslo\AnthillBundle\Exception\Vacancy\RoadmapNotFoundException;
use Veslo\AnthillBundle\Vacancy\Roadmap\ConveyorAwareRoadmap;

/**
 * Aggregates and builds roadmaps for vacancy search
 * It means that each beetle should ask her what to do and how to do, yup
 *
 *              *
 *            * | *
 *           * \|/ *
 *      * * * \|O|/ * * *
 *       \o\o\o|O|o/o/o/
 *       (<><><>O<><><>)
 *        '==========='
 *            \.-./
 *           (o\^/o)  _   _   _     __
 *            ./ \.\ ( )-( )-( ) .-'  '-.
 *             {-} \(//  ||   \\/ (   )) '-.
 *                  //-__||__.-\\.       .-'
 *                 (/    ()     \)'-._.-'
 *                 ||    ||      \\
 *                 ('    ('      ')
 */
class AntQueen
{
    /**
     * Roadmaps array indexed by name
     *
     * @var RoadmapInterface[]
     */
    private $_roadmaps;

    /**
     * AntQueen constructor.
     */
    public function __construct()
    {
        $this->_roadmaps = [];
    }

    /**
     * Returns all available roadmaps for vacancy search
     *
     * @return RoadmapInterface[]
     */
    public function getRoadmaps(): array
    {
        return $this->_roadmaps;
    }

    /**
     * Adds roadmap service in list of supported roadmaps
     *
     * @param string           $roadmapName Roadmap name
     * @param RoadmapInterface $roadmap     Service for roadmap support
     *
     * @return void
     */
    public function addRoadmap(string $roadmapName, RoadmapInterface $roadmap): void
    {
        $this->_roadmaps[$roadmapName] = $roadmap;
    }

    /**
     * Returns roadmap by name or throws an exception if roadmap is not supported
     *
     * @param string $roadmapName Roadmap name
     *
     * @return RoadmapInterface
     *
     * @throws RoadmapNotFoundException
     */
    public function requireRoadmap(string $roadmapName): RoadmapInterface
    {
        if (!array_key_exists($roadmapName, $this->_roadmaps)) {
            throw RoadmapNotFoundException::withName($roadmapName);
        }

        return $this->_roadmaps[$roadmapName];
    }

    /**
     * Builds roadmap for conveyor process
     *
     * @param string $roadmapName      Roadmap name
     * @param string $configurationKey A configuration key, roadmap should support configurable interface
     *
     * @return ConveyorAwareRoadmap
     *
     * @throws ConfigurationNotSupportedException
     */
    public function buildRoadmap(string $roadmapName, ?string $configurationKey = null): ConveyorAwareRoadmap
    {
        $roadmap = $this->requireRoadmap($roadmapName);

        if (!empty($configurationKey)) {
            if (!$roadmap instanceof ConfigurableRoadmapInterface) {
                throw ConfigurationNotSupportedException::withName($roadmapName);
            }

            $configuration = $roadmap->getConfiguration();
            $configuration->apply($configurationKey);
        }

        return new ConveyorAwareRoadmap($roadmap, $roadmapName);
    }
}