MetadataFactory::getAllMetadata() - Code Metrics - as3io/modlr - Measure and Improve Code Quality continuously with Scrutinizer

MetadataFactory::getAllMetadata() A
last analyzed 2018-05-03 16:23 UTC

↳ Parent: MetadataFactory

Complexity

Conditions	2
Paths	2

Size

Total Lines	8
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	2
eloc	5
nc	2
nop	0

<?php

namespace As3\Modlr\Metadata;

use As3\Modlr\Exception\MetadataException;
use As3\Modlr\Metadata\Driver\DriverInterface;
use As3\Modlr\Metadata\Cache\CacheInterface;
use As3\Modlr\Util\EntityUtility;
use As3\Modlr\Exception\InvalidArgumentException;
use As3\Modlr\Events\EventDispatcher;

/**
 * The primary MetadataFactory service.
 * Returns EntityMetadata instances for supplied entity types.
 * Can also write and retrieve these instances from cache, if supplied.
 *
 * @author Jacob Bare <[email protected]>
 */
class MetadataFactory implements MetadataFactoryInterface
{
    /**
     * The Metadata driver.
     *
     * @var DriverInterface
     */
    private $driver;

    /**
     * Entity utility. Used for formatting and validation.
     *
     * @var EntityUtility
     */
    private $entityUtil;

    /**
     * The event dispatcher
     *
     * @var EventDispatcher
     */
    private $dispatcher;

    /**
     * The Metadata cache instance.
     * Is optional, if defined using the setter.
     *
     * @var CacheInterface|null
     */
    private $cache;

    /**
     * Flags whether metadata caching is enabled.
     *
     * @var bool
     */
    private $cacheEnabled = true;

    /**
     * In-memory loaded Metadata instances.
     *
     * @var EntityMetadata[]
     */
    private $loaded;

    /**
     * Constructor.
     *
     * @param   DriverInterface $driver
     * @param   EntityUtility   $entityUtil
     * @param   EventDispatcher $dispatcher
     */
    public function __construct(DriverInterface $driver, EntityUtility $entityUtil, EventDispatcher $dispatcher)
    {
        $this->driver = $driver;
        $this->entityUtil = $entityUtil;
        $this->dispatcher = $dispatcher;
    }

    /**
     * Sets the cache instance to use for reading/writing Metadata objects.
     *
     * @param   CacheInterface  $cache
     * @return  self
     */
    public function setCache(CacheInterface $cache)
    {
        $this->cache = $cache;
        return $this;
    }

    /**
     * Gets the cache instance.
     *
     * @return  CacheInterface|null
     */
    public function getCache()
    {
        return $this->cache;
    }

    /**
     * Enables or disables the cache.
     *
     * @param   bool    $bit
     * @return  self
     */
    public function enableCache($bit = true)
    {
        $this->cacheEnabled = (Boolean) $bit;
        return $this;
    }

    /**
     * Determines if cache is enbled.
     *
     * @return  bool
     */
    public function hasCache()
    {
        return null !== $this->getCache() && true === $this->cacheEnabled;
    }

    /**
     * {@inheritDoc}
     */
    public function getMetadataForType($type)
    {
        if (null !== $metadata = $this->doLoadMetadata($type)) {
            // Found in memory or from cache implementation
            return $metadata;
        }

        // Loop through the type hierarchy (extension) and merge metadata objects.
        foreach ($this->driver->getTypeHierarchy($type) as $hierType) {

            if (null !== $loaded = $this->doLoadMetadata($hierType)) {
                // Found in memory or from cache implementation
                $this->mergeMetadata($metadata, $loaded);
                continue;
            }

            // Load from driver source
            $loaded = $this->driver->loadMetadataForType($hierType);

            if (null === $loaded) {
                throw MetadataException::mappingNotFound($type);
            }

            // Validate the metadata object.
            $this->entityUtil->validateMetadata($hierType, $loaded, $this);

            // Handle persistence specific loading and validation.
            $this->loadPersistenceMetadata($loaded);

            // Handle search specific loading and validation.
            $this->loadSearchMetadata($loaded);

            $this->mergeMetadata($metadata, $loaded);
            $this->dispatchMetadataEvent(Events::onMetadataLoad, $loaded);
            $this->doPutMetadata($loaded);
        }

        if (null === $metadata) {
            throw MetadataException::mappingNotFound($type);
        }

        $this->doPutMetadata($metadata);
        return $metadata;
    }

