MetadataBuilder::validateDataItem() - Code Metrics - Inspection of "jms-serializer-module-2 Добавить в jms-serializer..." - nnx-framework/jms-serializer-module - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 99ca87...95904e )

by Andrey

created 2016-06-18 17:37 UTC

MetadataBuilder::validateDataItem() C

↳ Parent: MetadataBuilder

Complexity

Conditions	7
Paths	11

Size

Total Lines	29
Code Lines	17

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	29
rs	6.7272
cc	7
eloc	17
nc	11
nop	2

<?php
/**
 * @link    https://github.com/nnx-framework/doctrine-fixture-module
 * @author  Malofeykin Andrey  <[email protected]>
 */
namespace Nnx\JmsSerializerModule\DoctrineObjectEngine;

use Doctrine\Common\Persistence\ObjectManager;
use Nnx\JmsSerializerModule\DataContainer;

/**
 * Class MetadataBuilder
 *
 * @package Nnx\JmsSerializerModule\DoctrineObjectEngine
 */
class MetadataBuilder implements MetadataBuilderInterface
{
    /**
     * Контейнер с данными для фикстуры
     *
     * @var DataContainer\DataContainerInterface
     */
    private $dataContainer;

    /**
     * Менеджер доктрины
     *
     * @var ObjectManager
     */
    private $objectManager;

    /**
     * @var MetadataInterface
     */
    private $metadata;

    /**
     * @var MetadataInterface
     */
    protected $metadataPrototype;

    /**
     * MetadataBuilder constructor.
     *
     * @param MetadataInterface $metadataPrototype
     */
    public function __construct(MetadataInterface $metadataPrototype)
    {
        $this->metadataPrototype = $metadataPrototype;
    }

    /**
     * Подготавливает метаданные
     *
     * @param DataContainer\DataContainerInterface $dataContainer
     * @param                        $entityClassName
     * @param ObjectManager          $objectManager
     *
     * @return MetadataInterface
     * @throws \Nnx\JmsSerializerModule\DoctrineObjectEngine\Exception\RuntimeException
     */
    public function buildMetadata(DataContainer\DataContainerInterface $dataContainer, $entityClassName, ObjectManager $objectManager)
    {
        $this->dataContainer = $dataContainer;
        $this->objectManager = $objectManager;
        $this->metadata = clone $this->metadataPrototype;

        $entities = $dataContainer->getEntities();

        foreach ($entities as $dataItem) {
            $this->buildMetadataForDataContainer($dataItem, $entityClassName);
        }


        return $this->metadata;
    }

    /**
     * Подготавливает метаданные для сущности
     *
     * @param DataContainer\EntityInterface $dataItem
     * @param        $entityClassName
     *
     * @throws \Nnx\JmsSerializerModule\DoctrineObjectEngine\Exception\RuntimeException
     */
    protected function buildMetadataForDataContainer(DataContainer\EntityInterface $dataItem, $entityClassName)
    {
        $this->metadata->linkDataContainerToEntityClassName($dataItem, $entityClassName);

        $dataItemAssociations = $dataItem->getAssociations();

        $entityMetadata = $this->objectManager->getClassMetadata($entityClassName);

        foreach ($dataItemAssociations as $dataItemAssociation) {
            $associationDataItems = $dataItemAssociation->getEntities();
            $associationName = $dataItemAssociation->getName();

            $associationTargetClass = $entityMetadata->getAssociationTargetClass($associationName);

            foreach ($associationDataItems as $associationDataItem) {
                $this->buildReverseAssociationMetadata($associationDataItem, $associationTargetClass, $dataItemAssociation);
                $this->metadata->addAssociationInfo($dataItem, $associationDataItem, $dataItemAssociation);
                $this->buildMetadataForDataContainer($associationDataItem, $associationTargetClass);
            }
        }
    }

    /**
     * Добавляет метаданные для двухсторонних ассоциаций
     *
     * @param DataContainer\EntityInterface      $childEntity
     * @param             $childEntityClassName
     * @param DataContainer\Association $targetAssociation
     */
    protected function buildReverseAssociationMetadata(DataContainer\EntityInterface $childEntity, $childEntityClassName, DataContainer\Association $targetAssociation)
    {
        $childEntityMetadata = $this->objectManager->getClassMetadata($childEntityClassName);
        $childEntityAssociationNames = $childEntityMetadata->getAssociationNames();

        $targetAssociationName = $targetAssociation->getName();
        foreach ($childEntityAssociationNames as $childEntityAssociationName) {
            if ($childEntityMetadata->isAssociationInverseSide($childEntityAssociationName)) {
                $associationMappedByTargetField = $childEntityMetadata->getAssociationMappedByTargetField($childEntityAssociationName);

                if ($associationMappedByTargetField === $targetAssociationName) {
                    $this->metadata->addReverseAssociationInfo($childEntity, $childEntity->getParentEntity(), $childEntityAssociationName);
/** @return stdClass|null */
function mayReturnNull() { }

function doesNotAcceptNull(stdClass $x) { }

// With potential error.
function withoutCheck() {
    $x = mayReturnNull();
    doesNotAcceptNull($x); // Potential error here.
}

// Safe - Alternative 1
function withCheck1() {
    $x = mayReturnNull();
    if ( ! $x instanceof stdClass) {
        throw new \LogicException('$x must be defined.');
    }
    doesNotAcceptNull($x);
}

// Safe - Alternative 2
function withCheck2() {
    $x = mayReturnNull();
    if ($x instanceof stdClass) {
        doesNotAcceptNull($x);
    }
}
                }
            }
        }
    }


