ApacheSolrForTypo3\Solr\System\Object\AbstractClassRegistry

Complexity

Total Complexity

8

Size/Duplication

Total Lines	85
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	injectObjectManager()	0	4	1
A	getInstance()	0	5	1
A	resolveClassName()	0	9	2
A	createInstance()	0	4	1
A	register()	0	12	3

<?php
namespace ApacheSolrForTypo3\Solr\System\Object;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\SingletonInterface;
use TYPO3\CMS\Extbase\Object\ObjectManagerInterface;

/**
 * Abstract class to hold the logic to register and retrieve different classes
 * for a specific key.
 *
 * Can be used to retrieve different "strategies" for the same thing.
 *
 * @author Timo Hund <timo.hund@dkd.de>
 * @package ApacheSolrForTypo3\Solr\Domain\Search\ResultSet\Facets
 */
class AbstractClassRegistry implements SingletonInterface
{
    /**
     * Holds the mapping key => className
     * @var array
     */
    protected $classMap = [];

    /**
     * Name for the default implementation
     *
     * @var string
     */
    protected $defaultClass = \stdClass::class;

    /**
     * @var ObjectManagerInterface
     */
    protected $objectManager;

    /**
     * @param ObjectManagerInterface $objectManager
     */
    public function injectObjectManager(ObjectManagerInterface $objectManager)
    {
        $this->objectManager = $objectManager;
    }

    /**
     * Retrieves an instance for an registered type.
     *
     * @param string $type
     * @return object
     */
    public function getInstance($type)
    {
        $className = $this->resolveClassName($type);
        return $this->createInstance($className);
    }

    /**
     * @param string $type
     * @return string
     */
    protected function resolveClassName($type)
    {
        $className = $this->defaultClass;
        if (isset($this->classMap[$type])) {
            $className = $this->classMap[$type];
            return $className;
        }
        return $className;
    }

    /**
     * Create an instance of a certain class
     *
     * @param string $className
     * @return object
     */
    protected function createInstance($className)
    {
        return $this->objectManager->get($className);
    }

    /**
     * Can be used to register an implementation in the classMap.
     *
     * @param string $className
     * @param string $type
     * @param string $requiredBaseClass
     */
    protected function register($className, $type, $requiredBaseClass) {
        // check if the class is available for TYPO3 before registering the driver
        if (!class_exists($className)) {
            throw new \InvalidArgumentException('Class ' . $className . ' does not exist.', 1462883324);
        }

        if (!is_subclass_of($className, $requiredBaseClass)) {

Due to PHP Bug #53727, is_subclass_of might return inconsistent results on some PHP versions if $requiredBaseClass can be an interface. If so, you could instead use ReflectionClass::implementsInterface.

            throw new \InvalidArgumentException('Parser ' . $className . ' needs to extend the ' . $requiredBaseClass . '.', 1462883325);
        }

        $this->classMap[$type] = $className;
    }
}