GeoNear::distanceMultiplier() - Code Metrics - Inspection of "Merge pull request #1756 from malarzm/cs-unused-st..." - doctrine/mongodb-odm - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a74607...8291b9 )

by Maciej

created 2018-03-16 09:02 UTC

GeoNear::distanceMultiplier() A

↳ Parent: GeoNear

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	6
ccs	3
cts	3
cp	1
rs	9.4285
c	0
b	0
f	0
cc	1
eloc	3
nc	1
nop	1
crap	1

<?php

declare(strict_types=1);

namespace Doctrine\ODM\MongoDB\Aggregation\Stage;

use Doctrine\ODM\MongoDB\Aggregation\Builder;
use GeoJson\Geometry\Point;
use function is_array;

/**
 * Fluent interface for adding a $geoNear stage to an aggregation pipeline.
 *
 */
class GeoNear extends Match
{
    /** @var string */
    private $distanceField;

    /** @var float */
    private $distanceMultiplier;

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

    /** @var float */
    private $maxDistance;

    /** @var float */
    private $minDistance;

    /** @var array */
    private $near;

    /** @var int */
    private $num;

    /** @var bool */
    private $spherical = false;

    /** @var bool */
    private $uniqueDocs;

    /**
     * @param float|array|Point $x
     * @param float             $y
     */
    public function __construct(Builder $builder, $x, $y = null)
    {
        parent::__construct($builder);

        $this->near($x, $y);
    }

    /**
     * {@inheritdoc}
     */
    public function getExpression()
    {
        $geoNear = [
            'near' => $this->near,
            'spherical' => $this->spherical,
            'distanceField' => $this->distanceField,
            'query' => $this->query->getQuery(),
            'distanceMultiplier' => $this->distanceMultiplier,
            'includeLocs' => $this->includeLocs,
            'maxDistance' => $this->maxDistance,
            'minDistance' => $this->minDistance,
            'num' => $this->num,
            'uniqueDocs' => $this->uniqueDocs,
        ];

        foreach (['distanceMultiplier', 'includeLocs', 'maxDistance', 'minDistance', 'num', 'uniqueDocs'] as $option) {
            if ($geoNear[$option]) {
                continue;
            }

            unset($geoNear[$option]);
        }

        return ['$geoNear' => $geoNear];
    }

    /**
     * The output field that contains the calculated distance. To specify a field within an embedded document, use dot notation.
     *
     * @param string $distanceField
     * @return $this
     */
    public function distanceField($distanceField)
    {
        $this->distanceField = (string) $distanceField;

        return $this;
    }

    /**
     * The factor to multiply all distances returned by the query.
     *
     * @param float $distanceMultiplier
     * @return $this
     */
    public function distanceMultiplier($distanceMultiplier)
    {
        $this->distanceMultiplier = (float) $distanceMultiplier;

        return $this;
    }

    /**
     * This specifies the output field that identifies the location used to calculate the distance.
     *
     * @param string $includeLocs
     * @return $this
     */
    public function includeLocs($includeLocs)
    {
        $this->includeLocs = (string) $includeLocs;

        return $this;
    }

    /**
     * The maximum number of documents to return.
     *
     * @param int $limit
     * @return $this
     */
    public function limit($limit)
    {
        return $this->num($limit);
class Author {
    private $name;

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

    public function getName() {
        return $this->name;
    }
}

abstract class Post {
    public function getAuthor() {
        return 'Johannes';
    }
}

class BlogPost extends Post {
    public function getAuthor() {
        return new Author('Johannes');
    }
}

class ForumPost extends Post { /* ... */ }

function my_function(Post $post) {
    echo strtoupper($post->getAuthor());
}
    }

    /**
     * The maximum distance from the center point that the documents can be.
     *
     * @param float $maxDistance
     * @return $this
     */
    public function maxDistance($maxDistance)
    {
        $this->maxDistance = (float) $maxDistance;

        return $this;
    }

    /**
     * The minimum distance from the center point that the documents can be.
     *
     * @param float $minDistance
     * @return $this
     *
     */
    public function minDistance($minDistance)
    {
        $this->minDistance = (float) $minDistance;

        return $this;
    }

