Polygon::containsGeometry() - Code Metrics - Inspection of "docs: update and extend documentation" - mjaschen/phpgeo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ffb45a...dc303d )

by Marcus

created 2016-03-14 13:29 UTC

Polygon::containsGeometry() A

↳ Parent: Polygon

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	11
rs	9.4285
cc	3
eloc	5
nc	3
nop	1

<?php
/**
 * Polygon Implementation
 *
 * PHP version 5
 *
 * @category  Location
 * @author    Paul Vidal <[email protected]>
 * @author    Marcus Jaschen <[email protected]>
 * @license   https://opensource.org/licenses/GPL-3.0 GPL
 * @link      https://github.com/mjaschen/phpgeo
 */

namespace Location;

use Location\Distance\DistanceInterface;
use Location\Formatter\Polygon\FormatterInterface;

/**
 * Polygon Implementation
 *
 * @category Location
 * @author   Paul Vidal <[email protected]>
 * @author   Marcus Jaschen <[email protected]>
 * @license  https://opensource.org/licenses/GPL-3.0 GPL
 * @link     https://github.com/mjaschen/phpgeo
 */
class Polygon implements GeometryInterface
{
    /**
     * @var array
     */
    protected $points = [];

    /**
     * @param Coordinate $point
     */
    public function addPoint(Coordinate $point)
    {
        $this->points[] = $point;
    }

    /**
     * @return array
     */
    public function getPoints()
    {
        return $this->points;
    }

    /**
     * Return all polygon point's latitudes.
     *
     * @return float
     */
    public function getLats()
    {
        $lats = [];

        foreach ($this->points as $point) {
            $lats[] = $point->getLat();
        }

        return $lats;
    }

    /**
     * Return all polygon point's longitudes.
     *
     * @return float
     */
    public function getLngs()
    {
        $lngs = [];

        foreach ($this->points as $point) {
            $lngs[] = $point->getLng();
        }

        return $lngs;
    }

    /**
     * @return int
     */
    public function getNumberOfPoints()
    {
        return count($this->points);
    }

    /**
     * @param FormatterInterface $formatter
     *
     * @return mixed
     */
    public function format(FormatterInterface $formatter)
    {
        return $formatter->format($this);
    }

    /**
     * @return array
     */
    public function getSegments()
    {
        $segments = [];

        if (count($this->points) <= 1) {
            return $segments;
        }

        $previousPoint = reset($this->points);

        while ($point = next($this->points)) {

            $segments[]    = new Line($previousPoint, $point);
            $previousPoint = $point;
        }

        // to close the polygon we have to add the final segment between
        // the last point and the first point
        $segments[] = new Line(end($this->points), reset($this->points));

        return $segments;
    }

    /**
     * Determine if given geometry is contained inside the polygon. This is
     * assumed to be true, if each point of the geometry is inside the polygon.
     *
     * Edge cases:
     *
     * - it's not detected when a line between two points is outside the polygon
     * - @see contains() for more restrictions
     *
     * @param GeometryInterface $geometry
     *
     * @return boolean
     */
    public function containsGeometry(GeometryInterface $geometry)
    {
        $geometryInPolygon = true;

        /** @var Coordinate $point */
        foreach ($geometry->getPoints() as $point) {
            $geometryInPolygon = $geometryInPolygon && $this->contains($point);
        }

        return $geometryInPolygon;
    }

    /**
     * Determine if given point is contained inside the polygon. Uses the PNPOLY
     * algorithm by W. Randolph Franklin. Therfore some edge cases may not give the
     * expected results, e. g. if the point resides on the polygon boundary.
     *
     * @see http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html
     *
     * For special cases this calculation leads to wrong results:
     *
     * - if the polygons spans over the longitude boundaries at 180/-180 degrees
     *
     * @param Coordinate $point
     *
     * @return boolean
     */
    public function contains(Coordinate $point)
    {
        $numberOfPoints = $this->getNumberOfPoints();
        $polygonLats    = $this->getLats();
        $polygonLngs    = $this->getLngs();

        $polygonContainsPoint = false;

        for ($node = 0, $altNode = ($numberOfPoints - 1); $node < $numberOfPoints; $altNode = $node ++) {
            if (($polygonLngs[$node] > $point->getLng() != ($polygonLngs[$altNode] > $point->getLng()))
                && ($point->getLat() < ($polygonLats[$altNode] - $polygonLats[$node])
                                       * ($point->getLng() - $polygonLngs[$node])
                                       / ($polygonLngs[$altNode] - $polygonLngs[$node])
                                       + $polygonLats[$node]
                )
            ) {
                $polygonContainsPoint = ! $polygonContainsPoint;
            }
        }

        return $polygonContainsPoint;
    }

