MetadataGrapher::getClassByName() - Code Metrics - Inspection of "[git] Add .gitattributes to remove unneeded files" - doctrine/DoctrineORMModule - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 50808e...8a6350 )

by Gianluca

created 2016-07-03 14:20 UTC

MetadataGrapher::getClassByName() B

↳ Parent: MetadataGrapher

Complexity

Conditions	5
Paths	8

Size

Total Lines	13
Code Lines	7

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	5

Importance

Changes	2
Bugs	1	Features	0

Metric	Value
c	2
b	1
f	0
dl	0
loc	13
ccs	9
cts	9
cp	1
rs	8.8571
cc	5
eloc	7
nc	8
nop	1
crap	5

<?php
/*
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the MIT license. For more information, see
 * <http://www.doctrine-project.org>.
 */

namespace DoctrineORMModule\Yuml;

use Doctrine\Common\Persistence\Mapping\ClassMetadata;

/**
 * Utility to generate Yuml compatible strings from metadata graphs
 *
 * @license MIT
 * @link    http://www.doctrine-project.org/
 * @author  Marco Pivetta <[email protected]>
 */
class MetadataGrapher
{
    /**
     * Temporary array where already visited collections are stored
     *
     * @var array
     */
    protected $visitedAssociations = array();

    /**
     * @var \Doctrine\Common\Persistence\Mapping\ClassMetadata[]
     */
    private $metadata;

    /**
     * Temporary array where reverse association name are stored
     *
     * @var \Doctrine\Common\Persistence\Mapping\ClassMetadata[]
     */
    private $classByNames = array();

    /**
     * Generate a YUML compatible `dsl_text` to describe a given array
     * of entities
     *
     * @param  $metadata \Doctrine\Common\Persistence\Mapping\ClassMetadata[]
     *
     * @return string
     */
    public function generateFromMetadata(array $metadata)
    {
        $this->metadata            = $metadata;
        $this->visitedAssociations = array();
        $str                       = array();

        foreach ($metadata as $class) {
            $parent = $this->getParent($class);

            if ($parent) {
                $str[] = $this->getClassString($parent) . '^' . $this->getClassString($class);
            }

            $associations = $class->getAssociationNames();

            if (empty($associations) && !isset($this->visitedAssociations[$class->getName()])) {
                $str[] = $this->getClassString($class);

                continue;
            }

            foreach ($associations as $associationName) {
                if ($parent && in_array($associationName, $parent->getAssociationNames())) {
                    continue;
                }

                if ($this->visitAssociation($class->getName(), $associationName)) {
                    $str[] = $this->getAssociationString($class, $associationName);
                }
            }
        }

        return implode(',', $str);
    }

    /**
     * @param ClassMetadata $class1
     * @param string $association
     * @return string
     */
    private function getAssociationString(ClassMetadata $class1, $association)
    {
        $targetClassName = $class1->getAssociationTargetClass($association);
        $class2          = $this->getClassByName($targetClassName);
        $isInverse       = $class1->isAssociationInverseSide($association);
        $class1Count     = $class1->isCollectionValuedAssociation($association) ? 2 : 1;

        if (null === $class2) {
            return $this->getClassString($class1)
                . ($isInverse ? '<' : '<>') . '-' . $association . ' '
                . ($class1Count > 1 ? '*' : ($class1Count ? '1' : ''))
                . ($isInverse ? '<>' : '>')
                . '[' . str_replace('\\', '.', $targetClassName) . ']';
        }

        $class1SideName = $association;
        $class2SideName = $this->getClassReverseAssociationName($class1, $class2);
        $class2Count    = 0;
        $bidirectional  = false;

        if (null !== $class2SideName) {
            if ($isInverse) {
                $class2Count    = $class2->isCollectionValuedAssociation($class2SideName) ? 2 : 1;
                $bidirectional  = true;
            } elseif ($class2->isAssociationInverseSide($class2SideName)) {
                $class2Count    = $class2->isCollectionValuedAssociation($class2SideName) ? 2 : 1;
                $bidirectional  = true;
            }
        }

        $this->visitAssociation($targetClassName, $class2SideName);

        return $this->getClassString($class1)
            . ($bidirectional ? ($isInverse ? '<' : '<>') : '') // class2 side arrow
            . ($class2SideName ? $class2SideName . ' ' : '')
            . ($class2Count > 1 ? '*' : ($class2Count ? '1' : '')) // class2 side single/multi valued
            . '-'
            . $class1SideName . ' '
            . ($class1Count > 1 ? '*' : ($class1Count ? '1' : '')) // class1 side single/multi valued
            . (($bidirectional && $isInverse) ? '<>' : '>') // class1 side arrow
            . $this->getClassString($class2);
    }