    /**
     * Dispatches a Metadata event
     *
     * @param   string          $eventName
     * @param   EntityMetadata  $metadata
     */
    private function dispatchMetadataEvent($eventName, EntityMetadata $metadata)
    {
        $metadataArgs = new Events\MetadataArguments($metadata);
        $this->dispatcher->dispatch($eventName, $metadataArgs);
    }

    /**
     * {@inheritDoc}
     */
    public function getAllTypeNames()
    {
        return $this->driver->getAllTypeNames();
    }

    /**
     * {@inheritDoc}
     */
    public function getAllMetadata()
    {
        $metadatas = [];
        foreach ($this->getAllTypeNames() as $type) {
            $metadatas[] = $this->getMetadataForType($type);
        }
        return $metadatas;
    }

    /**
     * {@inheritDoc}
     */
    public function metadataExists($type)
    {
        if (null !== $metadata = $this->doLoadMetadata($type)) {
            // Found in memory or from cache implementation
            return true;
        }
        return null !== $this->driver->loadMetadataForType($type);
    }

    /**
     * Determines if a type is direct child of another type.
     *
     * @param   string  $child
     * @param   string  $parent
     * @return  bool
     */
    public function isChildOf($child, $parent)
    {
        $childMeta = $this->getMetadataForType($child);
        if (false === $childMeta->isChildEntity()) {
            return false;
        }
        return $childMeta->getParentEntityType() === $parent;
    }

    /**
     * Determines if a type is an ancestor of another type.
     *
     * @param   string  $parent
     * @param   string  $child
     * @return  bool
     */
    public function isAncestorOf($parent, $child)
    {
        return $this->isDescendantOf($child, $parent);
    }

    /**
     * Determines if a type is a descendant of another type.
     *
     * @param   string  $child
     * @param   string  $parent
     * @return  bool
     */
    public function isDescendantOf($child, $parent)
    {
        $childMeta = $this->getMetadataForType($child);
        if (false === $childMeta->isChildEntity()) {
            return false;
        }
        if ($childMeta->getParentEntityType() === $parent) {
            return true;
        }
        return $this->isDescendantOf($childMeta->getParentEntityType(), $parent);
    }

    /**
     * @param   string  $parentType
     * @param   string  $childType
     * @return  bool
     * @throws  InvalidArgumentException
     */
    public function validateResourceTypes($parentType, $childType)
    {
        $meta = $this->getMetadataForType($parentType);
        if (true === $meta->isPolymorphic()) {
            if (true === $meta->isAbstract() && false === $this->isDescendantOf($childType, $parentType)) {
                throw new InvalidArgumentException(sprintf('The resource type "%s" is polymorphic and abstract. Resource "%s" must be a descendent of "%s"', $parentType, $childType, $parentType));
            }
        }

        if (false === $meta->isPolymorphic() && $parentType !== $childType) {
            throw new InvalidArgumentException(sprintf('This resource only supports resources of type "%s" - resource type "%s" was provided', $parentType, $childType));
        }
        return true;
    }

    /**
     * Handles persistence specific metadata loading.
     *
     * @param   EntityMetadata  $metadata
     * @return  EntityMetadata
     */
    private function loadPersistenceMetadata(EntityMetadata $metadata)
    {
        $persisterKey = $metadata->persistence->getKey();
        $persistenceFactory = $this->driver->getPersistenceMetadataFactory($persisterKey);

        $persistenceFactory->handleLoad($metadata);
        $persistenceFactory->handleValidate($metadata);
        return $metadata;
    }

    /**
     * Handles search specific metadata loading.
     *
     * @param   EntityMetadata  $metadata
     * @return  EntityMetadata
     */
    private function loadSearchMetadata(EntityMetadata $metadata)
    {
        if (false === $metadata->isSearchEnabled()) {
            return $metadata;
        }
        $clientKey = $metadata->search->getKey();
        $searchFactory = $this->driver->getSearchMetadataFactory($clientKey);

        $searchFactory->handleLoad($metadata);
        $searchFactory->handleValidate($metadata);
        return $metadata;
    }

    /**
     * Merges two sets of EntityMetadata.
     * Is used for applying inheritance information.
     *
     * @param   EntityMetadata  &$metadata
     * @param   EntityMetadata  $toAdd
     */
    private function mergeMetadata(EntityMetadata &$metadata = null, EntityMetadata $toAdd)
    {
        if (null === $metadata) {
            $metadata = clone $toAdd;
        } else {
            $metadata->merge($toAdd);
        }
    }

