Builder - Code Metrics - Inspection of "Add option to fetch documents as Read-Only" - doctrine/mongodb-odm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1403)

by Maciej

created 2016-05-08 19:20 UTC

Builder B

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	418
Duplicated Lines	0.72 %

Coupling/Cohesion

Components	1
Dependencies	9

Test Coverage

Coverage

100%

Importance

Changes	4
Bugs	1	Features	1

Metric	Value
wmc	49
c	4
b	1
f	1
lcom	1
cbo	9
dl	3
loc	418
ccs	134
cts	134
cp	1
rs	8.5454

21 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	8	2
A	requireIndexes()	0	5	1
A	field()	0	7	1
B	prime()	0	19	6
A	eagerCursor()	0	8	3
A	hydrate()	0	5	1
A	readOnly()	0	5	1
A	refresh()	0	5	1
A	find()	0	7	1
A	findAndUpdate()	0	7	1
A	returnNew()	0	7	1
A	findAndRemove()	0	7	1
A	update()	0	7	1
A	insert()	0	7	1
A	remove()	0	7	1
A	references()	0	5	1
A	includesReferenceTo()	0	5	1
C	getQuery()	0	58	15
A	expr()	0	7	1
B	setDocumentName()	3	26	5
A	getDiscriminatorValues()	0	15	3

How to fix Duplicated Code Complexity

Duplicated Code

Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.

Common duplication problems, and corresponding solutions are:

If you have the same expression in different places: Extract expression to a method
If you have the same method in different sub-classes: Extract method, and pull up field to the parent class
If you have the same code in unrelated classes: Consider extracting the code to a new class, and injecting that class

Complex Class

Tip: Before tackling complexity, make sure that you eliminate any duplication first. This often can reduce the size of classes significantly.

Complex classes like Builder often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.

Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.

While breaking up the class, it is a good idea to analyze how other classes use Builder, and based on these observations, apply Extract Interface, too.

<?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 Doctrine\ODM\MongoDB\Query;

use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Hydrator;
use Doctrine\ODM\MongoDB\Mapping\ClassMetadataInfo;

/**
 * Query builder for ODM.
 *
 * @since       1.0
 */
class Builder extends \Doctrine\MongoDB\Query\Builder
{
    /**
     * The DocumentManager instance for this query
     *
     * @var DocumentManager
     */
    private $dm;

    /**
     * The ClassMetadata instance.
     *
     * @var \Doctrine\ODM\MongoDB\Mapping\ClassMetadata
     */
    private $class;

    /**
     * The current field we are operating on.
     *
     * @todo Change this to private once ODM requires doctrine/mongodb 1.1+
     * @var string
     */
    protected $currentField;

    /**
     * Whether or not to hydrate the data to documents.
     *
     * @var boolean
     */
    private $hydrate = true;

    /**
     * Whether or not to refresh the data for documents that are already in the identity map.
     *
     * @var boolean
     */
    private $refresh = false;

    /**
     * Array of primer Closure instances.
     *
     * @var array
     */
    private $primers = array();

    /**
     * Whether or not to require indexes.
     *
     * @var bool
     */
    private $requireIndexes;

    /**
     * Whether or not to register documents in UnitOfWork.
     *
     * @var bool
     */
    private $readOnly;

    /**
     * Construct a Builder
     *
     * @param DocumentManager $dm
     * @param string[]|string|null $documentName (optional) an array of document names, the document name, or none
     */
    public function __construct(DocumentManager $dm, $documentName = null)
    {
        $this->dm = $dm;
        $this->expr = new Expr($dm);
        if ($documentName !== null) {
            $this->setDocumentName($documentName);
        }
    }

    /**
     * Set whether or not to require indexes.
     *
     * @param bool $requireIndexes
     * @return $this
     */
    public function requireIndexes($requireIndexes = true)
    {
        $this->requireIndexes = $requireIndexes;
        return $this;
    }

    /**
     * Set the current field to operate on.
     *
     * @param string $field
     * @return $this
     */
    public function field($field)
    {
        $this->currentField = $field;
        parent::field($field);

        return $this;
    }

