EntityManager::remove() - Code Metrics - Inspection of "Collection documentation" - igniphp/storage - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 583647...efdb33 )

by Dawid

created 2018-07-16 07:43 UTC

EntityManager::remove() A

↳ Parent: EntityManager

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php declare(strict_types=1);

namespace Igni\Storage;

use Cache\Adapter\PHPArray\ArrayCachePool;
use Igni\Storage\Exception\HydratorException;
use Igni\Storage\Exception\RepositoryException;
use Igni\Storage\Hydration\HydratorAutoGenerate;
use Igni\Storage\Hydration\HydratorFactory;
use Igni\Storage\Hydration\ObjectHydrator;
use Igni\Storage\Mapping\IdentityMap;
use Igni\Storage\Mapping\MetaData\EntityMetaData;
use Igni\Storage\Mapping\MetaData\MetaDataFactory;
use Igni\Storage\Mapping\MetaData\Strategy\AnnotationMetaDataFactory;
use Psr\SimpleCache\CacheInterface;

class EntityManager implements IdentityMap, MetaDataFactory
{
    /** @var Storable[] */
    private $registry = [];

    /** @var Repository[] */
    private $repositories = [];

    /** @var HydratorFactory */
    private $hydratorFactory;

    /** @var ObjectHydrator[] */
    private $hydrators = [];

    /** @var MetaDataFactory */
    private $metaDataFactory;

    /** @var string */
    private $hydratorDir;

    /** @var string */
    private $hydratorNamespace;

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

    /**
     * EntityManager constructor.
     * @param string|null $hydratorDir
     * @param string|null $hydratorNamespace
     * @param string|null $hydratorAutoGenerate
     * @param CacheInterface|null $cache
     * @param MetaDataFactory|null $metaDataFactory
     */
    public function __construct(
        string $hydratorDir = null,
        string $hydratorNamespace = null,
        string $hydratorAutoGenerate = HydratorAutoGenerate::IF_NOT_EXISTS,
        CacheInterface $cache = null,
        MetaDataFactory $metaDataFactory = null
    ) {
        if ($hydratorDir === null) {
            $hydratorDir = sys_get_temp_dir();
        }

        if (!is_writable($hydratorDir)) {
            throw new HydratorException("Hydrators cannot be generated, directory ($hydratorDir) is not writable.");
        }

        if ($metaDataFactory === null) {
            $metaDataFactory = new AnnotationMetaDataFactory();
        }

        if ($cache === null) {
            $cache = new ArrayCachePool();
        }

        $this->cache = $cache;
        $this->hydratorDir = $hydratorDir;
        $this->metaDataFactory = $metaDataFactory;
        $this->hydratorNamespace = $hydratorNamespace ?? '';
        $this->hydratorFactory = new HydratorFactory($this, $hydratorAutoGenerate);
    }

    public function getHydratorDir(): string
    {
        return $this->hydratorDir;
    }

    public function getHydratorNamespace(): string
    {
        return $this->hydratorNamespace;
    }

    /**
     * Creates new entity in the storage.
     *
     * @param Storable $entity
     * @return Storable
     */
    public function create(Storable $entity): Storable
    {
        $this->getRepository(get_class($entity))->create($entity);
        $this->attach($entity);

        return $entity;
    }

    /**
     * Updated entity in the storage.
     *
     * @param Storable $entity
     * @return Storable
     */
    public function update(Storable $entity): Storable
    {
        $this->getRepository(get_class($entity))->update($entity);

        return $entity;
    }

    /**
     * Removes entity from the storage.
     *
     * @param Storable $entity
     * @return Storable
     */
    public function remove(Storable $entity): Storable
    {
        $this->getRepository(get_class($entity))->remove($entity);
        $this->detach($entity);

        return $entity;
    }

    /**
     * Retrieves entity by identifier from the storage.
     *
     * @param string $entity
     * @param $id
     * @return Storable
     */
    public function get(string $entity, $id): Storable
    {
        $key = $this->getId($entity, $id);

        if ($this->has($entity, $id)) {
            return $this->registry[$key];
        }

        return $this->getRepository($entity)->get($id);
    }