    /**
     * The point for which to find the closest documents.
     *
     * A GeoJSON point may be provided as the first and only argument for
     * 2dsphere queries. This single parameter may be a GeoJSON point object or
     * an array corresponding to the point's JSON representation. If GeoJSON is
     * used, the "spherical" option will default to true.
     *
     * @param float|array|Point $x
     * @param float             $y
     * @return $this
     */
    public function near($x, $y = null)
    {
        if ($x instanceof Point) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $x = $x->jsonSerialize();
        }

        $this->near = is_array($x) ? $x : [$x, $y];
        $this->spherical = is_array($x) && isset($x['type']);

        return $this;
    }

    /**
     * The maximum number of documents to return.
     *
     * @param int $num
     * @return $this
     */
    public function num($num)
    {
        $this->num = (int) $num;

        return $this;
    }

    /**
     * Required if using a 2dsphere index. Determines how MongoDB calculates the distance.
     *
     * @param bool $spherical
     * @return $this
     */
    public function spherical($spherical = true)
    {
        $this->spherical = (bool) $spherical;

        return $this;
    }

    /**
     * If this value is true, the query returns a matching document once, even if more than one of the document’s location fields match the query.
     *
     * @param bool $uniqueDocs
     * @return $this
     */
    public function uniqueDocs($uniqueDocs = true)
    {
        $this->uniqueDocs = (bool) $uniqueDocs;

        return $this;
    }
}


Push — master ( a74607...8291b9 )

GeoNear::distanceMultiplier() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