    /**
     * Use a primer to eagerly load all references in the current field.
     *
     * If $primer is true or a callable is provided, referenced documents for
     * this field will loaded into UnitOfWork immediately after the query is
     * executed. This will avoid multiple queries due to lazy initialization of
     * Proxy objects.
     *
     * If $primer is false, no priming will take place. That is also the default
     * behavior.
     *
     * If a custom callable is used, its signature should conform to the default
     * Closure defined in {@link ReferencePrimer::__construct()}.
     *
     * @param boolean|callable $primer
     * @return $this
     * @throws \InvalidArgumentException If $primer is not boolean or callable
     */
    public function prime($primer = true)
    {
        if ( ! is_bool($primer) && ! is_callable($primer)) {
            throw new \InvalidArgumentException('$primer is not a boolean or callable');
        }

        if ($primer === false) {
            unset($this->primers[$this->currentField]);

            return $this;
        }

        if (array_key_exists('eagerCursor', $this->query) && !$this->query['eagerCursor']) {
            throw new \BadMethodCallException("Can't call prime() when setting eagerCursor to false");
        }

        $this->primers[$this->currentField] = $primer;
        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function eagerCursor($bool = true)
    {
        if ( ! $bool && ! empty($this->primers)) {
            throw new \BadMethodCallException("Can't set eagerCursor to false when using reference primers");
        }

        return parent::eagerCursor($bool);
    }


    /**
     * @param bool $bool
     * @return $this
     */
    public function hydrate($bool = true)
    {
        $this->hydrate = $bool;
        return $this;
    }

    /**
     * @param bool $bool
     * @return $this
     */
    public function readOnly($bool = true)
    {
        $this->readOnly = $bool;
        return $this;
    }

    /**
     * @param bool $bool
     * @return $this
     */
    public function refresh($bool = true)
    {
        $this->refresh = $bool;
        return $this;
    }

    /**
     * Change the query type to find and optionally set and change the class being queried.
     *
     * @param string $documentName
     * @return $this
     */
    public function find($documentName = null)
    {
        $this->setDocumentName($documentName);
        parent::find();

        return $this;
    }

    /**
     * @param string $documentName
     * @return $this
     */
    public function findAndUpdate($documentName = null)
    {
        $this->setDocumentName($documentName);
        parent::findAndUpdate();

        return $this;
    }

    /**
     * @param bool $bool
     * @return $this
     */
    public function returnNew($bool = true)
    {
        $this->refresh(true);
        parent::returnNew($bool);

        return $this;
    }

    /**
     * @param string $documentName
     * @return $this
     */
    public function findAndRemove($documentName = null)
    {
        $this->setDocumentName($documentName);
        parent::findAndRemove();

        return $this;
    }

    /**
     * @param string $documentName
     * @return $this
     */
    public function update($documentName = null)
    {
        $this->setDocumentName($documentName);
        parent::update();

        return $this;
    }

    /**
     * @param string $documentName
     * @return $this
     */
    public function insert($documentName = null)
    {
        $this->setDocumentName($documentName);
        parent::insert();

        return $this;
    }

    /**
     * @param string $documentName
     * @return $this
     */
    public function remove($documentName = null)
    {
        $this->setDocumentName($documentName);
        parent::remove();

        return $this;
    }

    /**
     * @param object $document
     * @return $this
     */
    public function references($document)
    {
        $this->expr->references($document);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $this;
    }

    /**
     * @param object $document
     * @return $this
     */
    public function includesReferenceTo($document)
    {
        $this->expr->includesReferenceTo($document);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        return $this;
    }

    /**
     * Gets the Query executable.
     *
     * @param array $options
     * @return Query $query
     */
    public function getQuery(array $options = array())
    {
        if ($this->query['type'] === Query::TYPE_MAP_REDUCE) {
            $this->hydrate = false;
        }

        $documentPersister = $this->dm->getUnitOfWork()->getDocumentPersister($this->class->name);

        $query = $this->query;

        $query['query'] = $this->expr->getQuery();
        $query['query'] = $documentPersister->addDiscriminatorToPreparedQuery($query['query']);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $query['query'] = $documentPersister->addFilterToPreparedQuery($query['query']);

        $query['newObj'] = $this->expr->getNewObj();

        if (isset($query['distinct'])) {
            $query['distinct'] = $documentPersister->prepareFieldName($query['distinct']);
/**
 * @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->class->inheritanceType === ClassMetadataInfo::INHERITANCE_TYPE_SINGLE_COLLECTION && ! empty($query['upsert']) &&
            (empty($query['query'][$this->class->discriminatorField]) || is_array($query['query'][$this->class->discriminatorField]))) {
            throw new \InvalidArgumentException('Upsert query that is to be performed on discriminated document does not have single ' .
                'discriminator. Either not use base class or set \'' . $this->class->discriminatorField . '\' field manually.');
        }

        if ( ! empty($query['select'])) {
            $query['select'] = $documentPersister->prepareSortOrProjection($query['select']);
            if ($this->hydrate && $this->class->inheritanceType === ClassMetadataInfo::INHERITANCE_TYPE_SINGLE_COLLECTION
                && ! isset($query['select'][$this->class->discriminatorField])) {
                $includeMode = 0 < count(array_filter($query['select'], function($mode) { return $mode == 1; }));
                if ($includeMode && ! isset($query['select'][$this->class->discriminatorField])) {
                    $query['select'][$this->class->discriminatorField] = 1;
                }
            }
        }

        if (isset($query['sort'])) {
            $query['sort'] = $documentPersister->prepareSortOrProjection($query['sort']);
        }

        if ($this->class->slaveOkay) {
            $query['slaveOkay'] = $this->class->slaveOkay;
        }

        return new Query(
            $this->dm,
            $this->class,
            $this->collection,
            $query,
            $options,
            $this->hydrate,
            $this->refresh,
            $this->primers,
            $this->requireIndexes,
            $this->readOnly
        );
    }

    /**
     * Create a new Expr instance that can be used as an expression with the Builder
     *
     * @return Expr $expr
     */
    public function expr()
    {
        $expr = new Expr($this->dm);
        $expr->setClassMetadata($this->class);

        return $expr;
    }

    /**
     * @param string[]|string $documentName an array of document names or just one.
     */
    private function setDocumentName($documentName)
    {
        if (is_array($documentName)) {
            $documentNames = $documentName;
            $documentName = $documentNames[0];

            $metadata = $this->dm->getClassMetadata($documentName);
            $discriminatorField = $metadata->discriminatorField;
            $discriminatorValues = $this->getDiscriminatorValues($documentNames);

            // If a defaultDiscriminatorValue is set and it is among the discriminators being queries, add NULL to the list
            if ($metadata->defaultDiscriminatorValue && array_search($metadata->defaultDiscriminatorValue, $discriminatorValues) !== false) {

                $discriminatorValues[] = null;
            }

            $this->field($discriminatorField)->in($discriminatorValues);
        }

        if ($documentName !== null) {
            $this->collection = $this->dm->getDocumentCollection($documentName);
            $this->class = $this->dm->getClassMetadata($documentName);

            // Expr also needs to know
            $this->expr->setClassMetadata($this->class);
abstract class User
{
    /** @return string */
    abstract public function getPassword();
}

class MyUser extends User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}
        }
    }

    /**
     * Get Discriminator Values
     *
     * @param \Iterator|array $classNames
     * @return array an array of discriminatorValues (mixed type)
     * @throws \InvalidArgumentException if the number of found collections > 1
     */
    private function getDiscriminatorValues($classNames)
    {
        $discriminatorValues = array();
        $collections = array();
        foreach ($classNames as $className) {
            $class = $this->dm->getClassMetadata($className);
            $discriminatorValues[] = $class->discriminatorValue;
            $key = $this->dm->getDocumentDatabase($className)->getName() . '.' . $class->getCollection();
            $collections[$key] = $key;
        }
        if (count($collections) > 1) {
            throw new \InvalidArgumentException('Documents involved are not all mapped to the same database collection.');
        }
        return $discriminatorValues;
    }
}


Pull Request — master (#1403)

Builder B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

21 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

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 Doctrine\ODM\MongoDB\Query;
21
22			use Doctrine\ODM\MongoDB\DocumentManager;
23			use Doctrine\ODM\MongoDB\Hydrator;
24			use Doctrine\ODM\MongoDB\Mapping\ClassMetadataInfo;
25
26			/**
27			* Query builder for ODM.
28			*
29			* @since 1.0
30			*/
31			class Builder extends \Doctrine\MongoDB\Query\Builder
32			{
33			/**
34			* The DocumentManager instance for this query
35			*
36			* @var DocumentManager
37			*/
38			private $dm;
39
40			/**
41			* The ClassMetadata instance.
42			*
43			* @var \Doctrine\ODM\MongoDB\Mapping\ClassMetadata
44			*/
45			private $class;
46
47			/**
48			* The current field we are operating on.
49			*
50			* @todo Change this to private once ODM requires doctrine/mongodb 1.1+
51			* @var string
52			*/
53			protected $currentField;
54
55			/**
56			* Whether or not to hydrate the data to documents.
57			*
58			* @var boolean
59			*/
60			private $hydrate = true;
61
62			/**
63			* Whether or not to refresh the data for documents that are already in the identity map.
64			*
65			* @var boolean
66			*/
67			private $refresh = false;
68
69			/**
70			* Array of primer Closure instances.
71			*
72			* @var array
73			*/
74			private $primers = array();
75
76			/**
77			* Whether or not to require indexes.
78			*
79			* @var bool
80			*/
81			private $requireIndexes;
82
83			/**
84			* Whether or not to register documents in UnitOfWork.
85			*
86			* @var bool
87			*/
88			private $readOnly;
89
90			/**
91			* Construct a Builder
92			*
93			* @param DocumentManager $dm
94			* @param string[]\|string\|null $documentName (optional) an array of document names, the document name, or none
95			*/
96	216		public function __construct(DocumentManager $dm, $documentName = null)
97			{
98	216		$this->dm = $dm;
99	216		$this->expr = new Expr($dm);
100	216		if ($documentName !== null) {
101	208		$this->setDocumentName($documentName);
102			}
103	215		}
104
105			/**
106			* Set whether or not to require indexes.
107			*
108			* @param bool $requireIndexes
109			* @return $this
110			*/
111	2		public function requireIndexes($requireIndexes = true)
112			{
113	2		$this->requireIndexes = $requireIndexes;
114	2		return $this;
115			}
116
117			/**
118			* Set the current field to operate on.
119			*
120			* @param string $field
121			* @return $this
122			*/
123	136		public function field($field)
124			{
125	136		$this->currentField = $field;
126	136		parent::field($field);
127
128	136		return $this;
129			}
130
131			/**
132			* Use a primer to eagerly load all references in the current field.
133			*
134			* If $primer is true or a callable is provided, referenced documents for
135			* this field will loaded into UnitOfWork immediately after the query is
136			* executed. This will avoid multiple queries due to lazy initialization of
137			* Proxy objects.
138			*
139			* If $primer is false, no priming will take place. That is also the default
140			* behavior.
141			*
142			* If a custom callable is used, its signature should conform to the default
143			* Closure defined in {@link ReferencePrimer::__construct()}.
144			*
145			* @param boolean\|callable $primer
146			* @return $this
147			* @throws \InvalidArgumentException If $primer is not boolean or callable
148			*/
149	21		public function prime($primer = true)
150			{
151	21		if ( ! is_bool($primer) && ! is_callable($primer)) {
152	1		throw new \InvalidArgumentException('$primer is not a boolean or callable');
153			}
154
155	20		if ($primer === false) {
156	1		unset($this->primers[$this->currentField]);
157
158	1		return $this;
159			}
160
161	20		if (array_key_exists('eagerCursor', $this->query) && !$this->query['eagerCursor']) {
162	1		throw new \BadMethodCallException("Can't call prime() when setting eagerCursor to false");
163			}
164
165	19		$this->primers[$this->currentField] = $primer;
166	19		return $this;
167			}
168
169			/**
170			* {@inheritdoc}
171			*/
172	5		public function eagerCursor($bool = true)
173			{
174	5		if ( ! $bool && ! empty($this->primers)) {
175	1		throw new \BadMethodCallException("Can't set eagerCursor to false when using reference primers");
176			}
177
178	4		return parent::eagerCursor($bool);
179			}
180
181
182			/**
183			* @param bool $bool
184			* @return $this
185			*/
186	16		public function hydrate($bool = true)
187			{
188	16		$this->hydrate = $bool;
189	16		return $this;
190			}
191
192			/**
193			* @param bool $bool
194			* @return $this
195			*/
196	1		public function readOnly($bool = true)
197			{
198	1		$this->readOnly = $bool;
199	1		return $this;
200			}
201
202			/**
203			* @param bool $bool
204			* @return $this
205			*/
206	5		public function refresh($bool = true)
207			{
208	5		$this->refresh = $bool;
209	5		return $this;
210			}
211
212			/**
213			* Change the query type to find and optionally set and change the class being queried.
214			*
215			* @param string $documentName
216			* @return $this
217			*/
218	12		public function find($documentName = null)
219			{
220	12		$this->setDocumentName($documentName);
221	12		parent::find();
222
223	12		return $this;
224			}
225
226			/**
227			* @param string $documentName
228			* @return $this
229			*/
230	7		public function findAndUpdate($documentName = null)
231			{
232	7		$this->setDocumentName($documentName);
233	7		parent::findAndUpdate();
234
235	7		return $this;
236			}
237
238			/**
239			* @param bool $bool
240			* @return $this
241			*/
242	4		public function returnNew($bool = true)
243			{
244	4		$this->refresh(true);
245	4		parent::returnNew($bool);
246
247	4		return $this;
248			}
249
250			/**
251			* @param string $documentName
252			* @return $this
253			*/
254	1		public function findAndRemove($documentName = null)
255			{
256	1		$this->setDocumentName($documentName);
257	1		parent::findAndRemove();
258
259	1		return $this;
260			}
261
262			/**
263			* @param string $documentName
264			* @return $this
265			*/
266	12		public function update($documentName = null)
267			{
268	12		$this->setDocumentName($documentName);
269	12		parent::update();
270
271	12		return $this;
272			}
273
274			/**
275			* @param string $documentName
276			* @return $this
277			*/
278	1		public function insert($documentName = null)
279			{
280	1		$this->setDocumentName($documentName);
281	1		parent::insert();
282
283	1		return $this;
284			}
285
286			/**
287			* @param string $documentName
288			* @return $this
289			*/
290	1		public function remove($documentName = null)
291			{
292	1		$this->setDocumentName($documentName);
293	1		parent::remove();
294
295	1		return $this;
296			}
297
298			/**
299			* @param object $document
300			* @return $this
301			*/
302	8		public function references($document)
303			{
304	8		$this->expr->references($document);
			0 ignored issues – show Bug introduced 2015-11-24 10:15 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Doctrine\MongoDB\Query\Expr` as the method `references()` does only exist in the following sub-classes of `Doctrine\MongoDB\Query\Expr`: `Doctrine\ODM\MongoDB\Query\Expr`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
305	6		return $this;
306			}
307
308			/**
309			* @param object $document
310			* @return $this
311			*/
312	5		public function includesReferenceTo($document)
313			{
314	5		$this->expr->includesReferenceTo($document);
			0 ignored issues – show Bug introduced 2015-11-24 10:15 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Doctrine\MongoDB\Query\Expr` as the method `includesReferenceTo()` does only exist in the following sub-classes of `Doctrine\MongoDB\Query\Expr`: `Doctrine\ODM\MongoDB\Query\Expr`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
315	3		return $this;
316			}
317
318			/**
319			* Gets the Query executable.
320			*
321			* @param array $options
322			* @return Query $query
323			*/
324	185		public function getQuery(array $options = array())
325			{
326	185		if ($this->query['type'] === Query::TYPE_MAP_REDUCE) {
327	3		$this->hydrate = false;
328			}
329
330	185		$documentPersister = $this->dm->getUnitOfWork()->getDocumentPersister($this->class->name);
331
332	185		$query = $this->query;
333
334	185		$query['query'] = $this->expr->getQuery();
335	185		$query['query'] = $documentPersister->addDiscriminatorToPreparedQuery($query['query']);
			0 ignored issues – show Documentation introduced 2015-11-24 10:15 UTC by Report Bug Copy Issue Report `$query['query']` is of type `string`, but the function expects a `array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
336	185		$query['query'] = $documentPersister->addFilterToPreparedQuery($query['query']);
337
338	185		$query['newObj'] = $this->expr->getNewObj();
339
340	185		if (isset($query['distinct'])) {
341	2		$query['distinct'] = $documentPersister->prepareFieldName($query['distinct']);
			0 ignored issues – show Bug introduced 2015-11-24 10:15 UTC by Report Bug Copy Issue Report It seems like `$query['distinct']` can also be of type `array`; however, `Doctrine\ODM\MongoDB\Per...ter::prepareFieldName()` 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...
342			}
343
344	185		if ($this->class->inheritanceType === ClassMetadataInfo::INHERITANCE_TYPE_SINGLE_COLLECTION && ! empty($query['upsert']) &&
345	185		(empty($query['query'][$this->class->discriminatorField]) \|\| is_array($query['query'][$this->class->discriminatorField]))) {
346	1		throw new \InvalidArgumentException('Upsert query that is to be performed on discriminated document does not have single ' .
347	1		'discriminator. Either not use base class or set \'' . $this->class->discriminatorField . '\' field manually.');
348			}
349
350	184		if ( ! empty($query['select'])) {
351	14		$query['select'] = $documentPersister->prepareSortOrProjection($query['select']);
352	14		if ($this->hydrate && $this->class->inheritanceType === ClassMetadataInfo::INHERITANCE_TYPE_SINGLE_COLLECTION
353	14		&& ! isset($query['select'][$this->class->discriminatorField])) {
354			$includeMode = 0 < count(array_filter($query['select'], function($mode) { return $mode == 1; }));
355	2		if ($includeMode && ! isset($query['select'][$this->class->discriminatorField])) {
356	1		$query['select'][$this->class->discriminatorField] = 1;
357			}
358			}
359			}
360
361	184		if (isset($query['sort'])) {
362	26		$query['sort'] = $documentPersister->prepareSortOrProjection($query['sort']);
363			}
364
365	184		if ($this->class->slaveOkay) {
366	1		$query['slaveOkay'] = $this->class->slaveOkay;
367			}
368
369	184		return new Query(
370	184		$this->dm,
371	184		$this->class,
372	184		$this->collection,
373			$query,
374			$options,
375	184		$this->hydrate,
376	184		$this->refresh,
377	184		$this->primers,
378	184		$this->requireIndexes,
379	184		$this->readOnly
380			);
381			}
382
383			/**
384			* Create a new Expr instance that can be used as an expression with the Builder
385			*
386			* @return Expr $expr
387			*/
388	25		public function expr()
389			{
390	25		$expr = new Expr($this->dm);
391	25		$expr->setClassMetadata($this->class);
392
393	25		return $expr;
394			}
395
396			/**
397			* @param string[]\|string $documentName an array of document names or just one.
398			*/
399	215		private function setDocumentName($documentName)
400			{
401	215		if (is_array($documentName)) {
402	2		$documentNames = $documentName;
403	2		$documentName = $documentNames[0];
404
405	2		$metadata = $this->dm->getClassMetadata($documentName);
406	2		$discriminatorField = $metadata->discriminatorField;
407	2		$discriminatorValues = $this->getDiscriminatorValues($documentNames);
408
409			// If a defaultDiscriminatorValue is set and it is among the discriminators being queries, add NULL to the list
410	1	View Code Duplication	if ($metadata->defaultDiscriminatorValue && array_search($metadata->defaultDiscriminatorValue, $discriminatorValues) !== false) {
			0 ignored issues – show Duplication introduced 2015-11-24 10:15 UTC by Report Bug Copy Issue Report This code seems to be duplicated across your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
411	1		$discriminatorValues[] = null;
412			}
413
414	1		$this->field($discriminatorField)->in($discriminatorValues);
415			}
416
417	214		if ($documentName !== null) {
418	214		$this->collection = $this->dm->getDocumentCollection($documentName);
419	214		$this->class = $this->dm->getClassMetadata($documentName);
420
421			// Expr also needs to know
422	214		$this->expr->setClassMetadata($this->class);
			0 ignored issues – show Bug introduced 2015-11-24 10:15 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Doctrine\MongoDB\Query\Expr` as the method `setClassMetadata()` does only exist in the following sub-classes of `Doctrine\MongoDB\Query\Expr`: `Doctrine\ODM\MongoDB\Query\Expr`. Maybe you want to `instanceof` check for one of these explicitly? Let’s take a look at an example: abstract class User { /** @return string / abstract public function getPassword(); } class MyUser extends User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
423			}
424	214		}
425
426			/**
427			* Get Discriminator Values
428			*
429			* @param \Iterator\|array $classNames
430			* @return array an array of discriminatorValues (mixed type)
431			* @throws \InvalidArgumentException if the number of found collections > 1
432			*/
433	2		private function getDiscriminatorValues($classNames)
434			{
435	2		$discriminatorValues = array();
436	2		$collections = array();
437	2		foreach ($classNames as $className) {
438	2		$class = $this->dm->getClassMetadata($className);
439	2		$discriminatorValues[] = $class->discriminatorValue;
440	2		$key = $this->dm->getDocumentDatabase($className)->getName() . '.' . $class->getCollection();
441	2		$collections[$key] = $key;
442			}
443	2		if (count($collections) > 1) {
444	1		throw new \InvalidArgumentException('Documents involved are not all mapped to the same database collection.');
445			}
446	1		return $discriminatorValues;
447			}
448			}
449

doctrine / mongodb-odm

Pull Request — master (#1403)

Builder B

Complexity

Size/Duplication

Coupling/Cohesion

Test Coverage

Importance

21 Methods

How to fix Duplicated Code Complexity

Duplicated Code

Complex Class

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like