ApacheSolrForTypo3\Solr\Search\SearchComponentManager

Complexity

Total Complexity

8

Size/Duplication

Total Lines	82
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	1

Test Coverage

Coverage

41.94%

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	registerSearchComponent()	0	6	1
A	getSearchComponents()	0	10	2
A	getSearchComponent()	0	20	3
A	removeSearchComponent()	0	8	2

<?php
namespace ApacheSolrForTypo3\Solr\Search;

/***************************************************************
 *  Copyright notice
 *
 *  (c) 2012-2015 Ingo Renner <ingo@typo3.org>
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is
 *  free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 2 of the License, or
 *  (at your option) any later version.
 *
 *  The GNU General Public License can be found at
 *  http://www.gnu.org/copyleft/gpl.html.
 *
 *  This script is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  This copyright notice MUST APPEAR in all copies of the script!
 ***************************************************************/

use ApacheSolrForTypo3\Solr\Search\SearchComponent;
use TYPO3\CMS\Core\Utility\GeneralUtility;

/**
 * Search components manager, registration and stuff...
 *
 * @author Ingo Renner <ingo@typo3.org>
 */
class SearchComponentManager
{

    /**
     * Search component registry.
     *
     * @var array
     */
    protected static $searchComponents = [];

    /**
     * Registers a search component.
     *
     * @param string $componentName Search component name
     * @param string $componentClassName Component class
     */
    public static function registerSearchComponent(
        $componentName,
        $componentClassName
    ) {
        self::$searchComponents[$componentName] = $componentClassName;
    }

    /**
     * Returns all currently registered search components.
     *
     * @return array An array of search component instances
     */
    public function getSearchComponents()
    {
        $searchComponents = [];

        foreach (self::$searchComponents as $componentName => $componentClass) {
            $searchComponents[$componentName] = $this->getSearchComponent($componentName);
        }

        return $searchComponents;
    }

    /**
     * Instanciates a registered search component
     *
     * @param string $componentName Search component name
     * @return SearchComponent Instance of the requested search component
     * @throws \InvalidArgumentException if $componentName is not a registered search component
     * @throws \RuntimeException if the class registered for $componentName is not an implementation of ApacheSolrForTypo3\Solr\Search\SearchComponent
     */
    public function getSearchComponent($componentName)
    {
        if (!array_key_exists($componentName, self::$searchComponents)) {
            throw new \InvalidArgumentException(
                'No search component registered named ' . $componentName,
                1343398440
            );
        }

        $searchComponent = GeneralUtility::makeInstance(self::$searchComponents[$componentName]);

        if (!($searchComponent instanceof SearchComponent)) {
            throw new \RuntimeException(
                'Class ' . self::$searchComponents[$componentName] . ' must implement interface ' . SearchComponent::class,
                1343398621
            );
        }

        return $searchComponent;
    }

    /**
     * Unregisters a search component
     *
     * @param string $componentName Search component name
     */
    public function removeSearchComponent($componentName)
    {
        if (!array_key_exists($componentName, self::$searchComponents)) {
            return;
        }

        unset(self::$searchComponents[$componentName]);
    }
}