AnnotationDriver::addIndex() - Code Metrics - Inspection of "Merge pull request #1872 from garak/patch-1" - doctrine/mongodb-odm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( f3ed76...7db4b5 )

by Andreas

created 2018-10-01 08:57 UTC

AnnotationDriver::addIndex() A

↳ Parent: AnnotationDriver

Complexity

Conditions	4
Paths	6

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	13
CRAP Score	4

Importance

Changes

Metric	Value
dl	0
loc	18
ccs	13
cts	13
cp	1
rs	9.6666
c	0
b	0
f	0
cc	4
nc	6
nop	3
crap	4

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Mapping\Driver;

use Doctrine\Common\Annotations\AnnotationReader;
use Doctrine\Common\Annotations\Reader;
use Doctrine\Common\Persistence\Mapping\Driver\AnnotationDriver as AbstractAnnotationDriver;
use Doctrine\ODM\MongoDB\Events;
use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
use Doctrine\ODM\MongoDB\Mapping\Annotations\AbstractIndex;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
use Doctrine\ODM\MongoDB\Mapping\MappingException;
use ReflectionMethod;
use const E_USER_DEPRECATED;
use function array_merge;
use function array_replace;
use function constant;
use function get_class;
use function is_array;
use function ksort;
use function reset;
use function trigger_error;

/**
 * The AnnotationDriver reads the mapping metadata from docblock annotations.
 */
class AnnotationDriver extends AbstractAnnotationDriver
{
    /** @var int[] */
    protected $entityAnnotationClasses = [
        ODM\Document::class            => 1,
        ODM\MappedSuperclass::class    => 2,
        ODM\EmbeddedDocument::class    => 3,
        ODM\QueryResultDocument::class => 4,
        ODM\File::class                => 5,
    ];

