StorageMetadataFactory::validateDatabase() - Code Metrics - Inspection of "Update metadata to conform to new interface" - as3io/modlr-persister-mongodb - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#5)

by Jacob

created 2016-03-21 14:52 UTC

StorageMetadataFactory::validateDatabase() A

↳ Parent: StorageMetadataFactory

Complexity

Conditions	4
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	7
rs	9.2
cc	4
eloc	4
nc	2
nop	1

<?php

namespace As3\Modlr\Persister\MongoDb;

use As3\Modlr\Exception\MetadataException;
use As3\Modlr\Metadata\EntityMetadata;
use As3\Modlr\Metadata\Interfaces\StorageLayerInterface;
use As3\Modlr\Metadata\Interfaces\StorageMetadataFactoryInterface;
use As3\Modlr\Util\EntityUtility;

/**
 * Creates MongoDb storage Metadata instances for use with metadata drivers.
 * Is also responsible for validating storage objects.
 *
 * @author Jacob Bare <[email protected]>
 */
final class StorageMetadataFactory implements StorageMetadataFactoryInterface
{
    /**
     * @var EntityUtility
     */
    private $entityUtil;

    /**
     * Constructor.
     *
     * @param   EntityUtility   $entityUtl
/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}
     */
    public function __construct(EntityUtility $entityUtil)
    {
        $this->entityUtil = $entityUtil;
    }

    /**
     * {@inheritDoc}
     */
    public function createInstance(array $mapping)
    {
        $persistence = new StorageMetadata();

        if (isset($mapping['db'])) {
            $persistence->db = $mapping['db'];
        }

        if (isset($mapping['collection'])) {
            $persistence->collection = $mapping['collection'];
        }
        return $persistence;
    }

    /**
     * {@inheritDoc}
     */
    public function handleLoad(EntityMetadata $metadata)
    {
        if (null === $metadata->persistence->collection) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            $metadata->persistence->collection = $metadata->type;
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        }
    }

    /**
     * {@inheritDoc}
     */
    public function handleValidate(EntityMetadata $metadata)
    {
        $this->validateIdStrategy($metadata);
        $this->validateDatabase($metadata);
        $this->validateCollectionNaming($metadata);
    }



    /**
     * Validates that the collection naming is correct, based on entity format config.
     *
     * @param   EntityMetadata  $metadata
     * @throws  MetadataException
     */
    private function validateCollectionNaming(EntityMetadata $metadata)
    {
        $persistence = $metadata->persistence;
        if (false === $this->entityUtil->isEntityTypeValid($persistence->collection)) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            throw MetadataException::invalidMetadata(
                $metadata->type,
                sprintf('The entity persistence collection "%s" is invalid based on the configured name format "%s"',
                        $persistence->collection,
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
                        $this->entityUtil->getRestConfig()->getEntityFormat()
                )
            );
        }
    }

    /**
     * Validates that the proper database properties are set.
     *
     * @param   EntityMetadata  $metadata
     * @throws  MetadataException
     */
    private function validateDatabase(EntityMetadata $metadata)
    {
        $persistence = $metadata->persistence;
        if (false === $metadata->isChildEntity() && (empty($persistence->db) || empty($persistence->collection))) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            throw MetadataException::invalidMetadata($metadata->type, 'The persistence database and collection names cannot be empty.');
        }
    }

    /**
     * Validates the proper id strategy.
     *
     * @param   EntityMetadata  $metadata
     * @throws  MetadataException
     */
    private function validateIdStrategy(EntityMetadata $metadata)
    {
        $persistence = $metadata->persistence;
        $validIdStrategies = ['object'];
        if (!in_array($persistence->idStrategy, $validIdStrategies)) {
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
            throw MetadataException::invalidMetadata($metadata->type, sprintf('The persistence id strategy "%s" is invalid. Valid types are "%s"', $persistence->idStrategy, implode('", "', $validIdStrategies)));
interface SomeInterface { }
class SomeClass implements SomeInterface {
    public $a;
}

function someFunction(SomeInterface $object) {
    if ($object instanceof SomeClass) {
        $a = $object->a;
    }
}
        }
    }
}


