MapperFactory::setMetadataCache() - Code Metrics - Inspection of "Adding connection factory and registry" - b2pweb/bdf-prime - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 7a6bdd...324ce1 )

by Sébastien

created 2020-06-12 13:37 UTC

MapperFactory::setMetadataCache() A

↳ Parent: MapperFactory

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	2
CRAP Score	1

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
ccs	2
cts	2
cp	1
rs	10
cc	1
nc	1
nop	1
crap	1

<?php

namespace Bdf\Prime\Mapper;

use Bdf\Prime\Cache\CacheInterface;
use Bdf\Prime\Entity\Hydrator\MapperHydrator;
use Bdf\Prime\Entity\Hydrator\MapperHydratorInterface;
use Bdf\Prime\Mapper\NameResolver\ResolverInterface;
use Bdf\Prime\Mapper\NameResolver\SuffixResolver;
use Bdf\Prime\ServiceLocator;
use Psr\SimpleCache\CacheInterface as Psr16CacheInterface;

/**
 * @package Bdf\Prime\Mapper

 */
class MapperFactory
{
    /**
     * @var ResolverInterface
     */
    private $nameResolver;

    
    /**
     * @var Psr16CacheInterface
     */
    private $metadataCache;

    /**
     * @var CacheInterface
     */
    private $resultCache;

    /**
     * @param ResolverInterface $nameResolver
     * @param Psr16CacheInterface|null $metadataCache
     * @param CacheInterface|null $resultCache
     */
    public function __construct(ResolverInterface $nameResolver = null, Psr16CacheInterface $metadataCache = null, CacheInterface $resultCache = null)
    {
        $this->nameResolver = $nameResolver ?: new SuffixResolver();

        $this->metadataCache = $metadataCache;
        $this->resultCache = $resultCache;
    }

    /**
     * Get associated entity mapper
     *
     * @param ServiceLocator $serviceLocator
     * @param string $entityClass
     *
     * @return Mapper
     */
    public function build(ServiceLocator $serviceLocator, $entityClass)
    {
        return $this->createMapper($serviceLocator, $this->nameResolver->resolve($entityClass), $entityClass);
    }
    
    /**
     * Get mapper object
     *
     * @param ServiceLocator $serviceLocator
     * @param string $mapperClass
     * @param string $entityClass
     *
     * @return Mapper
     */
    public function createMapper(ServiceLocator $serviceLocator, $mapperClass, $entityClass = null)
    {
        if (!$this->isMapper($mapperClass)) {
            return null;
        }
        
        if ($entityClass === null) {
            $entityClass = $this->nameResolver->reverse($mapperClass);
        }
        
        $metadata = null;
        if ($this->metadataCache !== null) {
            $cacheKey = $this->getCacheKey($mapperClass);
            $metadata = $this->metadataCache->get($cacheKey);
        }

        $hydrator = $serviceLocator->hydrator($entityClass);

        if (!($hydrator instanceof MapperHydratorInterface)) {
            $hydrator = new MapperHydrator();
        }

        /** @var Mapper $mapper */

        $mapper = new $mapperClass($serviceLocator, $entityClass, $metadata, $hydrator, $this->resultCache);

        if ($this->metadataCache !== null && $metadata === null) {
            $this->metadataCache->set($cacheKey, $mapper->metadata());

        }

        if ($mapper instanceof MapperFactoryAwareInterface) {
            $mapper->setMapperFactory($this);
        }
        
        return $mapper;
    }
    
    /**
     * Check if class is a mapper
     * 
     * @param string $className
     *
     * @return bool

     */
    public function isMapper($className)
    {
        return is_subclass_of($className, Mapper::class);
    }
    
    /**
     * Check if class has a mapper
     * 
     * @param string $className
     *
     * @return bool

     */
    public function isEntity($className)
    {
        return $this->isMapper($this->nameResolver->resolve($className));
    }

