Pipeline::getOptions() - Code Metrics - Inspection of "readme" - sokil/php-mongo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1e1b58...a9ac0a )

by De

created 2016-03-01 20:14 UTC

Pipeline::getOptions() A

↳ Parent: Pipeline

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

/**
 * This file is part of the PHPMongo package.
 *
 * (c) Dmytro Sokil <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sokil\Mongo;

use Sokil\Mongo\Pipeline\GroupStage;
use Sokil\Mongo\Structure\Arrayable;

class Pipeline implements Arrayable, \JsonSerializable
{

    private $stages = array();

    private $options = array();

    /**
     * @var \Sokil\Mongo\Collection
     */
    private $collection;

    public function __construct(Collection $collection)
    {
        $this->collection = $collection;
    }

    private function addStage($operator, $stage)
    {
        $lastIndex = count($this->stages) - 1;

        if (!$this->stages ||

            !isset($this->stages[$lastIndex][$operator]) ||
            in_array($operator, array('$group', '$unwind'))
        ) {
            $this->stages[] = array($operator => $stage);
        } else {
            $this->stages[$lastIndex][$operator] = array_merge($this->stages[$lastIndex][$operator], $stage);
        }
    }

    /**
     * Filter documents by expression
     *
     * @param array|\Sokil\Mongo\Expression $expression
     * @return \Sokil\Mongo\Pipeline
     * @throws \Sokil\Mongo\Exception
     */
    public function match($expression)

    {
        if (is_callable($expression)) {
            $expressionConfigurator = $expression;
            $expression = new Expression();
            call_user_func($expressionConfigurator, $expression);
            $expression = $expression->toArray();
        } elseif (!is_array($expression)) {
            throw new Exception('Must be array or instance of Expression');
        }

        $this->addStage('$match', $expression);
        return $this;
    }

    /**
     * Passes along the documents with only the specified fields to the next
     * stage in the pipeline. The specified fields can be existing fields
     * from the input documents or newly computed fields.
     *
     * @param array $pipeline
     * @return \Sokil\Mongo\Pipeline
     */
    public function project(array $pipeline)
    {
        $this->addStage('$project', $pipeline);
        return $this;
    }

    /**
     * Groups documents by some specified expression and outputs to the next 
     * stage a document for each distinct grouping. The output documents 
     * contain an _id field which contains the distinct group by key. The 
     * output documents can also contain computed fields that hold the values 
     * of some accumulator expression grouped by the $group‘s _id field. $group 
     * does not order its output documents.
     *
     * @link http://docs.mongodb.org/manual/reference/operator/aggregation/group/
     * 
     * @param array|callable $stage
     * @return \Sokil\Mongo\Pipeline
     * @throws \Sokil\Mongo\Exception
     */
    public function group($stage)
    {
        if (is_callable($stage)) {
            $configurator = $stage;
            $stage = new GroupStage();
            call_user_func($configurator, $stage);
        }
        
        if($stage instanceof GroupStage) {
            $stage = $stage->toArray();
        }

        if(!is_array($stage)) {
            throw new Exception('Group stage must be array or instance of Sokil\Mongo\Pipeline\GroupStage or callabe');
        }
        
        if (!isset($stage['_id'])) {
            throw new Exception('Group field in _id key must be specified');
        }

        $this->addStage('$group', $stage);
        return $this;
    }

    /**
     * Deconstructs an array field from the input documents to output a document for each element.
     * Each output document is the input document with the value of the array field replaced by the element.
     * @link http://docs.mongodb.org/manual/reference/operator/aggregation/unwind/
     *
     * @param string $path path to field
     * @return \Sokil\Mongo\Pipeline
     */
    public function unwind($path)
    {
        $this->addStage('$unwind', $path);
        return $this;
    }

    public function sort(array $sortFields)
    {
        $this->addStage('$sort', $sortFields);
        return $this;
    }

    public function limit($limit)
    {
        $this->addStage('$limit', (int) $limit);
        return $this;
    }

    public function skip($skip)
    {
        $this->addStage('$skip', (int) $skip);
        return $this;
    }

    public function aggregate(array $options = array()) {
        return $this->collection->aggregate($this, $options, false);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function aggregateCursor(array $options = array())
    {
        return $this->collection->aggregate($this, $options, true);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function toArray()
    {
        return $this->stages;
    }

    public function jsonSerialize()
    {
        return $this->stages;
    }

    public function __toString()
    {
        return json_encode($this->stages);
    }

    public function explain($allow = true)
    {
        $this->options['explain'] = (bool) $allow;
        return $this;
    }

    public function allowDiskUse($allow = true)
    {
        $this->options['allowDiskUse'] = (bool) $allow;
        return $this;
    }

    public function setBatchSize($batchSize)
    {
        $this->options['cursor']['batchSize'] = (int) $batchSize;
        return $this;
    }

    public function getOptions()
    {
        return $this->options;
    }
}


1		<?php
2
3		/**
4		* This file is part of the PHPMongo package.
5		*
6		* (c) Dmytro Sokil <[email protected]>
7		*
8		* For the full copyright and license information, please view the LICENSE
9		* file that was distributed with this source code.
10		*/
11
12		namespace Sokil\Mongo;
13
14		use Sokil\Mongo\Pipeline\GroupStage;
15		use Sokil\Mongo\Structure\Arrayable;
16
17		class Pipeline implements Arrayable, \JsonSerializable
18		{
19
20		private $stages = array();
21
22		private $options = array();
23
24		/**
25		* @var \Sokil\Mongo\Collection
26		*/
27		private $collection;
28
29		public function __construct(Collection $collection)
30		{
31		$this->collection = $collection;
32		}
33
34		private function addStage($operator, $stage)
35		{
36		$lastIndex = count($this->stages) - 1;
37
38		if (!$this->stages \|\|
		0 ignored issues – show Bug Best Practice introduced 2015-12-03 20:44 UTC by Report Bug Copy Issue Report The expression `$this->stages` 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...
39		!isset($this->stages[$lastIndex][$operator]) \|\|
40		in_array($operator, array('$group', '$unwind'))
41		) {
42		$this->stages[] = array($operator => $stage);
43		} else {
44		$this->stages[$lastIndex][$operator] = array_merge($this->stages[$lastIndex][$operator], $stage);
45		}
46		}
47
48		/**
49		* Filter documents by expression
50		*
51		* @param array\|\Sokil\Mongo\Expression $expression
52		* @return \Sokil\Mongo\Pipeline
53		* @throws \Sokil\Mongo\Exception
54		*/
55	View Code Duplication	public function match($expression)
		0 ignored issues – show Duplication introduced 2015-12-03 20:44 UTC by Report Bug Copy Issue Report This method seems to be duplicated in 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...
56		{
57		if (is_callable($expression)) {
58		$expressionConfigurator = $expression;
59		$expression = new Expression();
60		call_user_func($expressionConfigurator, $expression);
61		$expression = $expression->toArray();
62		} elseif (!is_array($expression)) {
63		throw new Exception('Must be array or instance of Expression');
64		}
65
66		$this->addStage('$match', $expression);
67		return $this;
68		}
69
70		/**
71		* Passes along the documents with only the specified fields to the next
72		* stage in the pipeline. The specified fields can be existing fields
73		* from the input documents or newly computed fields.
74		*
75		* @param array $pipeline
76		* @return \Sokil\Mongo\Pipeline
77		*/
78		public function project(array $pipeline)
79		{
80		$this->addStage('$project', $pipeline);
81		return $this;
82		}
83
84		/**
85		* Groups documents by some specified expression and outputs to the next
86		* stage a document for each distinct grouping. The output documents
87		* contain an _id field which contains the distinct group by key. The
88		* output documents can also contain computed fields that hold the values
89		* of some accumulator expression grouped by the $group‘s _id field. $group
90		* does not order its output documents.
91		*
92		* @link http://docs.mongodb.org/manual/reference/operator/aggregation/group/
93		*
94		* @param array\|callable $stage
95		* @return \Sokil\Mongo\Pipeline
96		* @throws \Sokil\Mongo\Exception
97		*/
98		public function group($stage)
99		{
100		if (is_callable($stage)) {
101		$configurator = $stage;
102		$stage = new GroupStage();
103		call_user_func($configurator, $stage);
104		}
105
106		if($stage instanceof GroupStage) {
107		$stage = $stage->toArray();
108		}
109
110		if(!is_array($stage)) {
111		throw new Exception('Group stage must be array or instance of Sokil\Mongo\Pipeline\GroupStage or callabe');
112		}
113
114		if (!isset($stage['_id'])) {
115		throw new Exception('Group field in _id key must be specified');
116		}
117
118		$this->addStage('$group', $stage);
119		return $this;
120		}
121
122		/**
123		* Deconstructs an array field from the input documents to output a document for each element.
124		* Each output document is the input document with the value of the array field replaced by the element.
125		* @link http://docs.mongodb.org/manual/reference/operator/aggregation/unwind/
126		*
127		* @param string $path path to field
128		* @return \Sokil\Mongo\Pipeline
129		*/
130		public function unwind($path)
131		{
132		$this->addStage('$unwind', $path);
133		return $this;
134		}
135
136		public function sort(array $sortFields)
137		{
138		$this->addStage('$sort', $sortFields);
139		return $this;
140		}
141
142		public function limit($limit)
143		{
144		$this->addStage('$limit', (int) $limit);
145		return $this;
146		}
147
148		public function skip($skip)
149		{
150		$this->addStage('$skip', (int) $skip);
151		return $this;
152		}
153
154		public function aggregate(array $options = array()) {
155		return $this->collection->aggregate($this, $options, false);
		0 ignored issues – show Documentation introduced 2016-03-01 20:16 UTC by Report Bug Copy Issue Report `$this` is of type `this<Sokil\Mongo\Pipeline>`, but the function expects a `callable`. 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...
156		}
157
158		public function aggregateCursor(array $options = array())
159		{
160		return $this->collection->aggregate($this, $options, true);
		0 ignored issues – show Documentation introduced 2015-12-03 20:44 UTC by Report Bug Copy Issue Report `$this` is of type `this<Sokil\Mongo\Pipeline>`, but the function expects a `callable`. 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...
161		}
162
163		public function toArray()
164		{
165		return $this->stages;
166		}
167
168		public function jsonSerialize()
169		{
170		return $this->stages;
171		}
172
173		public function __toString()
174		{
175		return json_encode($this->stages);
176		}
177
178		public function explain($allow = true)
179		{
180		$this->options['explain'] = (bool) $allow;
181		return $this;
182		}
183
184		public function allowDiskUse($allow = true)
185		{
186		$this->options['allowDiskUse'] = (bool) $allow;
187		return $this;
188		}
189
190		public function setBatchSize($batchSize)
191		{
192		$this->options['cursor']['batchSize'] = (int) $batchSize;
193		return $this;
194		}
195
196		public function getOptions()
197		{
198		return $this->options;
199		}
200		}
201

sokil / php-mongo

GitHub Access Token became invalid

Push — master ( 1e1b58...a9ac0a )

Pipeline::getOptions() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like