    /**
     * Проверка контейнера с данными
     *
     * @param DataContainer\EntityInterface $dataItem
     * @param        $entityClassName
     *
     * @return void
     * @throws \Nnx\JmsSerializerModule\DoctrineObjectEngine\Exception\RuntimeException
     */
    protected function validateDataItem(DataContainer\EntityInterface $dataItem, $entityClassName)
    {
        $dataItemAssociations = $dataItem->getAssociations();
        $properties = $dataItem->getProperties();

        $entityMetadata = $this->objectManager->getClassMetadata($entityClassName);
        foreach ($properties as $property) {
            $propertyName = $property->getName();

            if (!$entityMetadata->hasField($propertyName)) {
                $errMsg = sprintf('Property %s not found in %s', $propertyName, $entityClassName);
                throw new Exception\RuntimeException($errMsg);
            }
        }

        foreach ($dataItemAssociations as $dataItemAssociation) {
            $dataItemAssociationName = $dataItemAssociation->getName();

            if (!$entityMetadata->hasAssociation($dataItemAssociationName)) {
                $errMsg = sprintf('Association %s not found in %s', $dataItemAssociationName, $entityClassName);
                throw new Exception\RuntimeException($errMsg);
            }
        }

        if (0 === count($dataItemAssociations) && 0 === count($properties)) {
            $errMsg = sprintf('Data container id:%s is empty', $dataItem->getId());
            throw new Exception\RuntimeException($errMsg);
        }
    }
}


