Builder::__construct() - Code Metrics - Inspection of "Add new aggregation stuff" - doctrine/mongodb-odm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1654)

by Andreas

created 2017-10-12 14:58 UTC

Builder::__construct() A

↳ Parent: Builder

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	2
Bugs	0	Features	0

Metric	Value
c	2
b	0
f	0
dl	0
loc	7
ccs	5
cts	5
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	2
crap	1

<?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\Aggregation;

use Doctrine\MongoDB\Aggregation\Builder as BaseBuilder;
use Doctrine\MongoDB\Aggregation\Stage\GeoNear;
use Doctrine\MongoDB\CommandCursor as BaseCommandCursor;
use Doctrine\ODM\MongoDB\CommandCursor;
use Doctrine\ODM\MongoDB\DocumentManager;
use Doctrine\ODM\MongoDB\Query\Expr as QueryExpr;

/**
 * Fluent interface for building aggregation pipelines.
 */
class Builder extends BaseBuilder
{
    /**
     * The DocumentManager instance for this query
     *
     * @var DocumentManager
     */
    private $dm;

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

    /**
     * @var string
     */
    private $hydrationClass;

    /**
     * Create a new aggregation builder.
     *
     * @param DocumentManager $dm
     * @param string $documentName
     */
    public function __construct(DocumentManager $dm, $documentName)
    {
        $this->dm = $dm;
        $this->class = $this->dm->getClassMetadata($documentName);

        parent::__construct($this->dm->getDocumentCollection($documentName));
    }

    /**
     * {@inheritdoc}
     */
    public function execute($options = [])
    {
        // Force cursor to be used
        $options = array_merge($options, ['cursor' => true]);

        $cursor = parent::execute($options);

        return $this->prepareCursor($cursor);

    }

    /**
     * Set which class to use when hydrating results as document class instances.
     *
     * @param string $className
     *
     * @return self
     */
    public function hydrate($className)
    {
        $this->hydrationClass = $className;

        return $this;
    }

    /**
     * @return QueryExpr
     */
    public function matchExpr()
    {
        $expr = new QueryExpr($this->dm);
        $expr->setClassMetadata($this->class);

        return $expr;
    }

    /**
     * @return Expr
     */
    public function expr()
    {
        return new Expr($this->dm, $this->class);
    }

    /**
     * @return Stage\Bucket
     */
    public function bucket()
    {
        return $this->addStage(new Stage\Bucket($this));

    }

    /**
     * @return Stage\BucketAuto
     */
    public function bucketAuto()
    {
        return $this->addStage(new Stage\BucketAuto($this));

    }

    /**
     * @param string $from
     *
     * @return Stage\GraphLookup
     */
    public function graphLookup($from)
    {
        return $this->addStage(new Stage\GraphLookup($this, $from, $this->dm, $this->class));
    }

    /**
     * @return Stage\Match
     */
    public function match()
    {
        return $this->addStage(new Stage\Match($this));
    }

    /**
     * @param string $from
     * @return Stage\Lookup
     */
    public function lookup($from)
    {
        return $this->addStage(new Stage\Lookup($this, $from, $this->dm, $this->class));
    }

    /**
     * @param string $from
     * @return Stage\Out
     */
    public function out($from)
    {
        return $this->addStage(new Stage\Out($this, $from, $this->dm));
    }

    /**
     * @param string|null $expression Optional. A replacement expression that
     * resolves to a document.
     * @return Stage\ReplaceRoot
     */
    public function replaceRoot($expression = null)
    {
        return $this->addStage(new Stage\ReplaceRoot($this, $this->dm, $this->class, $expression));
    }

    /**
     * @return Stage\SortByCount
     */
    public function sortByCount($expression)
    {
        return $this->addStage(new Stage\SortByCount($this, $expression, $this->dm, $this->class));
    }

    /**
     * {@inheritdoc}
     */
    public function sort($fieldName, $order = null)
    {
        $fields = is_array($fieldName) ? $fieldName : [$fieldName => $order];
        return parent::sort($this->getDocumentPersister()->prepareSortOrProjection($fields));
    }

    /**
     * {@inheritdoc}
     */
    public function unwind($fieldName)
    {
        $fieldName = $this->getDocumentPersister()->prepareFieldName($fieldName);
        return parent::unwind($fieldName);
    }