    /**
     * Create the valid cache key from mapperClass
     *
     * @param string $mapperClass
     *
     * @return string
     */
    private function getCacheKey($mapperClass)

    {
        return str_replace('\\', '.', $mapperClass);
    }

    /**
     * Get the mapper name resolver
     *
     * @return ResolverInterface
     */
    public function getNameResolver()
    {
        return $this->nameResolver;
    }

    /**
     * Set meta cache
     *
     * @param null|Psr16CacheInterface $cache
     */
    public function setMetadataCache(?Psr16CacheInterface $cache)
    {
        $this->metadataCache = $cache;
    }

    /**
     * Get meta cache
     *
     * @return Psr16CacheInterface
     */
    public function getMetadataCache(): ?Psr16CacheInterface
    {
        return $this->metadataCache;
    }

    /**
     * Set the result cache
     *
     * @param null|CacheInterface $cache
     */
    public function setResultCache(?CacheInterface $cache)
    {
        $this->resultCache = $cache;
    }

    /**
     * Get the resul cache
     *
     * @return CacheInterface
     */
    public function getResultCache(): ?CacheInterface
    {
        return $this->resultCache;
    }
}


1		<?php
2
3		namespace Bdf\Prime\Mapper;
4
5		use Bdf\Prime\Cache\CacheInterface;
6		use Bdf\Prime\Entity\Hydrator\MapperHydrator;
7		use Bdf\Prime\Entity\Hydrator\MapperHydratorInterface;
8		use Bdf\Prime\Mapper\NameResolver\ResolverInterface;
9		use Bdf\Prime\Mapper\NameResolver\SuffixResolver;
10		use Bdf\Prime\ServiceLocator;
11		use Psr\SimpleCache\CacheInterface as Psr16CacheInterface;
12
13		/**
14		* @package Bdf\Prime\Mapper
		0 ignored issues – show Coding Style Documentation introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report @package tag is not allowed in class comment Loading history...
15		*/
16		class MapperFactory
17		{
18		/**
19		* @var ResolverInterface
20		*/
21		private $nameResolver;
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Expected 1 blank line(s) before first member var; 0 found Loading history...
22
23		/**
24		* @var Psr16CacheInterface
25		*/
26		private $metadataCache;
27
28		/**
29		* @var CacheInterface
30		*/
31		private $resultCache;
32
33		/**
34		* @param ResolverInterface $nameResolver
35		* @param Psr16CacheInterface\|null $metadataCache
36		* @param CacheInterface\|null $resultCache
37		*/
38	107	public function __construct(ResolverInterface $nameResolver = null, Psr16CacheInterface $metadataCache = null, CacheInterface $resultCache = null)
39		{
40	107	$this->nameResolver = $nameResolver ?: new SuffixResolver();
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report The value of a comparison must not be assigned to a variable Loading history... Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Inline IF statements are not allowed Loading history... Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Inline shorthand IF statement requires brackets around comparison Loading history...
41	107	$this->metadataCache = $metadataCache;
42	107	$this->resultCache = $resultCache;
43	107	}
44
45		/**
46		* Get associated entity mapper
47		*
48		* @param ServiceLocator $serviceLocator
49		* @param string $entityClass
50		*
51		* @return Mapper
52		*/
53	128	public function build(ServiceLocator $serviceLocator, $entityClass)
54		{
55	128	return $this->createMapper($serviceLocator, $this->nameResolver->resolve($entityClass), $entityClass);
56		}
57
58		/**
59		* Get mapper object
60		*
61		* @param ServiceLocator $serviceLocator
62		* @param string $mapperClass
63		* @param string $entityClass
64		*
65		* @return Mapper
66		*/
67	149	public function createMapper(ServiceLocator $serviceLocator, $mapperClass, $entityClass = null)
68		{
69	149	if (!$this->isMapper($mapperClass)) {
70	7	return null;
71		}
72
73	142	if ($entityClass === null) {
74	21	$entityClass = $this->nameResolver->reverse($mapperClass);
75		}
76
77	142	$metadata = null;
78	142	if ($this->metadataCache !== null) {
79	2	$cacheKey = $this->getCacheKey($mapperClass);
80	2	$metadata = $this->metadataCache->get($cacheKey);
81		}
82
83	142	$hydrator = $serviceLocator->hydrator($entityClass);
84
85	142	if (!($hydrator instanceof MapperHydratorInterface)) {
86	141	$hydrator = new MapperHydrator();
87		}
88
89		/** @var Mapper $mapper */
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Inline doc block comments are not allowed; use "/* Comment /" or "// Comment" instead Loading history... Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Block comments must be started with / Loading history... Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report The open comment tag must be the only content on the line Loading history... Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report The close comment tag must be the only content on the line Loading history...
90	142	$mapper = new $mapperClass($serviceLocator, $entityClass, $metadata, $hydrator, $this->resultCache);
91
92	142	if ($this->metadataCache !== null && $metadata === null) {
93	1	$this->metadataCache->set($cacheKey, $mapper->metadata());
		0 ignored issues – show Comprehensibility Best Practice introduced 2020-06-12 13:46 UTC by Report Bug Copy Issue Report The variable `$cacheKey` does not seem to be defined for all execution paths leading up to this point. Loading history...
94		}
95
96	142	if ($mapper instanceof MapperFactoryAwareInterface) {
97	25	$mapper->setMapperFactory($this);
98		}
99
100	142	return $mapper;
101		}
102
103		/**
104		* Check if class is a mapper
105		*
106		* @param string $className
107		*
108		* @return bool
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Expected "boolean" but found "bool" for function return type Loading history...
109		*/
110	248	public function isMapper($className)
111		{
112	248	return is_subclass_of($className, Mapper::class);
113		}
114
115		/**
116		* Check if class has a mapper
117		*
118		* @param string $className
119		*
120		* @return bool
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Expected "boolean" but found "bool" for function return type Loading history...
121		*/
122	114	public function isEntity($className)
123		{
124	114	return $this->isMapper($this->nameResolver->resolve($className));
125		}
126
127		/**
128		* Create the valid cache key from mapperClass
129		*
130		* @param string $mapperClass
131		*
132		* @return string
133		*/
134	2	private function getCacheKey($mapperClass)
		0 ignored issues – show Coding Style introduced 2020-05-22 09:38 UTC by Report Bug Copy Issue Report Private method name "MapperFactory::getCacheKey" must be prefixed with an underscore Loading history...
135		{
136	2	return str_replace('\\', '.', $mapperClass);
137		}
138
139		/**
140		* Get the mapper name resolver
141		*
142		* @return ResolverInterface
143		*/
144	8	public function getNameResolver()
145		{
146	8	return $this->nameResolver;
147		}
148
149		/**
150		* Set meta cache
151		*
152		* @param null\|Psr16CacheInterface $cache
153		*/
154	4	public function setMetadataCache(?Psr16CacheInterface $cache)
155		{
156	4	$this->metadataCache = $cache;
157	4	}
158
159		/**
160		* Get meta cache
161		*
162		* @return Psr16CacheInterface
163		*/
164	5	public function getMetadataCache(): ?Psr16CacheInterface
165		{
166	5	return $this->metadataCache;
167		}
168
169		/**
170		* Set the result cache
171		*
172		* @param null\|CacheInterface $cache
173		*/
174	3	public function setResultCache(?CacheInterface $cache)
175		{
176	3	$this->resultCache = $cache;
177	3	}
178
179		/**
180		* Get the resul cache
181		*
182		* @return CacheInterface
183		*/
184	3	public function getResultCache(): ?CacheInterface
185		{
186	3	return $this->resultCache;
187		}
188		}
189

b2pweb / bdf-prime

Push — master ( 7a6bdd...324ce1 )

MapperFactory::setMetadataCache() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like