    public function getRepository(string $entity): Repository
    {
        if ($this->hasRepository($entity)) {
            return $this->repositories[$entity];
        }

        throw RepositoryException::forNotRegisteredRepository($entity);
    }

    public function hasRepository(string $entity): bool
    {
        return isset($this->repositories[$entity]);
    }

    public function addRepository(Repository ...$repositories): void
    {
        foreach ($repositories as $repository) {
            $this->repositories[$repository::getEntityClass()] = $repository;
        }
    }

    public function attach(Storable $entity): Storable
    {
        $key = $this->getId($entity);

        if (!isset($this->registry[$key])) {
            $this->registry[$key] = $entity;
        }

        return $this->registry[$key];
    }

    public function detach(Storable $entity): Storable
    {
        $key = $this->getId($entity);
        if (isset($this->registry[$key])) {
            unset($this->registry[$key]);
        }

        return $entity;
    }

    /**
     *
     * @param string $class
     * @param $id
     * @return bool
     */
    public function has(string $class, $id): bool
    {
        $key = $this->getId($class, $id);
        return isset($this->registry[$key]);
    }

    /**
     * Checks if entity lives in the identity map.
     *
     * @param Storable $entity
     * @return bool
     */
    public function contains(Storable $entity): bool
    {
        return in_array($entity, $this->registry, true);
    }

    /**
     * Clears identity map.
     */
    public function clear(): void
    {
        $this->registry = [];
    }

    /**
     * Gets global id for entity which is used for
     * later storage in the identity map.
     *
     * @param $entity
     * @param null $id

     * @return string
     */
    private function getId($entity, $id = null): string
    {
        if ($entity instanceof Storable) {
            return get_class($entity) . '@' . $entity->getId()->getValue();
        }

        return "${entity}@${id}";
    }

    /**
     * Creates instance of the entity class and hydrates it with passed data.
     *
     * @param string $entityClass
     * @param array $data
     * @return object
     */
    public function hydrate(string $entityClass, array $data)
    {
        $hydrator = $this->getHydrator($entityClass);

        return $hydrator->hydrate($data);
    }

    /**
     * Extracts data from passed entity and returns it.
     *
     * @param $entity
     * @return array
     */
    public function extract($entity): array
    {
        $entityClass = get_class($entity);

        $hydrator = $this->getHydrator($entityClass);

        return $hydrator->extract($entity);
    }

    /**
     * Returns hydrator for the given entity.
     *
     * @param string $entity
     * @return ObjectHydrator
     */
    public function getHydrator(string $entity): ObjectHydrator
    {
        if (!isset($this->hydrators[$entity])) {
            $this->hydrators[$entity] = $this->hydratorFactory->get($entity);
        }

        return $this->hydrators[$entity];
    }

    /**
     * Returns entity's mapping metadata information
     *
     * @param string $entity
     * @return EntityMetaData
     */
    public function getMetaData(string $entity): EntityMetaData
    {
        $key = str_replace('\\', '.', $entity) . '.metadata';

        if (!$this->cache->has($key)) {
            $metaData = $this->metaDataFactory->getMetaData($entity);
            $this->cache->set($key, $metaData);

            return $metaData;
        }

        return $this->cache->get($key);
    }
}