    /**
     * Returns the assembled aggregation pipeline
     *
     * For pipelines where the first stage is a $geoNear stage, it will apply
     * the document filters and discriminator queries to the query portion of
     * the geoNear operation. For all other pipelines, it prepends a $match stage
     * containing the required query.
     *
     * @return array
     */
    public function getPipeline()
    {
        $pipeline = parent::getPipeline();

        if ($this->getStage(0) instanceof GeoNear) {
            $pipeline[0]['$geoNear']['query'] = $this->applyFilters($pipeline[0]['$geoNear']['query']);
        } else {
            $matchStage = $this->applyFilters([]);
            if ($matchStage !== []) {
                array_unshift($pipeline, ['$match' => $matchStage]);
            }
        }

        return $pipeline;
    }

    /**
     * Applies filters and discriminator queries to the pipeline
     *
     * @param array $query
     * @return array
     */
    private function applyFilters(array $query)
    {
        $documentPersister = $this->dm->getUnitOfWork()->getDocumentPersister($this->class->name);

        $query = $documentPersister->addDiscriminatorToPreparedQuery($query);
        $query = $documentPersister->addFilterToPreparedQuery($query);

        return $query;
    }

    /**
     * @param BaseCommandCursor $cursor
     *
     * @return CommandCursor
     */
    private function prepareCursor(BaseCommandCursor $cursor)
    {
        $class = null;
        if ($this->hydrationClass) {
            $class = $this->dm->getClassMetadata($this->hydrationClass);
        }

        return new CommandCursor($cursor, $this->dm->getUnitOfWork(), $class);
    }