    /**
     * {@inheritdoc}
     */
    public function loadMetadataForClass($className, \Doctrine\Common\Persistence\Mapping\ClassMetadata $class) : void
    {
        /** @var ClassMetadata $class */
        $reflClass = $class->getReflectionClass();

        $classAnnotations = $this->reader->getClassAnnotations($reflClass);

        $documentAnnots = [];
        foreach ($classAnnotations as $annot) {
            $classAnnotations[get_class($annot)] = $annot;

            foreach ($this->entityAnnotationClasses as $annotClass => $i) {
                if ($annot instanceof $annotClass) {
                    $documentAnnots[$i] = $annot;
                    continue 2;
                }
            }

            // non-document class annotations
            if ($annot instanceof ODM\AbstractIndex) {
                $this->addIndex($class, $annot);
            }
            if ($annot instanceof ODM\Indexes) {
                foreach (is_array($annot->value) ? $annot->value : [$annot->value] as $index) {
                    $this->addIndex($class, $index);
                }
            } elseif ($annot instanceof ODM\InheritanceType) {
                $class->setInheritanceType(constant(ClassMetadata::class . '::INHERITANCE_TYPE_' . $annot->value));
            } elseif ($annot instanceof ODM\DiscriminatorField) {
                $class->setDiscriminatorField($annot->value);
            } elseif ($annot instanceof ODM\DiscriminatorMap) {
                $class->setDiscriminatorMap($annot->value);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            } elseif ($annot instanceof ODM\DiscriminatorValue) {
                $class->setDiscriminatorValue($annot->value);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            } elseif ($annot instanceof ODM\ChangeTrackingPolicy) {
                $class->setChangeTrackingPolicy(constant(ClassMetadata::class . '::CHANGETRACKING_' . $annot->value));
            } elseif ($annot instanceof ODM\DefaultDiscriminatorValue) {
                $class->setDefaultDiscriminatorValue($annot->value);
            } elseif ($annot instanceof ODM\ReadPreference) {
                $class->setReadPreference($annot->value, $annot->tags);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
            }
        }

        if (! $documentAnnots) {

            throw MappingException::classIsNotAValidDocument($className);
        }

        // find the winning document annotation
        ksort($documentAnnots);
        $documentAnnot = reset($documentAnnots);

        if ($documentAnnot instanceof ODM\MappedSuperclass) {
            $class->isMappedSuperclass = true;
        } elseif ($documentAnnot instanceof ODM\EmbeddedDocument) {
            $class->isEmbeddedDocument = true;
        } elseif ($documentAnnot instanceof ODM\QueryResultDocument) {
            $class->isQueryResultDocument = true;
        } elseif ($documentAnnot instanceof ODM\File) {
            $class->isFile = true;

            if ($documentAnnot->chunkSizeBytes !== null) {
                $class->setChunkSizeBytes($documentAnnot->chunkSizeBytes);
            }
        }

        if (isset($documentAnnot->db)) {
            $class->setDatabase($documentAnnot->db);
        }
        if (isset($documentAnnot->collection)) {
            $class->setCollection($documentAnnot->collection);
        }
        // Store bucketName as collection name for GridFS files
        if (isset($documentAnnot->bucketName)) {
            $class->setBucketName($documentAnnot->bucketName);
        }
        if (isset($documentAnnot->repositoryClass)) {
            $class->setCustomRepositoryClass($documentAnnot->repositoryClass);
        }
        if (isset($documentAnnot->writeConcern)) {
            $class->setWriteConcern($documentAnnot->writeConcern);
        }
        if (isset($documentAnnot->indexes)) {
            foreach ($documentAnnot->indexes as $index) {
                $this->addIndex($class, $index);
            }
        }
        if (! empty($documentAnnot->readOnly)) {
            $class->markReadOnly();
        }

        foreach ($reflClass->getProperties() as $property) {
            if (($class->isMappedSuperclass && ! $property->isPrivate())
                ||
                ($class->isInheritedField($property->name) && $property->getDeclaringClass()->name !== $class->name)) {
                continue;
            }

            $indexes    = [];
            $mapping    = ['fieldName' => $property->getName()];
            $fieldAnnot = null;

            foreach ($this->reader->getPropertyAnnotations($property) as $annot) {
                if ($annot instanceof ODM\AbstractField) {
                    $fieldAnnot = $annot;
                    if ($annot->isDeprecated()) {
                        @trigger_error($annot->getDeprecationMessage(), E_USER_DEPRECATED);
// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
                    }
                }
                if ($annot instanceof ODM\AbstractIndex) {
                    $indexes[] = $annot;
                }
                if ($annot instanceof ODM\Indexes) {
                    foreach (is_array($annot->value) ? $annot->value : [$annot->value] as $index) {
                        $indexes[] = $index;
                    }
                } elseif ($annot instanceof ODM\AlsoLoad) {
                    $mapping['alsoLoadFields'] = (array) $annot->value;
                } elseif ($annot instanceof ODM\Version) {
                    $mapping['version'] = true;
                } elseif ($annot instanceof ODM\Lock) {
                    $mapping['lock'] = true;
                }
            }

            if ($fieldAnnot) {
                $mapping = array_replace($mapping, (array) $fieldAnnot);
                $class->mapField($mapping);
            }

            if (! $indexes) {

                continue;
            }

            foreach ($indexes as $index) {
                $name = $mapping['name'] ?? $mapping['fieldName'];
                $keys = [$name => $index->order ?: 'asc'];
                $this->addIndex($class, $index, $keys);
            }
        }

        // Set shard key after all fields to ensure we mapped all its keys
        if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\Annotations\ShardKey'])) {
            $this->setShardKey($class, $classAnnotations['Doctrine\ODM\MongoDB\Mapping\Annotations\ShardKey']);
        }