    /**
     * Attempts to load a Metadata instance from a memory or cache source.
     *
     * @param   string  $type
     * @return  EntityMetadata|null
     */
    private function doLoadMetadata($type)
    {
        if (null !== $meta = $this->getFromMemory($type)) {
            $this->dispatchMetadataEvent(Events::onMetadataCacheLoad, $meta);
            // Found in memory.
            return $meta;
        }

        if (null !== $meta = $this->getFromCache($type)) {
            // Found in cache.
            $this->dispatchMetadataEvent(Events::onMetadataCacheLoad, $meta);
            $this->setToMemory($meta);
            return $meta;
        }
        return null;
    }

    /**
     * Puts the Metadata instance into a cache source (if set) and memory.
     *
     * @param   EntityMetadata  $metadata
     * @return  self
     */
    private function doPutMetadata(EntityMetadata $metadata)
    {
        if (true === $this->hasCache()) {
            $this->cache->putMetadataInCache($metadata);
        }
        $this->setToMemory($metadata);
        return $this;
    }

    /**
     * Clears any loaded metadata objects from memory.
     *
     * @return  self
     */
    public function clearMemory()
    {
        $this->loaded = [];
        return $this;
    }

    /**
     * Gets a Metadata instance for a type from memory.
     *
     * @param   string  $type
     * @return  EntityMetadata|null
     */
    private function getFromMemory($type)
    {
        if (isset($this->loaded[$type])) {
            return $this->loaded[$type];
        }
        return null;
    }

    /**
     * Sets a Metadata instance to the memory cache.
     *
     * @param   EntityMetadata  $metadata
     * @return  self
     */
    private function setToMemory(EntityMetadata $metadata)
    {
        $this->loaded[$metadata->type] = $metadata;
        return $this;
    }

    /**
     * Retrieves a Metadata instance for a type from cache.
     *
     * @param   string  $type
     * @return  EntityMetadata|null
     */
    private function getFromCache($type)
    {
        if (false === $this->hasCache()) {
            return null;
        }
        return $this->cache->loadMetadataFromCache($type);
    }
}