    /**
     * @param ClassMetadata $class1
     * @param ClassMetadata $class2
     * @return string|null
     */
    private function getClassReverseAssociationName(ClassMetadata $class1, ClassMetadata $class2)
    {
        foreach ($class2->getAssociationNames() as $class2Side) {
            $targetClass = $this->getClassByName($class2->getAssociationTargetClass($class2Side));
            if ($class1->getName() === $targetClass->getName()) {
                return $class2Side;
            }
        }

        return null;
    }

    /**
     * Build the string representing the single graph item
     *
     * @param ClassMetadata   $class
     *
     * @return string
     */
    private function getClassString(ClassMetadata $class)
    {
        $this->visitAssociation($class->getName());

        $className    = $class->getName();
        $classText    = '[' . str_replace('\\', '.', $className);
        $fields       = array();
        $parent       = $this->getParent($class);
        $parentFields = $parent ? $parent->getFieldNames() : array();

        foreach ($class->getFieldNames() as $fieldName) {
            if (in_array($fieldName, $parentFields)) {
                continue;
            }

            if ($class->isIdentifier($fieldName)) {
                $fields[] = '+' . $fieldName;
            } else {
                $fields[] = $fieldName;
            }
        }

        if (!empty($fields)) {
            $classText .= '|' . implode(';', $fields);
        }

        $classText .= ']';

        return $classText;
    }

    /**
     * Retrieve a class metadata instance by name from the given array
     *
     * @param string          $className
     *
     * @return ClassMetadata|null
     */
    private function getClassByName($className)
    {
        if (!isset($this->classByNames[$className])) {
            foreach ($this->metadata as $class) {
                if ($class->getName() === $className) {
                    $this->classByNames[$className] = $class;
                    break;
                }
            }
        }

        return isset($this->classByNames[$className])? $this->classByNames[$className]: null;
    }

    /**
     * Retrieve a class metadata's parent class metadata
     *
     * @param ClassMetadata   $class
     *
     * @return ClassMetadata|null
     */
    private function getParent($class)
    {
        $className = $class->getName();

        if (!class_exists($className) || (!$parent = get_parent_class($className))) {
            return null;
        }

        return $this->getClassByName($parent);
    }

    /**
     * Visit a given association and mark it as visited
     *
     * @param string      $className
     * @param string|null $association
     *
     * @return bool true if the association was visited before
     */
    private function visitAssociation($className, $association = null)
    {
        if (null === $association) {
            if (isset($this->visitedAssociations[$className])) {
                return false;
            }

            $this->visitedAssociations[$className] = array();

            return true;
        }

        if (isset($this->visitedAssociations[$className][$association])) {
            return false;
        }

        if (!isset($this->visitedAssociations[$className])) {
            $this->visitedAssociations[$className] = array();
        }

        $this->visitedAssociations[$className][$association] = true;

        return true;
    }
}