        /** @var ReflectionMethod $method */
        foreach ($reflClass->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
            /* Filter for the declaring class only. Callbacks from parent
             * classes will already be registered.
             */
            if ($method->getDeclaringClass()->name !== $reflClass->name) {
                continue;
            }

            foreach ($this->reader->getMethodAnnotations($method) as $annot) {
                if ($annot instanceof ODM\AlsoLoad) {
                    $class->registerAlsoLoadMethod($method->getName(), $annot->value);

                }

                if (! isset($classAnnotations[ODM\HasLifecycleCallbacks::class])) {
                    continue;
                }

                if ($annot instanceof ODM\PrePersist) {
                    $class->addLifecycleCallback($method->getName(), Events::prePersist);

                } elseif ($annot instanceof ODM\PostPersist) {
                    $class->addLifecycleCallback($method->getName(), Events::postPersist);

                } elseif ($annot instanceof ODM\PreUpdate) {
                    $class->addLifecycleCallback($method->getName(), Events::preUpdate);

                } elseif ($annot instanceof ODM\PostUpdate) {
                    $class->addLifecycleCallback($method->getName(), Events::postUpdate);

                } elseif ($annot instanceof ODM\PreRemove) {
                    $class->addLifecycleCallback($method->getName(), Events::preRemove);

                } elseif ($annot instanceof ODM\PostRemove) {
                    $class->addLifecycleCallback($method->getName(), Events::postRemove);

                } elseif ($annot instanceof ODM\PreLoad) {
                    $class->addLifecycleCallback($method->getName(), Events::preLoad);

                } elseif ($annot instanceof ODM\PostLoad) {
                    $class->addLifecycleCallback($method->getName(), Events::postLoad);

                } elseif ($annot instanceof ODM\PreFlush) {
                    $class->addLifecycleCallback($method->getName(), Events::preFlush);

                }
            }
        }
    }

    private function addIndex(ClassMetadata $class, AbstractIndex $index, array $keys = []) : void
    {
        $keys    = array_merge($keys, $index->keys);
        $options = [];
        $allowed = ['name', 'dropDups', 'background', 'unique', 'sparse', 'expireAfterSeconds'];
        foreach ($allowed as $name) {
            if (! isset($index->$name)) {
                continue;
            }

            $options[$name] = $index->$name;
        }
        if (! empty($index->partialFilterExpression)) {
            $options['partialFilterExpression'] = $index->partialFilterExpression;
        }
        $options = array_merge($options, $index->options);
        $class->addIndex($keys, $options);
    }

    /**
     * @throws MappingException
     */
    private function setShardKey(ClassMetadata $class, ODM\ShardKey $shardKey) : void
    {
        $options = [];
        $allowed = ['unique', 'numInitialChunks'];
        foreach ($allowed as $name) {
            if (! isset($shardKey->$name)) {
                continue;
            }

            $options[$name] = $shardKey->$name;
        }

        $class->setShardKey($shardKey->keys, $options);
    }

    /**
     * Factory method for the Annotation Driver
     *
     * @param array|string $paths
     */
    public static function create($paths = [], ?Reader $reader = null) : AnnotationDriver
    {
        if ($reader === null) {
            $reader = new AnnotationReader();
        }
        return new self($reader, $paths);

    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Doctrine\ODM\MongoDB\Mapping\Driver;
6
7		use Doctrine\Common\Annotations\AnnotationReader;
8		use Doctrine\Common\Annotations\Reader;
9		use Doctrine\Common\Persistence\Mapping\Driver\AnnotationDriver as AbstractAnnotationDriver;
10		use Doctrine\ODM\MongoDB\Events;
11		use Doctrine\ODM\MongoDB\Mapping\Annotations as ODM;
12		use Doctrine\ODM\MongoDB\Mapping\Annotations\AbstractIndex;
13		use Doctrine\ODM\MongoDB\Mapping\ClassMetadata;
14		use Doctrine\ODM\MongoDB\Mapping\MappingException;
15		use ReflectionMethod;
16		use const E_USER_DEPRECATED;
17		use function array_merge;
18		use function array_replace;
19		use function constant;
20		use function get_class;
21		use function is_array;
22		use function ksort;
23		use function reset;
24		use function trigger_error;
25
26		/**
27		* The AnnotationDriver reads the mapping metadata from docblock annotations.
28		*/
29		class AnnotationDriver extends AbstractAnnotationDriver
30		{
31		/** @var int[] */
32		protected $entityAnnotationClasses = [
33		ODM\Document::class => 1,
34		ODM\MappedSuperclass::class => 2,
35		ODM\EmbeddedDocument::class => 3,
36		ODM\QueryResultDocument::class => 4,
37		ODM\File::class => 5,
38		];
39
40		/**
41		* {@inheritdoc}
42		*/
43	1436	public function loadMetadataForClass($className, \Doctrine\Common\Persistence\Mapping\ClassMetadata $class) : void
44		{
45		/** @var ClassMetadata $class */
46	1436	$reflClass = $class->getReflectionClass();
47
48	1436	$classAnnotations = $this->reader->getClassAnnotations($reflClass);
49
50	1436	$documentAnnots = [];
51	1436	foreach ($classAnnotations as $annot) {
52	1434	$classAnnotations[get_class($annot)] = $annot;
53
54	1434	foreach ($this->entityAnnotationClasses as $annotClass => $i) {
55	1434	if ($annot instanceof $annotClass) {
56	1434	$documentAnnots[$i] = $annot;
57	1434	continue 2;
58		}
59		}
60
61		// non-document class annotations
62	951	if ($annot instanceof ODM\AbstractIndex) {
63	6	$this->addIndex($class, $annot);
64		}
65	951	if ($annot instanceof ODM\Indexes) {
66	95	foreach (is_array($annot->value) ? $annot->value : [$annot->value] as $index) {
67	95	$this->addIndex($class, $index);
68		}
69	936	} elseif ($annot instanceof ODM\InheritanceType) {
70	862	$class->setInheritanceType(constant(ClassMetadata::class . '::INHERITANCE_TYPE_' . $annot->value));
71	934	} elseif ($annot instanceof ODM\DiscriminatorField) {
72	131	$class->setDiscriminatorField($annot->value);
73	933	} elseif ($annot instanceof ODM\DiscriminatorMap) {
74	131	$class->setDiscriminatorMap($annot->value);
		0 ignored issues – show Bug introduced 2018-01-12 18:03 UTC by Report Bug Copy Issue Report It seems like `$annot->value` can also be of type `string`; however, `Doctrine\ODM\MongoDB\Map...::setDiscriminatorMap()` does only seem to accept `array`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
75	872	} elseif ($annot instanceof ODM\DiscriminatorValue) {
76		$class->setDiscriminatorValue($annot->value);
		0 ignored issues – show Bug introduced 2018-01-12 18:03 UTC by Report Bug Copy Issue Report It seems like `$annot->value` can also be of type `array`; however, `Doctrine\ODM\MongoDB\Map...setDiscriminatorValue()` does only seem to accept `string`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
77	872	} elseif ($annot instanceof ODM\ChangeTrackingPolicy) {
78	66	$class->setChangeTrackingPolicy(constant(ClassMetadata::class . '::CHANGETRACKING_' . $annot->value));
79	870	} elseif ($annot instanceof ODM\DefaultDiscriminatorValue) {
80	68	$class->setDefaultDiscriminatorValue($annot->value);
81	865	} elseif ($annot instanceof ODM\ReadPreference) {
82	951	$class->setReadPreference($annot->value, $annot->tags);
		0 ignored issues – show Bug introduced 2018-09-02 08:53 UTC by Report Bug Copy Issue Report It seems like `$annot->value` can also be of type `array`; however, `Doctrine\ODM\MongoDB\Map...ta::setReadPreference()` does only seem to accept `string\|integer\|null`, maybe add an additional type check? If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check: /** * @return array\|string */ function returnsDifferentValues($x) { if ($x) { return 'foo'; } return array(); } $x = returnsDifferentValues($y); if (is_array($x)) { // $x is an array. } If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue. Loading history...
83		}
84		}
85
86	1436	if (! $documentAnnots) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-24 10:15 UTC by Report Bug Copy Issue Report The expression `$documentAnnots` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
87	3	throw MappingException::classIsNotAValidDocument($className);
88		}
89
90		// find the winning document annotation
91	1434	ksort($documentAnnots);
92	1434	$documentAnnot = reset($documentAnnots);
93
94	1434	if ($documentAnnot instanceof ODM\MappedSuperclass) {
95	852	$class->isMappedSuperclass = true;
96	1433	} elseif ($documentAnnot instanceof ODM\EmbeddedDocument) {
97	280	$class->isEmbeddedDocument = true;
98	1426	} elseif ($documentAnnot instanceof ODM\QueryResultDocument) {
99	67	$class->isQueryResultDocument = true;
100	1426	} elseif ($documentAnnot instanceof ODM\File) {
101	78	$class->isFile = true;
102
103	78	if ($documentAnnot->chunkSizeBytes !== null) {
104	77	$class->setChunkSizeBytes($documentAnnot->chunkSizeBytes);
105		}
106		}
107
108	1434	if (isset($documentAnnot->db)) {
109	1	$class->setDatabase($documentAnnot->db);
110		}
111	1434	if (isset($documentAnnot->collection)) {
112	907	$class->setCollection($documentAnnot->collection);
113		}
114		// Store bucketName as collection name for GridFS files
115	1434	if (isset($documentAnnot->bucketName)) {
116	78	$class->setBucketName($documentAnnot->bucketName);
117		}
118	1434	if (isset($documentAnnot->repositoryClass)) {
119	77	$class->setCustomRepositoryClass($documentAnnot->repositoryClass);
120		}
121	1434	if (isset($documentAnnot->writeConcern)) {
122	10	$class->setWriteConcern($documentAnnot->writeConcern);
123		}
124	1434	if (isset($documentAnnot->indexes)) {
125	1433	foreach ($documentAnnot->indexes as $index) {
126		$this->addIndex($class, $index);
127		}
128		}
129	1434	if (! empty($documentAnnot->readOnly)) {
130	5	$class->markReadOnly();
131		}
132
133	1434	foreach ($reflClass->getProperties() as $property) {
134	1433	if (($class->isMappedSuperclass && ! $property->isPrivate())
135		\|\|
136	1433	($class->isInheritedField($property->name) && $property->getDeclaringClass()->name !== $class->name)) {
137	894	continue;
138		}
139
140	1432	$indexes = [];
141	1432	$mapping = ['fieldName' => $property->getName()];
142	1432	$fieldAnnot = null;
143
144	1432	foreach ($this->reader->getPropertyAnnotations($property) as $annot) {
145	1432	if ($annot instanceof ODM\AbstractField) {
146	1432	$fieldAnnot = $annot;
147	1432	if ($annot->isDeprecated()) {
148		@trigger_error($annot->getDeprecationMessage(), E_USER_DEPRECATED);
		0 ignored issues – show Security Best Practice introduced 2017-06-16 09:19 UTC by Report Bug Copy Issue Report It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended. If you suppress an error, we recommend checking for the error condition explicitly: // For example instead of @mkdir($dir); // Better use if (@mkdir($dir) === false) { throw new \RuntimeException('The directory '.$dir.' could not be created.'); } Loading history...
149		}
150		}
151	1432	if ($annot instanceof ODM\AbstractIndex) {
152	182	$indexes[] = $annot;
153		}
154	1432	if ($annot instanceof ODM\Indexes) {
155		foreach (is_array($annot->value) ? $annot->value : [$annot->value] as $index) {
156		$indexes[] = $index;
157		}
158	1432	} elseif ($annot instanceof ODM\AlsoLoad) {
159	15	$mapping['alsoLoadFields'] = (array) $annot->value;
160	1432	} elseif ($annot instanceof ODM\Version) {
161	106	$mapping['version'] = true;
162	1432	} elseif ($annot instanceof ODM\Lock) {
163	1432	$mapping['lock'] = true;
164		}
165		}
166
167	1432	if ($fieldAnnot) {
168	1432	$mapping = array_replace($mapping, (array) $fieldAnnot);
169	1432	$class->mapField($mapping);
170		}
171
172	1432	if (! $indexes) {
		0 ignored issues – show Bug Best Practice introduced 2018-03-15 15:10 UTC by Report Bug Copy Issue Report The expression `$indexes` of type `array` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
173	1432	continue;
174		}
175
176	182	foreach ($indexes as $index) {
177	182	$name = $mapping['name'] ?? $mapping['fieldName'];
178	182	$keys = [$name => $index->order ?: 'asc'];
179	182	$this->addIndex($class, $index, $keys);
180		}
181		}
182
183		// Set shard key after all fields to ensure we mapped all its keys
184	1432	if (isset($classAnnotations['Doctrine\ODM\MongoDB\Mapping\Annotations\ShardKey'])) {
185	88	$this->setShardKey($class, $classAnnotations['Doctrine\ODM\MongoDB\Mapping\Annotations\ShardKey']);
186		}
187
188		/** @var ReflectionMethod $method */
189	1431	foreach ($reflClass->getMethods(ReflectionMethod::IS_PUBLIC) as $method) {
190		/* Filter for the declaring class only. Callbacks from parent
191		* classes will already be registered.
192		*/
193	1182	if ($method->getDeclaringClass()->name !== $reflClass->name) {
194	859	continue;
195		}
196
197	1182	foreach ($this->reader->getMethodAnnotations($method) as $annot) {
198	853	if ($annot instanceof ODM\AlsoLoad) {
199	13	$class->registerAlsoLoadMethod($method->getName(), $annot->value);
		0 ignored issues – show Bug introduced 2015-12-09 07:53 UTC by Report Bug Copy Issue Report Consider using `$method->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
200		}
201
202	853	if (! isset($classAnnotations[ODM\HasLifecycleCallbacks::class])) {
203	84	continue;
204		}
205
206	834	if ($annot instanceof ODM\PrePersist) {
207	815	$class->addLifecycleCallback($method->getName(), Events::prePersist);
		0 ignored issues – show Bug introduced 2015-12-09 07:53 UTC by Report Bug Copy Issue Report Consider using `$method->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
208	95	} elseif ($annot instanceof ODM\PostPersist) {
209	10	$class->addLifecycleCallback($method->getName(), Events::postPersist);
		0 ignored issues – show Bug introduced 2015-12-09 07:53 UTC by Report Bug Copy Issue Report Consider using `$method->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
210	95	} elseif ($annot instanceof ODM\PreUpdate) {
211	15	$class->addLifecycleCallback($method->getName(), Events::preUpdate);
		0 ignored issues – show Bug introduced 2015-12-09 07:53 UTC by Report Bug Copy Issue Report Consider using `$method->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
212	90	} elseif ($annot instanceof ODM\PostUpdate) {
213	79	$class->addLifecycleCallback($method->getName(), Events::postUpdate);
		0 ignored issues – show Bug introduced 2015-12-09 07:53 UTC by Report Bug Copy Issue Report Consider using `$method->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
214	84	} elseif ($annot instanceof ODM\PreRemove) {
215	82	$class->addLifecycleCallback($method->getName(), Events::preRemove);
		0 ignored issues – show Bug introduced 2015-12-09 07:53 UTC by Report Bug Copy Issue Report Consider using `$method->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
216	84	} elseif ($annot instanceof ODM\PostRemove) {
217	82	$class->addLifecycleCallback($method->getName(), Events::postRemove);
		0 ignored issues – show Bug introduced 2015-12-09 07:53 UTC by Report Bug Copy Issue Report Consider using `$method->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
218	84	} elseif ($annot instanceof ODM\PreLoad) {
219	83	$class->addLifecycleCallback($method->getName(), Events::preLoad);
		0 ignored issues – show Bug introduced 2015-12-09 07:53 UTC by Report Bug Copy Issue Report Consider using `$method->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
220	83	} elseif ($annot instanceof ODM\PostLoad) {
221	82	$class->addLifecycleCallback($method->getName(), Events::postLoad);
		0 ignored issues – show Bug introduced 2015-12-09 07:53 UTC by Report Bug Copy Issue Report Consider using `$method->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
222	11	} elseif ($annot instanceof ODM\PreFlush) {
223	1182	$class->addLifecycleCallback($method->getName(), Events::preFlush);
		0 ignored issues – show Bug introduced 2015-12-09 07:53 UTC by Report Bug Copy Issue Report Consider using `$method->name`. There is an issue with `getName()` and APC-enabled PHP versions. Loading history...
224		}
225		}
226		}
227	1431	}
228
229	215	private function addIndex(ClassMetadata $class, AbstractIndex $index, array $keys = []) : void
230		{
231	215	$keys = array_merge($keys, $index->keys);
232	215	$options = [];
233	215	$allowed = ['name', 'dropDups', 'background', 'unique', 'sparse', 'expireAfterSeconds'];
234	215	foreach ($allowed as $name) {
235	215	if (! isset($index->$name)) {
236	215	continue;
237		}
238
239	215	$options[$name] = $index->$name;
240		}
241	215	if (! empty($index->partialFilterExpression)) {
242	2	$options['partialFilterExpression'] = $index->partialFilterExpression;
243		}
244	215	$options = array_merge($options, $index->options);
245	215	$class->addIndex($keys, $options);
246	215	}
247
248		/**
249		* @throws MappingException
250		*/
251	88	private function setShardKey(ClassMetadata $class, ODM\ShardKey $shardKey) : void
252		{
253	88	$options = [];
254	88	$allowed = ['unique', 'numInitialChunks'];
255	88	foreach ($allowed as $name) {
256	88	if (! isset($shardKey->$name)) {
257	88	continue;
258		}
259
260		$options[$name] = $shardKey->$name;
261		}
262
263	88	$class->setShardKey($shardKey->keys, $options);
264	87	}
265
266		/**
267		* Factory method for the Annotation Driver
268		*
269		* @param array\|string $paths
270		*/
271	1695	public static function create($paths = [], ?Reader $reader = null) : AnnotationDriver
272		{
273	1695	if ($reader === null) {
274	1695	$reader = new AnnotationReader();
275		}
276	1695	return new self($reader, $paths);
		0 ignored issues – show Bug introduced 2018-07-13 20:27 UTC by Report Bug Copy Issue Report It seems like `$paths` defined by parameter `$paths` on line 271 can also be of type `array`; however, `Doctrine\Common\Persiste...onDriver::__construct()` does only seem to accept `string\|array<integer,string>\|null`, maybe add an additional type check? This check looks at variables that have been passed in as parameters and are passed out again to other methods. If the outgoing method call has stricter type requirements than the method itself, an issue is raised. An additional type check may prevent trouble. Loading history...
277		}
278		}
279

doctrine / mongodb-odm

Push — master ( f3ed76...7db4b5 )

AnnotationDriver::addIndex() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like