    /**
     * @return \Doctrine\ODM\MongoDB\Persisters\DocumentPersister
     */
    private function getDocumentPersister()
    {
        return $this->dm->getUnitOfWork()->getDocumentPersister($this->class->name);
    }
}


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\Aggregation;
21
22		use Doctrine\MongoDB\Aggregation\Builder as BaseBuilder;
23		use Doctrine\MongoDB\Aggregation\Stage\GeoNear;
24		use Doctrine\MongoDB\CommandCursor as BaseCommandCursor;
25		use Doctrine\ODM\MongoDB\CommandCursor;
26		use Doctrine\ODM\MongoDB\DocumentManager;
27		use Doctrine\ODM\MongoDB\Query\Expr as QueryExpr;
28
29		/**
30		* Fluent interface for building aggregation pipelines.
31		*/
32		class Builder extends BaseBuilder
33		{
34		/**
35		* The DocumentManager instance for this query
36		*
37		* @var DocumentManager
38		*/
39		private $dm;
40
41		/**
42		* The ClassMetadata instance.
43		*
44		* @var \Doctrine\ODM\MongoDB\Mapping\ClassMetadata
45		*/
46		private $class;
47
48		/**
49		* @var string
50		*/
51		private $hydrationClass;
52
53		/**
54		* Create a new aggregation builder.
55		*
56		* @param DocumentManager $dm
57		* @param string $documentName
58		*/
59	39	public function __construct(DocumentManager $dm, $documentName)
60		{
61	39	$this->dm = $dm;
62	39	$this->class = $this->dm->getClassMetadata($documentName);
63
64	39	parent::__construct($this->dm->getDocumentCollection($documentName));
65	39	}
66
67		/**
68		* {@inheritdoc}
69		*/
70	17	public function execute($options = [])
71		{
72		// Force cursor to be used
73	17	$options = array_merge($options, ['cursor' => true]);
74
75	17	$cursor = parent::execute($options);
76
77	17	return $this->prepareCursor($cursor);
		0 ignored issues – show Compatibility introduced 2015-12-15 06:38 UTC by Report Bug Copy Issue Report `$cursor` of type `object<Doctrine\MongoDB\Iterator>` is not a sub-type of `object<Doctrine\MongoDB\CommandCursor>`. It seems like you assume a concrete implementation of the interface `Doctrine\MongoDB\Iterator` to be always present. This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. Loading history...
78		}
79
80		/**
81		* Set which class to use when hydrating results as document class instances.
82		*
83		* @param string $className
84		*
85		* @return self
86		*/
87	4	public function hydrate($className)
88		{
89	4	$this->hydrationClass = $className;
90
91	4	return $this;
92		}
93
94		/**
95		* @return QueryExpr
96		*/
97	14	public function matchExpr()
98		{
99	14	$expr = new QueryExpr($this->dm);
100	14	$expr->setClassMetadata($this->class);
101
102	14	return $expr;
103		}
104
105		/**
106		* @return Expr
107		*/
108	8	public function expr()
109		{
110	8	return new Expr($this->dm, $this->class);
111		}
112
113		/**
114		* @return Stage\Bucket
115		*/
116	1	public function bucket()
117		{
118	1	return $this->addStage(new Stage\Bucket($this));
		0 ignored issues – show Bug introduced 2017-10-12 15:07 UTC by Report Bug Copy Issue Report The call to `Bucket::__construct()` misses some required arguments starting with `$documentManager`. Loading history...
119		}
120
121		/**
122		* @return Stage\BucketAuto
123		*/
124	1	public function bucketAuto()
125		{
126	1	return $this->addStage(new Stage\BucketAuto($this));
		0 ignored issues – show Bug introduced 2017-10-12 15:07 UTC by Report Bug Copy Issue Report The call to `BucketAuto::__construct()` misses some required arguments starting with `$documentManager`. Loading history...
127		}
128
129		/**
130		* @param string $from
131		*
132		* @return Stage\GraphLookup
133		*/
134	8	public function graphLookup($from)
135		{
136	8	return $this->addStage(new Stage\GraphLookup($this, $from, $this->dm, $this->class));
137		}
138
139		/**
140		* @return Stage\Match
141		*/
142	6	public function match()
143		{
144	6	return $this->addStage(new Stage\Match($this));
145		}
146
147		/**
148		* @param string $from
149		* @return Stage\Lookup
150		*/
151	13	public function lookup($from)
152		{
153	13	return $this->addStage(new Stage\Lookup($this, $from, $this->dm, $this->class));
154		}
155
156		/**
157		* @param string $from
158		* @return Stage\Out
159		*/
160	4	public function out($from)
161		{
162	4	return $this->addStage(new Stage\Out($this, $from, $this->dm));
163		}
164
165		/**
166		* @param string\|null $expression Optional. A replacement expression that
167		* resolves to a document.
168		* @return Stage\ReplaceRoot
169		*/
170	6	public function replaceRoot($expression = null)
171		{
172	6	return $this->addStage(new Stage\ReplaceRoot($this, $this->dm, $this->class, $expression));
173		}
174
175		/**
176		* @return Stage\SortByCount
177		*/
178	1	public function sortByCount($expression)
179		{
180	1	return $this->addStage(new Stage\SortByCount($this, $expression, $this->dm, $this->class));
181		}
182
183		/**
184		* {@inheritdoc}
185		*/
186	2	public function sort($fieldName, $order = null)
187		{
188	2	$fields = is_array($fieldName) ? $fieldName : [$fieldName => $order];
189	2	return parent::sort($this->getDocumentPersister()->prepareSortOrProjection($fields));
190		}
191
192		/**
193		* {@inheritdoc}
194		*/
195	4	public function unwind($fieldName)
196		{
197	4	$fieldName = $this->getDocumentPersister()->prepareFieldName($fieldName);
198	4	return parent::unwind($fieldName);
199		}
200
201		/**
202		* Returns the assembled aggregation pipeline
203		*
204		* For pipelines where the first stage is a $geoNear stage, it will apply
205		* the document filters and discriminator queries to the query portion of
206		* the geoNear operation. For all other pipelines, it prepends a $match stage
207		* containing the required query.
208		*
209		* @return array
210		*/
211	26	public function getPipeline()
212		{
213	26	$pipeline = parent::getPipeline();
214
215	26	if ($this->getStage(0) instanceof GeoNear) {
216	1	$pipeline[0]['$geoNear']['query'] = $this->applyFilters($pipeline[0]['$geoNear']['query']);
217		} else {
218	25	$matchStage = $this->applyFilters([]);
219	25	if ($matchStage !== []) {
220	1	array_unshift($pipeline, ['$match' => $matchStage]);
221		}
222		}
223
224	26	return $pipeline;
225		}
226
227		/**
228		* Applies filters and discriminator queries to the pipeline
229		*
230		* @param array $query
231		* @return array
232		*/
233	26	private function applyFilters(array $query)
234		{
235	26	$documentPersister = $this->dm->getUnitOfWork()->getDocumentPersister($this->class->name);
236
237	26	$query = $documentPersister->addDiscriminatorToPreparedQuery($query);
238	26	$query = $documentPersister->addFilterToPreparedQuery($query);
239
240	26	return $query;
241		}
242
243		/**
244		* @param BaseCommandCursor $cursor
245		*
246		* @return CommandCursor
247		*/
248	17	private function prepareCursor(BaseCommandCursor $cursor)
249		{
250	17	$class = null;
251	17	if ($this->hydrationClass) {
252	4	$class = $this->dm->getClassMetadata($this->hydrationClass);
253		}
254
255	17	return new CommandCursor($cursor, $this->dm->getUnitOfWork(), $class);
256		}
257
258		/**
259		* @return \Doctrine\ODM\MongoDB\Persisters\DocumentPersister
260		*/
261	4	private function getDocumentPersister()
262		{
263	4	return $this->dm->getUnitOfWork()->getDocumentPersister($this->class->name);
264		}
265		}
266

doctrine / mongodb-odm

Pull Request — master (#1654)

Builder::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like