1		<?php
2		/*
3		* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
4		* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
5		* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
6		* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
7		* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
8		* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
9		* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
10		* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
11		* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
12		* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
13		* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
14		*
15		* This software consists of voluntary contributions made by many individuals
16		* and is licensed under the MIT license. For more information, see
17		* <http://www.doctrine-project.org>.
18		*/
19
20		namespace DoctrineORMModule\Yuml;
21
22		use Doctrine\Common\Persistence\Mapping\ClassMetadata;
23
24		/**
25		* Utility to generate Yuml compatible strings from metadata graphs
26		*
27		* @license MIT
28		* @link http://www.doctrine-project.org/
29		* @author Marco Pivetta <[email protected]>
30		*/
31		class MetadataGrapher
32		{
33		/**
34		* Temporary array where already visited collections are stored
35		*
36		* @var array
37		*/
38		protected $visitedAssociations = array();
39
40		/**
41		* @var \Doctrine\Common\Persistence\Mapping\ClassMetadata[]
42		*/
43		private $metadata;
44
45		/**
46		* Temporary array where reverse association name are stored
47		*
48		* @var \Doctrine\Common\Persistence\Mapping\ClassMetadata[]
49		*/
50		private $classByNames = array();
51
52		/**
53		* Generate a YUML compatible `dsl_text` to describe a given array
54		* of entities
55		*
56		* @param $metadata \Doctrine\Common\Persistence\Mapping\ClassMetadata[]
57		*
58		* @return string
59		*/
60	21	public function generateFromMetadata(array $metadata)
61		{
62	21	$this->metadata = $metadata;
63	21	$this->visitedAssociations = array();
64	21	$str = array();
65
66	21	foreach ($metadata as $class) {
67	21	$parent = $this->getParent($class);
68
69	21	if ($parent) {
70	3	$str[] = $this->getClassString($parent) . '^' . $this->getClassString($class);
71	3	}
72
73	21	$associations = $class->getAssociationNames();
74
75	21	if (empty($associations) && !isset($this->visitedAssociations[$class->getName()])) {
76	3	$str[] = $this->getClassString($class);
77
78	3	continue;
79		}
80
81	19	foreach ($associations as $associationName) {
82	17	if ($parent && in_array($associationName, $parent->getAssociationNames())) {
83	1	continue;
84		}
85
86	17	if ($this->visitAssociation($class->getName(), $associationName)) {
87	17	$str[] = $this->getAssociationString($class, $associationName);
88	17	}
89	19	}
90	21	}
91
92	21	return implode(',', $str);
93		}
94
95		/**
96		* @param ClassMetadata $class1
97		* @param string $association
98		* @return string
99		*/
100	17	private function getAssociationString(ClassMetadata $class1, $association)
101		{
102	17	$targetClassName = $class1->getAssociationTargetClass($association);
103	17	$class2 = $this->getClassByName($targetClassName);
104	17	$isInverse = $class1->isAssociationInverseSide($association);
105	17	$class1Count = $class1->isCollectionValuedAssociation($association) ? 2 : 1;
106
107	17	if (null === $class2) {
108	2	return $this->getClassString($class1)
109	2	. ($isInverse ? '<' : '<>') . '-' . $association . ' '
110	2	. ($class1Count > 1 ? '*' : ($class1Count ? '1' : ''))
111	2	. ($isInverse ? '<>' : '>')
112	2	. '[' . str_replace('\\', '.', $targetClassName) . ']';
113		}
114
115	15	$class1SideName = $association;
116	15	$class2SideName = $this->getClassReverseAssociationName($class1, $class2);
117	15	$class2Count = 0;
118	15	$bidirectional = false;
119
120	15	if (null !== $class2SideName) {
121	12	if ($isInverse) {
122	5	$class2Count = $class2->isCollectionValuedAssociation($class2SideName) ? 2 : 1;
123	5	$bidirectional = true;
124	12	} elseif ($class2->isAssociationInverseSide($class2SideName)) {
125	7	$class2Count = $class2->isCollectionValuedAssociation($class2SideName) ? 2 : 1;
126	7	$bidirectional = true;
127	7	}
128	12	}
129
130	15	$this->visitAssociation($targetClassName, $class2SideName);
131
132	15	return $this->getClassString($class1)
133	15	. ($bidirectional ? ($isInverse ? '<' : '<>') : '') // class2 side arrow
134	15	. ($class2SideName ? $class2SideName . ' ' : '')
135	15	. ($class2Count > 1 ? '*' : ($class2Count ? '1' : '')) // class2 side single/multi valued
136	15	. '-'
137	15	. $class1SideName . ' '
138	15	. ($class1Count > 1 ? '*' : ($class1Count ? '1' : '')) // class1 side single/multi valued
139	15	. (($bidirectional && $isInverse) ? '<>' : '>') // class1 side arrow
140	15	. $this->getClassString($class2);
141		}
142
143		/**
144		* @param ClassMetadata $class1
145		* @param ClassMetadata $class2
146		* @return string\|null
147		*/
148	15	private function getClassReverseAssociationName(ClassMetadata $class1, ClassMetadata $class2)
149		{
150	15	foreach ($class2->getAssociationNames() as $class2Side) {
151	12	$targetClass = $this->getClassByName($class2->getAssociationTargetClass($class2Side));
152	12	if ($class1->getName() === $targetClass->getName()) {
153	12	return $class2Side;
154		}
155	9	}
156
157	9	return null;
158		}
159
160		/**
161		* Build the string representing the single graph item
162		*
163		* @param ClassMetadata $class
164		*
165		* @return string
166		*/
167	21	private function getClassString(ClassMetadata $class)
168		{
169	21	$this->visitAssociation($class->getName());
170
171	21	$className = $class->getName();
172	21	$classText = '[' . str_replace('\\', '.', $className);
173	21	$fields = array();
174	21	$parent = $this->getParent($class);
175	21	$parentFields = $parent ? $parent->getFieldNames() : array();
176
177	21	foreach ($class->getFieldNames() as $fieldName) {
178	2	if (in_array($fieldName, $parentFields)) {
179	1	continue;
180		}
181
182	2	if ($class->isIdentifier($fieldName)) {
183	1	$fields[] = '+' . $fieldName;
184	1	} else {
185	2	$fields[] = $fieldName;
186		}
187	21	}
188
189	21	if (!empty($fields)) {
190	2	$classText .= '\|' . implode(';', $fields);
191	2	}
192
193	21	$classText .= ']';
194
195	21	return $classText;
196		}
197
198		/**
199		* Retrieve a class metadata instance by name from the given array
200		*
201		* @param string $className
202		*
203		* @return ClassMetadata\|null
204		*/
205	19	private function getClassByName($className)
206		{
207	19	if (!isset($this->classByNames[$className])) {
208	19	foreach ($this->metadata as $class) {
209	19	if ($class->getName() === $className) {
210	18	$this->classByNames[$className] = $class;
211	18	break;
212		}
213	19	}
214	19	}
215
216	19	return isset($this->classByNames[$className])? $this->classByNames[$className]: null;
217		}
218
219		/**
220		* Retrieve a class metadata's parent class metadata
221		*
222		* @param ClassMetadata $class
223		*
224		* @return ClassMetadata\|null
225		*/
226	21	private function getParent($class)
227		{
228	21	$className = $class->getName();
229
230	21	if (!class_exists($className) \|\| (!$parent = get_parent_class($className))) {
231	21	return null;
232		}
233
234	3	return $this->getClassByName($parent);
235		}
236
237		/**
238		* Visit a given association and mark it as visited
239		*
240		* @param string $className
241		* @param string\|null $association
242		*
243		* @return bool true if the association was visited before
244		*/
245	21	private function visitAssociation($className, $association = null)
246		{
247	21	if (null === $association) {
248	21	if (isset($this->visitedAssociations[$className])) {
249	17	return false;
250		}
251
252	10	$this->visitedAssociations[$className] = array();
253
254	10	return true;
255		}
256
257	17	if (isset($this->visitedAssociations[$className][$association])) {
258	12	return false;
259		}
260
261	17	if (!isset($this->visitedAssociations[$className])) {
262	17	$this->visitedAssociations[$className] = array();
263	17	}
264
265	17	$this->visitedAssociations[$className][$association] = true;
266
267	17	return true;
268		}
269		}
270

doctrine / DoctrineORMModule

Push — master ( 50808e...8a6350 )

MetadataGrapher::getClassByName() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like