    /**
     * Calculates the polygon perimeter.
     *
     * @param DistanceInterface $calculator instance of distance calculation class
     *
     * @return float
     */
    public function getPerimeter(DistanceInterface $calculator)

    {
        $perimeter = 0.0;

        if (count($this->points) < 2) {
            return $perimeter;
        }

        foreach ($this->getSegments() as $segment) {
            $perimeter += $segment->getLength($calculator);
        }

        return $perimeter;
    }

    /**
     * Calculates the polygon area.
     *
     * @return float
     *
     * @fixme This calculation gives wrong results, please don't use it!
     */
    public function getArea()
    {
        $area = 0.0;

        $numberOfPoints = $this->getNumberOfPoints();
        if ($numberOfPoints < 2) {
            return $area;
        }

        foreach ($this->points as $key => $point) {
            $j = ($key + 1) % $numberOfPoints;
            $area += ($this->points[$j]->getLng() * $point->getLat())
                     - ($point->getLng() * $this->points[$j]->getLat());
        }

        return abs($area / 2) * $this->points[0]->getEllipsoid()->getA();
    }
}


1		<?php
2		/**
3		* Polygon Implementation
4		*
5		* PHP version 5
6		*
7		* @category Location
8		* @author Paul Vidal <[email protected]>
9		* @author Marcus Jaschen <[email protected]>
10		* @license https://opensource.org/licenses/GPL-3.0 GPL
11		* @link https://github.com/mjaschen/phpgeo
12		*/
13
14		namespace Location;
15
16		use Location\Distance\DistanceInterface;
17		use Location\Formatter\Polygon\FormatterInterface;
18
19		/**
20		* Polygon Implementation
21		*
22		* @category Location
23		* @author Paul Vidal <[email protected]>
24		* @author Marcus Jaschen <[email protected]>
25		* @license https://opensource.org/licenses/GPL-3.0 GPL
26		* @link https://github.com/mjaschen/phpgeo
27		*/
28		class Polygon implements GeometryInterface
29		{
30		/**
31		* @var array
32		*/
33		protected $points = [];
34
35		/**
36		* @param Coordinate $point
37		*/
38		public function addPoint(Coordinate $point)
39		{
40		$this->points[] = $point;
41		}
42
43		/**
44		* @return array
45		*/
46		public function getPoints()
47		{
48		return $this->points;
49		}
50
51		/**
52		* Return all polygon point's latitudes.
53		*
54		* @return float
55		*/
56		public function getLats()
57		{
58		$lats = [];
59
60		foreach ($this->points as $point) {
61		$lats[] = $point->getLat();
62		}
63
64		return $lats;
65		}
66
67		/**
68		* Return all polygon point's longitudes.
69		*
70		* @return float
71		*/
72		public function getLngs()
73		{
74		$lngs = [];
75
76		foreach ($this->points as $point) {
77		$lngs[] = $point->getLng();
78		}
79
80		return $lngs;
81		}
82
83		/**
84		* @return int
85		*/
86		public function getNumberOfPoints()
87		{
88		return count($this->points);
89		}
90
91		/**
92		* @param FormatterInterface $formatter
93		*
94		* @return mixed
95		*/
96		public function format(FormatterInterface $formatter)
97		{
98		return $formatter->format($this);
99		}
100
101		/**
102		* @return array
103		*/
104		public function getSegments()
105		{
106		$segments = [];
107
108		if (count($this->points) <= 1) {
109		return $segments;
110		}
111
112		$previousPoint = reset($this->points);
113
114	View Code Duplication	while ($point = next($this->points)) {
		0 ignored issues – show Duplication introduced 2016-02-11 11:20 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...
115		$segments[] = new Line($previousPoint, $point);
116		$previousPoint = $point;
117		}
118
119		// to close the polygon we have to add the final segment between
120		// the last point and the first point
121		$segments[] = new Line(end($this->points), reset($this->points));
122
123		return $segments;
124		}
125
126		/**
127		* Determine if given geometry is contained inside the polygon. This is
128		* assumed to be true, if each point of the geometry is inside the polygon.
129		*
130		* Edge cases:
131		*
132		* - it's not detected when a line between two points is outside the polygon
133		* - @see contains() for more restrictions
134		*
135		* @param GeometryInterface $geometry
136		*
137		* @return boolean
138		*/
139		public function containsGeometry(GeometryInterface $geometry)
140		{
141		$geometryInPolygon = true;
142
143		/** @var Coordinate $point */
144		foreach ($geometry->getPoints() as $point) {
145		$geometryInPolygon = $geometryInPolygon && $this->contains($point);
146		}
147
148		return $geometryInPolygon;
149		}
150
151		/**
152		* Determine if given point is contained inside the polygon. Uses the PNPOLY
153		* algorithm by W. Randolph Franklin. Therfore some edge cases may not give the
154		* expected results, e. g. if the point resides on the polygon boundary.
155		*
156		* @see http://www.ecse.rpi.edu/Homepages/wrf/Research/Short_Notes/pnpoly.html
157		*
158		* For special cases this calculation leads to wrong results:
159		*
160		* - if the polygons spans over the longitude boundaries at 180/-180 degrees
161		*
162		* @param Coordinate $point
163		*
164		* @return boolean
165		*/
166		public function contains(Coordinate $point)
167		{
168		$numberOfPoints = $this->getNumberOfPoints();
169		$polygonLats = $this->getLats();
170		$polygonLngs = $this->getLngs();
171
172		$polygonContainsPoint = false;
173
174		for ($node = 0, $altNode = ($numberOfPoints - 1); $node < $numberOfPoints; $altNode = $node ++) {
175		if (($polygonLngs[$node] > $point->getLng() != ($polygonLngs[$altNode] > $point->getLng()))
176		&& ($point->getLat() < ($polygonLats[$altNode] - $polygonLats[$node])
177		* ($point->getLng() - $polygonLngs[$node])
178		/ ($polygonLngs[$altNode] - $polygonLngs[$node])
179		+ $polygonLats[$node]
180		)
181		) {
182		$polygonContainsPoint = ! $polygonContainsPoint;
183		}
184		}
185
186		return $polygonContainsPoint;
187		}
188
189		/**
190		* Calculates the polygon perimeter.
191		*
192		* @param DistanceInterface $calculator instance of distance calculation class
193		*
194		* @return float
195		*/
196	View Code Duplication	public function getPerimeter(DistanceInterface $calculator)
		0 ignored issues – show Duplication introduced 2016-02-11 11:20 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...
197		{
198		$perimeter = 0.0;
199
200		if (count($this->points) < 2) {
201		return $perimeter;
202		}
203
204		foreach ($this->getSegments() as $segment) {
205		$perimeter += $segment->getLength($calculator);
206		}
207
208		return $perimeter;
209		}
210
211		/**
212		* Calculates the polygon area.
213		*
214		* @return float
215		*
216		* @fixme This calculation gives wrong results, please don't use it!
217		*/
218		public function getArea()
219		{
220		$area = 0.0;
221
222		$numberOfPoints = $this->getNumberOfPoints();
223		if ($numberOfPoints < 2) {
224		return $area;
225		}
226
227		foreach ($this->points as $key => $point) {
228		$j = ($key + 1) % $numberOfPoints;
229		$area += ($this->points[$j]->getLng() * $point->getLat())
230		- ($point->getLng() * $this->points[$j]->getLat());
231		}
232
233		return abs($area / 2) * $this->points[0]->getEllipsoid()->getA();
234		}
235		}
236

mjaschen / phpgeo

Push — master ( ffb45a...dc303d )

Polygon::containsGeometry() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like