1		<?php declare(strict_types=1);
2
3		namespace Igni\Storage;
4
5		use Cache\Adapter\PHPArray\ArrayCachePool;
6		use Igni\Storage\Exception\HydratorException;
7		use Igni\Storage\Exception\RepositoryException;
8		use Igni\Storage\Hydration\HydratorAutoGenerate;
9		use Igni\Storage\Hydration\HydratorFactory;
10		use Igni\Storage\Hydration\ObjectHydrator;
11		use Igni\Storage\Mapping\IdentityMap;
12		use Igni\Storage\Mapping\MetaData\EntityMetaData;
13		use Igni\Storage\Mapping\MetaData\MetaDataFactory;
14		use Igni\Storage\Mapping\MetaData\Strategy\AnnotationMetaDataFactory;
15		use Psr\SimpleCache\CacheInterface;
16
17		class EntityManager implements IdentityMap, MetaDataFactory
18		{
19		/** @var Storable[] */
20		private $registry = [];
21
22		/** @var Repository[] */
23		private $repositories = [];
24
25		/** @var HydratorFactory */
26		private $hydratorFactory;
27
28		/** @var ObjectHydrator[] */
29		private $hydrators = [];
30
31		/** @var MetaDataFactory */
32		private $metaDataFactory;
33
34		/** @var string */
35		private $hydratorDir;
36
37		/** @var string */
38		private $hydratorNamespace;
39
40		/** @var CacheInterface */
41		private $cache;
42
43		/**
44		* EntityManager constructor.
45		* @param string\|null $hydratorDir
46		* @param string\|null $hydratorNamespace
47		* @param string\|null $hydratorAutoGenerate
48		* @param CacheInterface\|null $cache
49		* @param MetaDataFactory\|null $metaDataFactory
50		*/
51	38	public function __construct(
52		string $hydratorDir = null,
53		string $hydratorNamespace = null,
54		string $hydratorAutoGenerate = HydratorAutoGenerate::IF_NOT_EXISTS,
55		CacheInterface $cache = null,
56		MetaDataFactory $metaDataFactory = null
57		) {
58	38	if ($hydratorDir === null) {
59	4	$hydratorDir = sys_get_temp_dir();
60		}
61
62	38	if (!is_writable($hydratorDir)) {
63		throw new HydratorException("Hydrators cannot be generated, directory ($hydratorDir) is not writable.");
64		}
65
66	38	if ($metaDataFactory === null) {
67	38	$metaDataFactory = new AnnotationMetaDataFactory();
68		}
69
70	38	if ($cache === null) {
71	38	$cache = new ArrayCachePool();
72		}
73
74	38	$this->cache = $cache;
75	38	$this->hydratorDir = $hydratorDir;
76	38	$this->metaDataFactory = $metaDataFactory;
77	38	$this->hydratorNamespace = $hydratorNamespace ?? '';
78	38	$this->hydratorFactory = new HydratorFactory($this, $hydratorAutoGenerate);
79	38	}
80
81	1	public function getHydratorDir(): string
82		{
83	1	return $this->hydratorDir;
84		}
85
86	16	public function getHydratorNamespace(): string
87		{
88	16	return $this->hydratorNamespace;
89		}
90
91		/**
92		* Creates new entity in the storage.
93		*
94		* @param Storable $entity
95		* @return Storable
96		*/
97	1	public function create(Storable $entity): Storable
98		{
99	1	$this->getRepository(get_class($entity))->create($entity);
100	1	$this->attach($entity);
101
102	1	return $entity;
103		}
104
105		/**
106		* Updated entity in the storage.
107		*
108		* @param Storable $entity
109		* @return Storable
110		*/
111		public function update(Storable $entity): Storable
112		{
113		$this->getRepository(get_class($entity))->update($entity);
114
115		return $entity;
116		}
117
118		/**
119		* Removes entity from the storage.
120		*
121		* @param Storable $entity
122		* @return Storable
123		*/
124		public function remove(Storable $entity): Storable
125		{
126		$this->getRepository(get_class($entity))->remove($entity);
127		$this->detach($entity);
128
129		return $entity;
130		}
131
132		/**
133		* Retrieves entity by identifier from the storage.
134		*
135		* @param string $entity
136		* @param $id
137		* @return Storable
138		*/
139	5	public function get(string $entity, $id): Storable
140		{
141	5	$key = $this->getId($entity, $id);
142
143	5	if ($this->has($entity, $id)) {
144		return $this->registry[$key];
145		}
146
147	5	return $this->getRepository($entity)->get($id);
148		}
149
150	8	public function getRepository(string $entity): Repository
151		{
152	8	if ($this->hasRepository($entity)) {
153	8	return $this->repositories[$entity];
154		}
155
156		throw RepositoryException::forNotRegisteredRepository($entity);
157		}
158
159	8	public function hasRepository(string $entity): bool
160		{
161	8	return isset($this->repositories[$entity]);
162		}
163
164	16	public function addRepository(Repository ...$repositories): void
165		{
166	16	foreach ($repositories as $repository) {
167	16	$this->repositories[$repository::getEntityClass()] = $repository;
168		}
169	16	}
170
171	6	public function attach(Storable $entity): Storable
172		{
173	6	$key = $this->getId($entity);
174
175	6	if (!isset($this->registry[$key])) {
176	6	$this->registry[$key] = $entity;
177		}
178
179	6	return $this->registry[$key];
180		}
181
182	1	public function detach(Storable $entity): Storable
183		{
184	1	$key = $this->getId($entity);
185	1	if (isset($this->registry[$key])) {
186	1	unset($this->registry[$key]);
187		}
188
189	1	return $entity;
190		}
191
192		/**
193		*
194		* @param string $class
195		* @param $id
196		* @return bool
197		*/
198	7	public function has(string $class, $id): bool
199		{
200	7	$key = $this->getId($class, $id);
201	7	return isset($this->registry[$key]);
202		}
203
204		/**
205		* Checks if entity lives in the identity map.
206		*
207		* @param Storable $entity
208		* @return bool
209		*/
210	3	public function contains(Storable $entity): bool
211		{
212	3	return in_array($entity, $this->registry, true);
213		}
214
215		/**
216		* Clears identity map.
217		*/
218		public function clear(): void
219		{
220		$this->registry = [];
221		}
222
223		/**
224		* Gets global id for entity which is used for
225		* later storage in the identity map.
226		*
227		* @param $entity
228		* @param null $id
		0 ignored issues – show Documentation Bug introduced 2018-04-25 21:23 UTC by Report Bug Copy Issue Report Are you sure the doc-type for parameter `$id` is correct as it would always require `null` to be passed? Loading history...
229		* @return string
230		*/
231	8	private function getId($entity, $id = null): string
232		{
233	8	if ($entity instanceof Storable) {
234	6	return get_class($entity) . '@' . $entity->getId()->getValue();
235		}
236
237		return "${entity}@${id}";
238		}
239
240		/**
241		* Creates instance of the entity class and hydrates it with passed data.
242		*
243		* @param string $entityClass
244		* @param array $data
245		* @return object
246		*/
247		public function hydrate(string $entityClass, array $data)
248		{
249		$hydrator = $this->getHydrator($entityClass);
250
251		return $hydrator->hydrate($data);
252		}
253
254		/**
255		* Extracts data from passed entity and returns it.
256		*
257		* @param $entity
258		* @return array
259		*/
260		public function extract($entity): array
261		{
262	1	$entityClass = get_class($entity);
263
264	1	$hydrator = $this->getHydrator($entityClass);
265
266	1	return $hydrator->extract($entity);
267		}
268
269		/**
270		* Returns hydrator for the given entity.
271		*
272		* @param string $entity
273		* @return ObjectHydrator
274		*/
275		public function getHydrator(string $entity): ObjectHydrator
276		{
277	16	if (!isset($this->hydrators[$entity])) {
278	16	$this->hydrators[$entity] = $this->hydratorFactory->get($entity);
279		}
280
281	16	return $this->hydrators[$entity];
282		}
283
284		/**
285		* Returns entity's mapping metadata information
286		*
287		* @param string $entity
288		* @return EntityMetaData
289		*/
290		public function getMetaData(string $entity): EntityMetaData
291		{
292	16	$key = str_replace('\\', '.', $entity) . '.metadata';
293
294	16	if (!$this->cache->has($key)) {
295	16	$metaData = $this->metaDataFactory->getMetaData($entity);
296	16	$this->cache->set($key, $metaData);
297
298	16	return $metaData;
299		}
300
301	16	return $this->cache->get($key);
302		}
303		}
304

igniphp / storage

Push — master ( 583647...efdb33 )

EntityManager::remove() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like