1			<?php
2
3			namespace As3\Modlr\Persister\MongoDb;
4
5			use As3\Modlr\Exception\MetadataException;
6			use As3\Modlr\Metadata\EntityMetadata;
7			use As3\Modlr\Metadata\Interfaces\StorageLayerInterface;
8			use As3\Modlr\Metadata\Interfaces\StorageMetadataFactoryInterface;
9			use As3\Modlr\Util\EntityUtility;
10
11			/**
12			* Creates MongoDb storage Metadata instances for use with metadata drivers.
13			* Is also responsible for validating storage objects.
14			*
15			* @author Jacob Bare <[email protected]>
16			*/
17			final class StorageMetadataFactory implements StorageMetadataFactoryInterface
18			{
19			/**
20			* @var EntityUtility
21			*/
22			private $entityUtil;
23
24			/**
25			* Constructor.
26			*
27			* @param EntityUtility $entityUtl
			0 ignored issues – show Documentation introduced 2016-03-14 15:48 UTC by Report Bug Copy Issue Report There is no parameter named `$entityUtl`. Did you maybe mean `$entityUtil`? This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit. Consider the following example. The parameter `$ireland` is not defined by the method `finale(...)`. /** * @param array $germany * @param array $ireland */ function finale($germany, $island) { return "2:1"; } The most likely cause is that the parameter was changed, but the annotation was not. Loading history...
28			*/
29			public function __construct(EntityUtility $entityUtil)
30			{
31			$this->entityUtil = $entityUtil;
32			}
33
34			/**
35			* {@inheritDoc}
36			*/
37			public function createInstance(array $mapping)
38			{
39			$persistence = new StorageMetadata();
40
41			if (isset($mapping['db'])) {
42			$persistence->db = $mapping['db'];
43			}
44
45			if (isset($mapping['collection'])) {
46			$persistence->collection = $mapping['collection'];
47			}
48			return $persistence;
49			}
50
51			/**
52			* {@inheritDoc}
53			*/
54			public function handleLoad(EntityMetadata $metadata)
55			{
56			if (null === $metadata->persistence->collection) {
			0 ignored issues – show Bug introduced 2016-03-14 15:48 UTC by Report Bug Copy Issue Report Accessing `collection` on the interface `As3\Modlr\Metadata\Inter...s\StorageLayerInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
57			$metadata->persistence->collection = $metadata->type;
			0 ignored issues – show Bug introduced 2016-03-14 15:48 UTC by Report Bug Copy Issue Report Accessing `collection` on the interface `As3\Modlr\Metadata\Inter...s\StorageLayerInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
58			}
59			}
60
61			/**
62			* {@inheritDoc}
63			*/
64			public function handleValidate(EntityMetadata $metadata)
65			{
66			$this->validateIdStrategy($metadata);
67			$this->validateDatabase($metadata);
68			$this->validateCollectionNaming($metadata);
69			}
70
71
72
73			/**
74			* Validates that the collection naming is correct, based on entity format config.
75			*
76			* @param EntityMetadata $metadata
77			* @throws MetadataException
78			*/
79			private function validateCollectionNaming(EntityMetadata $metadata)
80			{
81			$persistence = $metadata->persistence;
82			if (false === $this->entityUtil->isEntityTypeValid($persistence->collection)) {
			0 ignored issues – show Bug introduced 2016-03-14 15:48 UTC by Report Bug Copy Issue Report Accessing `collection` on the interface `As3\Modlr\Metadata\Inter...s\StorageLayerInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
83			throw MetadataException::invalidMetadata(
84			$metadata->type,
85			sprintf('The entity persistence collection "%s" is invalid based on the configured name format "%s"',
86			$persistence->collection,
			0 ignored issues – show Bug introduced 2016-03-14 15:48 UTC by Report Bug Copy Issue Report Accessing `collection` on the interface `As3\Modlr\Metadata\Inter...s\StorageLayerInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
87			$this->entityUtil->getRestConfig()->getEntityFormat()
88			)
89			);
90			}
91			}
92
93			/**
94			* Validates that the proper database properties are set.
95			*
96			* @param EntityMetadata $metadata
97			* @throws MetadataException
98			*/
99			private function validateDatabase(EntityMetadata $metadata)
100			{
101			$persistence = $metadata->persistence;
102			if (false === $metadata->isChildEntity() && (empty($persistence->db) \|\| empty($persistence->collection))) {
			0 ignored issues – show Bug introduced 2016-03-14 15:48 UTC by Report Bug Copy Issue Report Accessing `db` on the interface `As3\Modlr\Metadata\Inter...s\StorageLayerInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history... Bug introduced 2016-03-14 15:48 UTC by Report Bug Copy Issue Report Accessing `collection` on the interface `As3\Modlr\Metadata\Inter...s\StorageLayerInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
103			throw MetadataException::invalidMetadata($metadata->type, 'The persistence database and collection names cannot be empty.');
104			}
105			}
106
107			/**
108			* Validates the proper id strategy.
109			*
110			* @param EntityMetadata $metadata
111			* @throws MetadataException
112			*/
113			private function validateIdStrategy(EntityMetadata $metadata)
114			{
115			$persistence = $metadata->persistence;
116			$validIdStrategies = ['object'];
117			if (!in_array($persistence->idStrategy, $validIdStrategies)) {
			0 ignored issues – show Bug introduced 2016-03-14 15:48 UTC by Report Bug Copy Issue Report Accessing `idStrategy` on the interface `As3\Modlr\Metadata\Inter...s\StorageLayerInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
118			throw MetadataException::invalidMetadata($metadata->type, sprintf('The persistence id strategy "%s" is invalid. Valid types are "%s"', $persistence->idStrategy, implode('", "', $validIdStrategies)));
			0 ignored issues – show Bug introduced 2016-03-14 15:48 UTC by Report Bug Copy Issue Report Accessing `idStrategy` on the interface `As3\Modlr\Metadata\Inter...s\StorageLayerInterface` suggest that you code against a concrete implementation. How about adding an `instanceof` check? If you access a property on an interface, you most likely code against a concrete implementation of the interface. Available Fixes Adding an additional type check: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeInterface $object) { if ($object instanceof SomeClass) { $a = $object->a; } } Changing the type hint: interface SomeInterface { } class SomeClass implements SomeInterface { public $a; } function someFunction(SomeClass $object) { $a = $object->a; } Loading history...
119			}
120			}
121			}
122

as3io / modlr-persister-mongodb

Pull Request — master (#5)

StorageMetadataFactory::validateDatabase() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like