Bdf\Prime\ServiceLocator

Complexity

Total Complexity

32

Size/Duplication

Total Lines	282
Duplicated Lines	0 %

Test Coverage

Coverage

98.46%

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	6	4
A	repositoryNames()	0	3	1
A	setDI()	0	5	1
A	setSerializer()	0	9	3
A	di()	0	3	1
A	registerRepository()	0	3	1
A	mappers()	0	3	1
A	connections()	0	3	1
A	serializer()	0	9	2
A	hydrator()	0	7	2
A	hydrators()	0	3	1
A	repository()	0	17	4
A	types()	0	3	1
A	instantiator()	0	3	1
A	connection()	0	3	1
A	clearRepositories()	0	9	3
A	unregisterRepository()	0	7	3
A	config()	0	3	1

<?php

namespace Bdf\Prime;

use Bdf\Prime\Connection\ConnectionInterface;
use Bdf\Prime\Entity\Hydrator\HydratorInterface;
use Bdf\Prime\Entity\Hydrator\HydratorRegistry;
use Bdf\Prime\Entity\Instantiator\InstantiatorInterface;
use Bdf\Prime\Entity\Instantiator\RegistryInstantiator;
use Bdf\Prime\Mapper\MapperFactory;
use Bdf\Prime\Repository\EntityRepository;
use Bdf\Prime\Repository\RepositoryInterface;
use Bdf\Prime\Types\TypesRegistryInterface;
use Bdf\Serializer\SerializerInterface;
use Psr\Container\ContainerInterface;

/**
 * ServiceLocator
 */
class ServiceLocator
{
    /**
     * @var ConnectionManager
     */
    private $connectionManager;
    
    /**
     * @var RepositoryInterface[]
     */
    private $repositories = [];
    
    /**
     * @var MapperFactory
     */
    private $mapperFactory;
    
    /**
     * @var SerializerInterface
     */
    private $serializer;

    /**
     * @var \Closure
     */
    private $serializerResolver;

    /**
     * @var HydratorRegistry
     */
    private $hydrators;

    /**
     * @var InstantiatorInterface
     */
    private $instantiator;

    /**
     * DI container
     *
     * @var ContainerInterface
     */
    private $di;

    /**
     * SericeLocator constructor.
     *
     * @param ConnectionManager $connectionManager
     * @param MapperFactory  $mapperFactory
     * @param InstantiatorInterface $instantiator
     */
    public function __construct(ConnectionManager $connectionManager = null, MapperFactory $mapperFactory = null, InstantiatorInterface $instantiator = null)
    {
        $this->connectionManager = $connectionManager ?: new ConnectionManager();

The value of a comparison must not be assigned to a variable

Inline shorthand IF statement requires brackets around comparison

        $this->mapperFactory = $mapperFactory ?: new MapperFactory();

The value of a comparison must not be assigned to a variable

Inline shorthand IF statement requires brackets around comparison

        $this->instantiator = $instantiator ?: new RegistryInstantiator();

The value of a comparison must not be assigned to a variable

Inline shorthand IF statement requires brackets around comparison

        $this->hydrators = new HydratorRegistry();
    }

    /**
     * Returns connection manager
     *
     * @return ConnectionManager
     */
    public function connections()
    {
        return $this->connectionManager;
    }

    /**
     * Returns connection manager
     * 
     * @return MapperFactory
     */
    public function mappers()
    {
        return $this->mapperFactory;
    }
    
    /**
     * Returns connection manager config
     * 
     * @return Configuration
     *
     * @deprecated Since 1.1.

The text '@deprecated Since 1.1.' does not match the standard format: @deprecated in deprecation-version and is removed from removal-version. extra-info.

Each @deprecated tag must have a @see tag immediately following it.

     */
    public function config()
    {
        return $this->connectionManager->config();

The function Bdf\Prime\ConnectionManager::config() has been deprecated: Every connection should have its config.

    }
    
    /**
     * Get a db connection
     * 
     * @param string $name
     * 
     * @return ConnectionInterface
     */
    public function connection($name = null)
    {
        return $this->connectionManager->getConnection($name);
    }
    