1			<?php
2			/**
3			* @link https://github.com/nnx-framework/doctrine-fixture-module
4			* @author Malofeykin Andrey <[email protected]>
5			*/
6			namespace Nnx\JmsSerializerModule\DoctrineObjectEngine;
7
8			use Doctrine\Common\Persistence\ObjectManager;
9			use Nnx\JmsSerializerModule\DataContainer;
10
11			/**
12			* Class MetadataBuilder
13			*
14			* @package Nnx\JmsSerializerModule\DoctrineObjectEngine
15			*/
16			class MetadataBuilder implements MetadataBuilderInterface
17			{
18			/**
19			* Контейнер с данными для фикстуры
20			*
21			* @var DataContainer\DataContainerInterface
22			*/
23			private $dataContainer;
24
25			/**
26			* Менеджер доктрины
27			*
28			* @var ObjectManager
29			*/
30			private $objectManager;
31
32			/**
33			* @var MetadataInterface
34			*/
35			private $metadata;
36
37			/**
38			* @var MetadataInterface
39			*/
40			protected $metadataPrototype;
41
42			/**
43			* MetadataBuilder constructor.
44			*
45			* @param MetadataInterface $metadataPrototype
46			*/
47			public function __construct(MetadataInterface $metadataPrototype)
48			{
49			$this->metadataPrototype = $metadataPrototype;
50			}
51
52			/**
53			* Подготавливает метаданные
54			*
55			* @param DataContainer\DataContainerInterface $dataContainer
56			* @param $entityClassName
57			* @param ObjectManager $objectManager
58			*
59			* @return MetadataInterface
60			* @throws \Nnx\JmsSerializerModule\DoctrineObjectEngine\Exception\RuntimeException
61			*/
62			public function buildMetadata(DataContainer\DataContainerInterface $dataContainer, $entityClassName, ObjectManager $objectManager)
63			{
64			$this->dataContainer = $dataContainer;
65			$this->objectManager = $objectManager;
66			$this->metadata = clone $this->metadataPrototype;
67
68			$entities = $dataContainer->getEntities();
69
70			foreach ($entities as $dataItem) {
71			$this->buildMetadataForDataContainer($dataItem, $entityClassName);
72			}
73
74
75			return $this->metadata;
76			}
77
78			/**
79			* Подготавливает метаданные для сущности
80			*
81			* @param DataContainer\EntityInterface $dataItem
82			* @param $entityClassName
83			*
84			* @throws \Nnx\JmsSerializerModule\DoctrineObjectEngine\Exception\RuntimeException
85			*/
86			protected function buildMetadataForDataContainer(DataContainer\EntityInterface $dataItem, $entityClassName)
87			{
88			$this->metadata->linkDataContainerToEntityClassName($dataItem, $entityClassName);
89
90			$dataItemAssociations = $dataItem->getAssociations();
91
92			$entityMetadata = $this->objectManager->getClassMetadata($entityClassName);
93
94			foreach ($dataItemAssociations as $dataItemAssociation) {
95			$associationDataItems = $dataItemAssociation->getEntities();
96			$associationName = $dataItemAssociation->getName();
97
98			$associationTargetClass = $entityMetadata->getAssociationTargetClass($associationName);
99
100			foreach ($associationDataItems as $associationDataItem) {
101			$this->buildReverseAssociationMetadata($associationDataItem, $associationTargetClass, $dataItemAssociation);
102			$this->metadata->addAssociationInfo($dataItem, $associationDataItem, $dataItemAssociation);
103			$this->buildMetadataForDataContainer($associationDataItem, $associationTargetClass);
104			}
105			}
106			}
107
108			/**
109			* Добавляет метаданные для двухсторонних ассоциаций
110			*
111			* @param DataContainer\EntityInterface $childEntity
112			* @param $childEntityClassName
113			* @param DataContainer\Association $targetAssociation
114			*/
115			protected function buildReverseAssociationMetadata(DataContainer\EntityInterface $childEntity, $childEntityClassName, DataContainer\Association $targetAssociation)
116			{
117			$childEntityMetadata = $this->objectManager->getClassMetadata($childEntityClassName);
118			$childEntityAssociationNames = $childEntityMetadata->getAssociationNames();
119
120			$targetAssociationName = $targetAssociation->getName();
121			foreach ($childEntityAssociationNames as $childEntityAssociationName) {
122			if ($childEntityMetadata->isAssociationInverseSide($childEntityAssociationName)) {
123			$associationMappedByTargetField = $childEntityMetadata->getAssociationMappedByTargetField($childEntityAssociationName);
124
125			if ($associationMappedByTargetField === $targetAssociationName) {
126			$this->metadata->addReverseAssociationInfo($childEntity, $childEntity->getParentEntity(), $childEntityAssociationName);
			0 ignored issues – show Bug introduced 2016-06-18 18:00 UTC by Report Bug Copy Issue Report It seems like `$childEntity->getParentEntity()` can be `null`; however, `addReverseAssociationInfo()` does not accept `null`, maybe add an additional type check? Unless you are absolutely sure that the expression can never be null because of other conditions, we strongly recommend to add an additional type check to your code: /** @return stdClass\|null */ function mayReturnNull() { } function doesNotAcceptNull(stdClass $x) { } // With potential error. function withoutCheck() { $x = mayReturnNull(); doesNotAcceptNull($x); // Potential error here. } // Safe - Alternative 1 function withCheck1() { $x = mayReturnNull(); if ( ! $x instanceof stdClass) { throw new \LogicException('$x must be defined.'); } doesNotAcceptNull($x); } // Safe - Alternative 2 function withCheck2() { $x = mayReturnNull(); if ($x instanceof stdClass) { doesNotAcceptNull($x); } } Loading history...
127			}
128			}
129			}
130			}
131
132
133			/**
134			* Проверка контейнера с данными
135			*
136			* @param DataContainer\EntityInterface $dataItem
137			* @param $entityClassName
138			*
139			* @return void
140			* @throws \Nnx\JmsSerializerModule\DoctrineObjectEngine\Exception\RuntimeException
141			*/
142			protected function validateDataItem(DataContainer\EntityInterface $dataItem, $entityClassName)
143			{
144			$dataItemAssociations = $dataItem->getAssociations();
145			$properties = $dataItem->getProperties();
146
147			$entityMetadata = $this->objectManager->getClassMetadata($entityClassName);
148			foreach ($properties as $property) {
149			$propertyName = $property->getName();
150
151			if (!$entityMetadata->hasField($propertyName)) {
152			$errMsg = sprintf('Property %s not found in %s', $propertyName, $entityClassName);
153			throw new Exception\RuntimeException($errMsg);
154			}
155			}
156
157			foreach ($dataItemAssociations as $dataItemAssociation) {
158			$dataItemAssociationName = $dataItemAssociation->getName();
159
160			if (!$entityMetadata->hasAssociation($dataItemAssociationName)) {
161			$errMsg = sprintf('Association %s not found in %s', $dataItemAssociationName, $entityClassName);
162			throw new Exception\RuntimeException($errMsg);
163			}
164			}
165
166			if (0 === count($dataItemAssociations) && 0 === count($properties)) {
167			$errMsg = sprintf('Data container id:%s is empty', $dataItem->getId());
168			throw new Exception\RuntimeException($errMsg);
169			}
170			}
171			}
172

nnx-framework / jms-serializer-module

Push — master ( 99ca87...95904e )

MetadataBuilder::validateDataItem() C

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like