1		<?php
2
3		declare(strict_types=1);
4
5		namespace Doctrine\ODM\MongoDB\Aggregation\Stage;
6
7		use Doctrine\ODM\MongoDB\Aggregation\Builder;
8		use GeoJson\Geometry\Point;
9		use function is_array;
10
11		/**
12		* Fluent interface for adding a $geoNear stage to an aggregation pipeline.
13		*
14		*/
15		class GeoNear extends Match
16		{
17		/** @var string */
18		private $distanceField;
19
20		/** @var float */
21		private $distanceMultiplier;
22
23		/** @var string */
24		private $includeLocs;
25
26		/** @var float */
27		private $maxDistance;
28
29		/** @var float */
30		private $minDistance;
31
32		/** @var array */
33		private $near;
34
35		/** @var int */
36		private $num;
37
38		/** @var bool */
39		private $spherical = false;
40
41		/** @var bool */
42		private $uniqueDocs;
43
44		/**
45		* @param float\|array\|Point $x
46		* @param float $y
47		*/
48	11	public function __construct(Builder $builder, $x, $y = null)
49		{
50	11	parent::__construct($builder);
51
52	11	$this->near($x, $y);
53	11	}
54
55		/**
56		* {@inheritdoc}
57		*/
58	11	public function getExpression()
59		{
60		$geoNear = [
61	11	'near' => $this->near,
62	11	'spherical' => $this->spherical,
63	11	'distanceField' => $this->distanceField,
64	11	'query' => $this->query->getQuery(),
65	11	'distanceMultiplier' => $this->distanceMultiplier,
66	11	'includeLocs' => $this->includeLocs,
67	11	'maxDistance' => $this->maxDistance,
68	11	'minDistance' => $this->minDistance,
69	11	'num' => $this->num,
70	11	'uniqueDocs' => $this->uniqueDocs,
71		];
72
73	11	foreach (['distanceMultiplier', 'includeLocs', 'maxDistance', 'minDistance', 'num', 'uniqueDocs'] as $option) {
74	11	if ($geoNear[$option]) {
75	8	continue;
76		}
77
78	11	unset($geoNear[$option]);
79		}
80
81	11	return ['$geoNear' => $geoNear];
82		}
83
84		/**
85		* The output field that contains the calculated distance. To specify a field within an embedded document, use dot notation.
86		*
87		* @param string $distanceField
88		* @return $this
89		*/
90	3	public function distanceField($distanceField)
91		{
92	3	$this->distanceField = (string) $distanceField;
93
94	3	return $this;
95		}
96
97		/**
98		* The factor to multiply all distances returned by the query.
99		*
100		* @param float $distanceMultiplier
101		* @return $this
102		*/
103	1	public function distanceMultiplier($distanceMultiplier)
104		{
105	1	$this->distanceMultiplier = (float) $distanceMultiplier;
106
107	1	return $this;
108		}
109
110		/**
111		* This specifies the output field that identifies the location used to calculate the distance.
112		*
113		* @param string $includeLocs
114		* @return $this
115		*/
116	1	public function includeLocs($includeLocs)
117		{
118	1	$this->includeLocs = (string) $includeLocs;
119
120	1	return $this;
121		}
122
123		/**
124		* The maximum number of documents to return.
125		*
126		* @param int $limit
127		* @return $this
128		*/
129	2	public function limit($limit)
130		{
131	2	return $this->num($limit);
		0 ignored issues – show Bug Best Practice introduced 2017-12-22 05:31 UTC by Report Bug Copy Issue Report The return type of `return $this->num($limit);` (`Doctrine\ODM\MongoDB\Aggregation\Stage\GeoNear`) is incompatible with the return type of the parent method `Doctrine\ODM\MongoDB\Aggregation\Stage::limit` of type `Doctrine\ODM\MongoDB\Aggregation\Stage\Limit`. If you return a value from a function or method, it should be a sub-type of the type that is given by the parent type f.e. an interface, or abstract method. This is more formally defined by the Lizkov substitution principle, and guarantees that classes that depend on the parent type can use any instance of a child type interchangably. This principle also belongs to the SOLID principles for object oriented design. Let’s take a look at an example: class Author { private $name; public function __construct($name) { $this->name = $name; } public function getName() { return $this->name; } } abstract class Post { public function getAuthor() { return 'Johannes'; } } class BlogPost extends Post { public function getAuthor() { return new Author('Johannes'); } } class ForumPost extends Post { /* ... */ } function my_function(Post $post) { echo strtoupper($post->getAuthor()); } Our function `my_function` expects a `Post` object, and outputs the author of the post. The base class `Post` returns a simple string and outputting a simple string will work just fine. However, the child class `BlogPost` which is a sub-type of `Post` instead decided to return an `object`, and is therefore violating the SOLID principles. If a `BlogPost` were passed to `my_function`, PHP would not complain, but ultimately fail when executing the `strtoupper` call in its body. Loading history...
132		}
133
134		/**
135		* The maximum distance from the center point that the documents can be.
136		*
137		* @param float $maxDistance
138		* @return $this
139		*/
140	1	public function maxDistance($maxDistance)
141		{
142	1	$this->maxDistance = (float) $maxDistance;
143
144	1	return $this;
145		}
146
147		/**
148		* The minimum distance from the center point that the documents can be.
149		*
150		* @param float $minDistance
151		* @return $this
152		*
153		*/
154	1	public function minDistance($minDistance)
155		{
156	1	$this->minDistance = (float) $minDistance;
157
158	1	return $this;
159		}
160
161		/**
162		* The point for which to find the closest documents.
163		*
164		* A GeoJSON point may be provided as the first and only argument for
165		* 2dsphere queries. This single parameter may be a GeoJSON point object or
166		* an array corresponding to the point's JSON representation. If GeoJSON is
167		* used, the "spherical" option will default to true.
168		*
169		* @param float\|array\|Point $x
170		* @param float $y
171		* @return $this
172		*/
173	11	public function near($x, $y = null)
174		{
175	11	if ($x instanceof Point) {
		0 ignored issues – show Bug introduced 2018-01-06 12:29 UTC by Report Bug Copy Issue Report The class `GeoJson\Geometry\Point` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
176		$x = $x->jsonSerialize();
177		}
178
179	11	$this->near = is_array($x) ? $x : [$x, $y];
180	11	$this->spherical = is_array($x) && isset($x['type']);
181
182	11	return $this;
183		}
184
185		/**
186		* The maximum number of documents to return.
187		*
188		* @param int $num
189		* @return $this
190		*/
191	3	public function num($num)
192		{
193	3	$this->num = (int) $num;
194
195	3	return $this;
196		}
197
198		/**
199		* Required if using a 2dsphere index. Determines how MongoDB calculates the distance.
200		*
201		* @param bool $spherical
202		* @return $this
203		*/
204		public function spherical($spherical = true)
205		{
206		$this->spherical = (bool) $spherical;
207
208		return $this;
209		}
210
211		/**
212		* If this value is true, the query returns a matching document once, even if more than one of the document’s location fields match the query.
213		*
214		* @param bool $uniqueDocs
215		* @return $this
216		*/
217	1	public function uniqueDocs($uniqueDocs = true)
218		{
219	1	$this->uniqueDocs = (bool) $uniqueDocs;
220
221	1	return $this;
222		}
223		}
224

doctrine / mongodb-odm

Push — master ( a74607...8291b9 )

GeoNear::distanceMultiplier() A

Complexity

Size

Duplication

Code Coverage

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like