    /**
     * Register a repository
     *
     * @param string $entityClass
     * @param RepositoryInterface $repository
     */
    public function registerRepository($entityClass, RepositoryInterface $repository)
    {
        $this->repositories[$entityClass] = $repository;
    }
    
    /**
     * Unregister a repository
     *
     * @param string $entityClass
     */
    public function unregisterRepository($entityClass)
    {
        if (isset($this->repositories[$entityClass]) && $this->repositories[$entityClass] instanceof EntityRepository) {
            $this->repositories[$entityClass]->destroy();

The method destroy() does not exist on Bdf\Prime\Repository\RepositoryInterface. Since it exists in all sub-types, consider adding an abstract or default implementation to Bdf\Prime\Repository\RepositoryInterface.

        }

        unset($this->repositories[$entityClass]);
    }
    
    /**
     * Get mapper for specified entity
     *
     * @param string|object $entityClass Name of Entity object to load mapper for
     * 
     * @return RepositoryInterface
     */
    public function repository($entityClass)
    {
        if (is_object($entityClass)) {
            $entityClass = get_class($entityClass);
        }
        
        if (!isset($this->repositories[$entityClass])) {
            $mapper = $this->mapperFactory->build($this, $entityClass);

            if ($mapper === null) {
                return null;
            }

            $this->repositories[$entityClass] = $mapper->repository();
        }
        
        return $this->repositories[$entityClass];
    }
    
    /**
     * Get repository names
     * 
     * @return array
     */
    public function repositoryNames()
    {
        return array_keys($this->repositories);
    }

    /**
     * Set the serializer
     *
     * @param \Closure|SerializerInterface $serializer
     *
     * @return $this
     */
    public function setSerializer($serializer)
    {
        if ($serializer instanceof \Closure) {
            $this->serializerResolver = $serializer;
        } elseif ($serializer instanceof SerializerInterface) {

Usage of ELSEIF not allowed; use ELSE IF instead

$serializer is always a sub-type of Bdf\Serializer\SerializerInterface.

            $this->serializer = $serializer;
        }

        return $this;
    }

    /**
     * Get the serializer
     *
     * @return SerializerInterface
     */
    public function serializer()
    {
        if ($this->serializerResolver !== null) {
            $resolver = $this->serializerResolver;
            $this->serializer = $resolver();
            $this->serializerResolver = null;
        }

        return $this->serializer;
    }

    /**
     * Get the entity hydrators registry
     *
     * @return HydratorRegistry
     */
    public function hydrators()
    {
        return $this->hydrators;
    }

    /**
     * Get the entity hydrator
     *
     * @param string|object $entity The entity class or object
     *
     * @return HydratorInterface
     */
    public function hydrator($entity)
    {
        if (is_object($entity)) {
            $entity = get_class($entity);
        }

        return $this->hydrators->get($entity);
    }

    /**
     * Get the entity instantiator
     *
     * @return InstantiatorInterface
     */
    public function instantiator()
    {
        return $this->instantiator;
    }

    /**
     * Get the types registry
     *
     * @return TypesRegistryInterface
     *
     * @deprecated Since 1.1.

The text '@deprecated Since 1.1.' does not match the standard format: @deprecated in deprecation-version and is removed from removal-version. extra-info.

Each @deprecated tag must have a @see tag immediately following it.

     */
    public function types()
    {
        return $this->connectionManager->config()->getTypes();

The function Bdf\Prime\ConnectionManager::config() has been deprecated: Every connection should have its config.

    }

    /**
     * DI accessor
     *
     * @return ContainerInterface
     */
    public function di()
    {
        return $this->di;
    }

    /**
     * DI accessor
     *
     * @param ContainerInterface $di
     *
     * @return $this
     */
    public function setDI(ContainerInterface $di)

This method is not in camel caps format.

Public method name "ServiceLocator::setDI" is not in lowerCamel format

    {
        $this->di = $di;

        return $this;
    }

    /**
     * Clear all cache repositories
     */
    public function clearRepositories()
    {
        foreach ($this->repositories as $repository) {
            if ($repository instanceof EntityRepository) {
                $repository->destroy();
            }
        }

        $this->repositories = [];
    }
}