1			<?php
2
3			namespace As3\Modlr\Metadata;
4
5			use As3\Modlr\Exception\MetadataException;
6			use As3\Modlr\Metadata\Driver\DriverInterface;
7			use As3\Modlr\Metadata\Cache\CacheInterface;
8			use As3\Modlr\Util\EntityUtility;
9			use As3\Modlr\Exception\InvalidArgumentException;
10			use As3\Modlr\Events\EventDispatcher;
11
12			/**
13			* The primary MetadataFactory service.
14			* Returns EntityMetadata instances for supplied entity types.
15			* Can also write and retrieve these instances from cache, if supplied.
16			*
17			* @author Jacob Bare <[email protected]>
18			*/
19			class MetadataFactory implements MetadataFactoryInterface
20			{
21			/**
22			* The Metadata driver.
23			*
24			* @var DriverInterface
25			*/
26			private $driver;
27
28			/**
29			* Entity utility. Used for formatting and validation.
30			*
31			* @var EntityUtility
32			*/
33			private $entityUtil;
34
35			/**
36			* The event dispatcher
37			*
38			* @var EventDispatcher
39			*/
40			private $dispatcher;
41
42			/**
43			* The Metadata cache instance.
44			* Is optional, if defined using the setter.
45			*
46			* @var CacheInterface\|null
47			*/
48			private $cache;
49
50			/**
51			* Flags whether metadata caching is enabled.
52			*
53			* @var bool
54			*/
55			private $cacheEnabled = true;
56
57			/**
58			* In-memory loaded Metadata instances.
59			*
60			* @var EntityMetadata[]
61			*/
62			private $loaded;
63
64			/**
65			* Constructor.
66			*
67			* @param DriverInterface $driver
68			* @param EntityUtility $entityUtil
69			* @param EventDispatcher $dispatcher
70			*/
71			public function __construct(DriverInterface $driver, EntityUtility $entityUtil, EventDispatcher $dispatcher)
72			{
73			$this->driver = $driver;
74			$this->entityUtil = $entityUtil;
75			$this->dispatcher = $dispatcher;
76			}
77
78			/**
79			* Sets the cache instance to use for reading/writing Metadata objects.
80			*
81			* @param CacheInterface $cache
82			* @return self
83			*/
84			public function setCache(CacheInterface $cache)
85			{
86			$this->cache = $cache;
87			return $this;
88			}
89
90			/**
91			* Gets the cache instance.
92			*
93			* @return CacheInterface\|null
94			*/
95			public function getCache()
96			{
97			return $this->cache;
98			}
99
100			/**
101			* Enables or disables the cache.
102			*
103			* @param bool $bit
104			* @return self
105			*/
106			public function enableCache($bit = true)
107			{
108			$this->cacheEnabled = (Boolean) $bit;
109			return $this;
110			}
111
112			/**
113			* Determines if cache is enbled.
114			*
115			* @return bool
116			*/
117			public function hasCache()
118			{
119			return null !== $this->getCache() && true === $this->cacheEnabled;
120			}
121
122			/**
123			* {@inheritDoc}
124			*/
125			public function getMetadataForType($type)
126			{
127			if (null !== $metadata = $this->doLoadMetadata($type)) {
128			// Found in memory or from cache implementation
129			return $metadata;
130			}
131
132			// Loop through the type hierarchy (extension) and merge metadata objects.
133			foreach ($this->driver->getTypeHierarchy($type) as $hierType) {
134
135			if (null !== $loaded = $this->doLoadMetadata($hierType)) {
136			// Found in memory or from cache implementation
137			$this->mergeMetadata($metadata, $loaded);
138			continue;
139			}
140
141			// Load from driver source
142			$loaded = $this->driver->loadMetadataForType($hierType);
143
144			if (null === $loaded) {
145			throw MetadataException::mappingNotFound($type);
146			}
147
148			// Validate the metadata object.
149			$this->entityUtil->validateMetadata($hierType, $loaded, $this);
150
151			// Handle persistence specific loading and validation.
152			$this->loadPersistenceMetadata($loaded);
153
154			// Handle search specific loading and validation.
155			$this->loadSearchMetadata($loaded);
156
157			$this->mergeMetadata($metadata, $loaded);
158			$this->dispatchMetadataEvent(Events::onMetadataLoad, $loaded);
159			$this->doPutMetadata($loaded);
160			}
161
162			if (null === $metadata) {
163			throw MetadataException::mappingNotFound($type);
164			}
165
166			$this->doPutMetadata($metadata);
167			return $metadata;
168			}
169
170			/**
171			* Dispatches a Metadata event
172			*
173			* @param string $eventName
174			* @param EntityMetadata $metadata
175			*/
176			private function dispatchMetadataEvent($eventName, EntityMetadata $metadata)
177			{
178			$metadataArgs = new Events\MetadataArguments($metadata);
179			$this->dispatcher->dispatch($eventName, $metadataArgs);
180			}
181
182			/**
183			* {@inheritDoc}
184			*/
185			public function getAllTypeNames()
186			{
187			return $this->driver->getAllTypeNames();
188			}
189
190			/**
191			* {@inheritDoc}
192			*/
193			public function getAllMetadata()
194			{
195			$metadatas = [];
196			foreach ($this->getAllTypeNames() as $type) {
197			$metadatas[] = $this->getMetadataForType($type);
198			}
199			return $metadatas;
200			}
201
202			/**
203			* {@inheritDoc}
204			*/
205			public function metadataExists($type)
206			{
207			if (null !== $metadata = $this->doLoadMetadata($type)) {
208			// Found in memory or from cache implementation
209			return true;
210			}
211			return null !== $this->driver->loadMetadataForType($type);
212			}
213
214			/**
215			* Determines if a type is direct child of another type.
216			*
217			* @param string $child
218			* @param string $parent
219			* @return bool
220			*/
221			public function isChildOf($child, $parent)
222			{
223			$childMeta = $this->getMetadataForType($child);
224			if (false === $childMeta->isChildEntity()) {
225			return false;
226			}
227			return $childMeta->getParentEntityType() === $parent;
228			}
229
230			/**
231			* Determines if a type is an ancestor of another type.
232			*
233			* @param string $parent
234			* @param string $child
235			* @return bool
236			*/
237			public function isAncestorOf($parent, $child)
238			{
239			return $this->isDescendantOf($child, $parent);
240			}
241
242			/**
243			* Determines if a type is a descendant of another type.
244			*
245			* @param string $child
246			* @param string $parent
247			* @return bool
248			*/
249			public function isDescendantOf($child, $parent)
250			{
251			$childMeta = $this->getMetadataForType($child);
252			if (false === $childMeta->isChildEntity()) {
253			return false;
254			}
255			if ($childMeta->getParentEntityType() === $parent) {
256			return true;
257			}
258			return $this->isDescendantOf($childMeta->getParentEntityType(), $parent);
259			}
260
261			/**
262			* @param string $parentType
263			* @param string $childType
264			* @return bool
265			* @throws InvalidArgumentException
266			*/
267			public function validateResourceTypes($parentType, $childType)
268			{
269			$meta = $this->getMetadataForType($parentType);
270			if (true === $meta->isPolymorphic()) {
271			if (true === $meta->isAbstract() && false === $this->isDescendantOf($childType, $parentType)) {
272			throw new InvalidArgumentException(sprintf('The resource type "%s" is polymorphic and abstract. Resource "%s" must be a descendent of "%s"', $parentType, $childType, $parentType));
273			}
274			}
275
276			if (false === $meta->isPolymorphic() && $parentType !== $childType) {
277			throw new InvalidArgumentException(sprintf('This resource only supports resources of type "%s" - resource type "%s" was provided', $parentType, $childType));
278			}
279			return true;
280			}
281
282			/**
283			* Handles persistence specific metadata loading.
284			*
285			* @param EntityMetadata $metadata
286			* @return EntityMetadata
287			*/
288			private function loadPersistenceMetadata(EntityMetadata $metadata)
289			{
290			$persisterKey = $metadata->persistence->getKey();
291			$persistenceFactory = $this->driver->getPersistenceMetadataFactory($persisterKey);
292
293			$persistenceFactory->handleLoad($metadata);
294			$persistenceFactory->handleValidate($metadata);
295			return $metadata;
296			}
297
298			/**
299			* Handles search specific metadata loading.
300			*
301			* @param EntityMetadata $metadata
302			* @return EntityMetadata
303			*/
304			private function loadSearchMetadata(EntityMetadata $metadata)
305			{
306			if (false === $metadata->isSearchEnabled()) {
307			return $metadata;
308			}
309			$clientKey = $metadata->search->getKey();
310			$searchFactory = $this->driver->getSearchMetadataFactory($clientKey);
311
312			$searchFactory->handleLoad($metadata);
313			$searchFactory->handleValidate($metadata);
314			return $metadata;
315			}
316
317			/**
318			* Merges two sets of EntityMetadata.
319			* Is used for applying inheritance information.
320			*
321			* @param EntityMetadata &$metadata
322			* @param EntityMetadata $toAdd
323			*/
324			private function mergeMetadata(EntityMetadata &$metadata = null, EntityMetadata $toAdd)
325			{
326			if (null === $metadata) {
327			$metadata = clone $toAdd;
328			} else {
329			$metadata->merge($toAdd);
330			}
331			}
332
333			/**
334			* Attempts to load a Metadata instance from a memory or cache source.
335			*
336			* @param string $type
337			* @return EntityMetadata\|null
338			*/
339			private function doLoadMetadata($type)
340			{
341			if (null !== $meta = $this->getFromMemory($type)) {
342			$this->dispatchMetadataEvent(Events::onMetadataCacheLoad, $meta);
343			// Found in memory.
344			return $meta;
345			}
346
347			if (null !== $meta = $this->getFromCache($type)) {
348			// Found in cache.
349			$this->dispatchMetadataEvent(Events::onMetadataCacheLoad, $meta);
350			$this->setToMemory($meta);
351			return $meta;
352			}
353			return null;
354			}
355
356			/**
357			* Puts the Metadata instance into a cache source (if set) and memory.
358			*
359			* @param EntityMetadata $metadata
360			* @return self
361			*/
362			private function doPutMetadata(EntityMetadata $metadata)
363			{
364			if (true === $this->hasCache()) {
365			$this->cache->putMetadataInCache($metadata);
366			}
367			$this->setToMemory($metadata);
368			return $this;
369			}
370
371			/**
372			* Clears any loaded metadata objects from memory.
373			*
374			* @return self
375			*/
376			public function clearMemory()
377			{
378			$this->loaded = [];
379			return $this;
380			}
381
382			/**
383			* Gets a Metadata instance for a type from memory.
384			*
385			* @param string $type
386			* @return EntityMetadata\|null
387			*/
388			private function getFromMemory($type)
389			{
390			if (isset($this->loaded[$type])) {
391			return $this->loaded[$type];
392			}
393			return null;
394			}
395
396			/**
397			* Sets a Metadata instance to the memory cache.
398			*
399			* @param EntityMetadata $metadata
400			* @return self
401			*/
402			private function setToMemory(EntityMetadata $metadata)
403			{
404			$this->loaded[$metadata->type] = $metadata;
405			return $this;
406			}
407
408			/**
409			* Retrieves a Metadata instance for a type from cache.
410			*
411			* @param string $type
412			* @return EntityMetadata\|null
413			*/
414			private function getFromCache($type)
415			{
416			if (false === $this->hasCache()) {
417			return null;
418			}
419			return $this->cache->loadMetadataFromCache($type);
420			}
421			}
422

as3io / modlr

MetadataFactory::getAllMetadata() A last analyzed 2018-05-03 16:23 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

MetadataFactory::getAllMetadata() A
last analyzed 2018-05-03 16:23 UTC