MultiGeometry::elevationGain() - Code Metrics - swen100/geoPHP - Measure and Improve Code Quality continuously with Scrutinizer

MultiGeometry::elevationGain() A
last analyzed 2022-08-18 15:20 UTC

↳ Parent: MultiGeometry

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	1

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

<?php

namespace geoPHP\Geometry;

use geoPHP\geoPHP;

/**
 * MultiGeometry is an abstract collection of geometries
 *
 * @package GeoPHPGeometry
 */
abstract class MultiGeometry extends Collection
{

    /**
     * @param Geometry[] $components
     * @param bool       $allowEmptyComponents
     * @param string     $allowedComponentType
     */
    public function __construct(
        array $components = [],
        bool $allowEmptyComponents = true,
        string $allowedComponentType = Geometry::class
    ) {
        parent::__construct($components, $allowEmptyComponents, $allowedComponentType);
    }

    /**
     * @return bool
     */
    public function isSimple(): bool
    {
        $geosObj = $this->getGeos();
        if (is_object($geosObj)) {
            // @codeCoverageIgnoreStart
            /** @noinspection PhpUndefinedMethodInspection */
            return $geosObj->isSimple();
            // @codeCoverageIgnoreEnd
        }

        // A collection is simple if all it's components are simple
        foreach ($this->components as $component) {
            if (!$component->isSimple()) {
                return false;
            }
        }

        return true;
    }
    
    /**
     * @return bool
     */
    public function isValid(): bool
    {
        if ($this->getGeos()) {
            return parent::isValid();
        }

        // A collection is valid if all it's components are valid
        foreach ($this->components as $component) {
            if (!$component->isValid()) {
                return false;
            }
        }

        return true;
    }

    /**
     * Returns the boundary, or an empty geometry of appropriate dimension if this Geometry is empty.
     * By default, the boundary of a collection is the boundary of it's components.
     * In the case of zero-dimensional geometries, an empty GeometryCollection is returned.
     *
     * @return Geometry|GeometryCollection
     */
    public function boundary(): Geometry
    {
        if ($this->isEmpty()) {
            return new GeometryCollection();
        }

        $geosObj = $this->getGeos();
        if (is_object($geosObj)) {
            // @codeCoverageIgnoreStart
            /** @noinspection PhpUndefinedMethodInspection */
            /** @phpstan-ignore-next-line */
            return $geosObj->boundary();

            // @codeCoverageIgnoreEnd
        }

        $componentsBoundaries = [];
        foreach ($this->components as $component) {
            $componentsBoundaries[] = $component->boundary();
        }
        return geoPHP::buildGeometry($componentsBoundaries);
    }

    /**
     * Returns the total area of this collection.
     *
     * @return float
     */
    public function getArea(): float
    {
        $geosObj = $this->getGeos();
        if (is_object($geosObj)) {
            // @codeCoverageIgnoreStart
            /** @noinspection PhpUndefinedMethodInspection */
            return (float) $geosObj->area();
            // @codeCoverageIgnoreEnd
        }

        $area = 0.0;
        foreach ($this->components as $component) {
            $area += $component->getArea();
        }
        return (float) $area;
    }

    /**
     * Returns the length of this Collection in its associated spatial reference.
     * Eg. if Geometry is in geographical coordinate system it returns the length in degrees
     *
     * @return float
     */
    public function getLength(): float
    {
        $length = 0.0;
        foreach ($this->components as $component) {
            $length += $component->getLength();
        }
        return $length;
    }

    public function length3D(): float
    {
        $length = 0.0;
        foreach ($this->components as $component) {
            $length += $component->length3D();
        }
        return $length;
    }

    /**
     * Returns the degree based Geometry' length in meters
     *
     * @param  float|int $radius Default is the semi-major axis of WGS84.
     * @return float the length in meters
     */
    public function greatCircleLength($radius = geoPHP::EARTH_WGS84_SEMI_MAJOR_AXIS): float
    {
        $length = 0.0;
        foreach ($this->components as $component) {
            $length += $component->greatCircleLength($radius);
        }
        return $length;
    }

    /**
     * @return float sum haversine length of all components
     */
    public function haversineLength(): float
    {
        $length = 0.0;
        foreach ($this->components as $component) {
            $length += $component->haversineLength();
        }
        return $length;
    }

    public function minimumZ()
    {
        $min = PHP_INT_MAX;
        foreach ($this->components as $component) {
            $componentMin = $component->minimumZ();
            if (null !== $componentMin && $componentMin < $min) {
                $min = $componentMin;
            }
        }
        return $min !== PHP_INT_MAX ? $min : null;
    }

    public function maximumZ()
    {
        $max = PHP_INT_MIN;
        foreach ($this->components as $component) {
            $componentMax = $component->maximumZ();
            if ($componentMax > $max) {
                $max = $componentMax;
            }
        }
        return $max !== PHP_INT_MIN ? $max : null;
    }

    public function zDifference()
    {
        $startPoint = $this->startPoint();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        $endPoint = $this->endPoint();
class A
{
    function getObject()
    {
        return null;
    }

}

$a = new A();
$object = $a->getObject();
        if ($startPoint && $endPoint && $startPoint->hasZ() && $endPoint->hasZ()) {

            return abs($startPoint->getZ() - $endPoint->getZ());
        }
        
        return null;
    }

    /**
     *
     * @param int|float $verticalTolerance
     * @return int|float|null
     */
    public function elevationGain($verticalTolerance = 0)
    {
        $gain = null;
        foreach ($this->components as $component) {
            $gain += $component->elevationGain($verticalTolerance);
        }
        return $gain;
    }

    public function elevationLoss($verticalTolerance = 0)
    {
        $loss = null;
        foreach ($this->components as $component) {
            $loss += $component->elevationLoss($verticalTolerance);
        }
        return $loss;
    }

    public function minimumM()
    {
        $min = PHP_INT_MAX;
        foreach ($this->components as $component) {
            $componentMin = $component->minimumM();
            if ($componentMin < $min) {
                $min = $componentMin;
            }
        }
        return $min !== PHP_INT_MAX ? $min : null;
    }

    public function maximumM()
    {
        $max = PHP_INT_MIN;
        foreach ($this->components as $component) {
            $componentMax = $component->maximumM();
            if ($componentMax > $max) {
                $max = $componentMax;
            }
        }
        return $max !== PHP_INT_MIN ? $max : null;
    }

    public function isClosed(): bool
    {
        return true;
    }
}


1			<?php
2
3			namespace geoPHP\Geometry;
4
5			use geoPHP\geoPHP;
6
7			/**
8			* MultiGeometry is an abstract collection of geometries
9			*
10			* @package GeoPHPGeometry
11			*/
12			abstract class MultiGeometry extends Collection
13			{
14
15			/**
16			* @param Geometry[] $components
17			* @param bool $allowEmptyComponents
18			* @param string $allowedComponentType
19			*/
20			public function __construct(
21			array $components = [],
22			bool $allowEmptyComponents = true,
23			string $allowedComponentType = Geometry::class
24			) {
25			parent::__construct($components, $allowEmptyComponents, $allowedComponentType);
26			}
27
28			/**
29			* @return bool
30			*/
31			public function isSimple(): bool
32			{
33			$geosObj = $this->getGeos();
34			if (is_object($geosObj)) {
35			// @codeCoverageIgnoreStart
36			/** @noinspection PhpUndefinedMethodInspection */
37			return $geosObj->isSimple();
38			// @codeCoverageIgnoreEnd
39			}
40
41			// A collection is simple if all it's components are simple
42			foreach ($this->components as $component) {
43			if (!$component->isSimple()) {
44			return false;
45			}
46			}
47
48			return true;
49			}
50
51			/**
52			* @return bool
53			*/
54			public function isValid(): bool
55			{
56			if ($this->getGeos()) {
57			return parent::isValid();
58			}
59
60			// A collection is valid if all it's components are valid
61			foreach ($this->components as $component) {
62			if (!$component->isValid()) {
63			return false;
64			}
65			}
66
67			return true;
68			}
69
70			/**
71			* Returns the boundary, or an empty geometry of appropriate dimension if this Geometry is empty.
72			* By default, the boundary of a collection is the boundary of it's components.
73			* In the case of zero-dimensional geometries, an empty GeometryCollection is returned.
74			*
75			* @return Geometry\|GeometryCollection
76			*/
77			public function boundary(): Geometry
78			{
79			if ($this->isEmpty()) {
80			return new GeometryCollection();
81			}
82
83			$geosObj = $this->getGeos();
84			if (is_object($geosObj)) {
85			// @codeCoverageIgnoreStart
86			/** @noinspection PhpUndefinedMethodInspection */
87			/** @phpstan-ignore-next-line */
88			return $geosObj->boundary();
			0 ignored issues – show Bug Best Practice introduced 2022-08-18 15:20 UTC by Report Bug Copy Issue Report The expression `return $geosObj->boundary()` returns the type `GEOSGeometry` which is incompatible with the type-hinted return `geoPHP\Geometry\Geometry`. Loading history...
89			// @codeCoverageIgnoreEnd
90			}
91
92			$componentsBoundaries = [];
93			foreach ($this->components as $component) {
94			$componentsBoundaries[] = $component->boundary();
95			}
96			return geoPHP::buildGeometry($componentsBoundaries);
97			}
98
99			/**
100			* Returns the total area of this collection.
101			*
102			* @return float
103			*/
104			public function getArea(): float
105			{
106			$geosObj = $this->getGeos();
107			if (is_object($geosObj)) {
108			// @codeCoverageIgnoreStart
109			/** @noinspection PhpUndefinedMethodInspection */
110			return (float) $geosObj->area();
111			// @codeCoverageIgnoreEnd
112			}
113
114			$area = 0.0;
115			foreach ($this->components as $component) {
116			$area += $component->getArea();
117			}
118			return (float) $area;
119			}
120
121			/**
122			* Returns the length of this Collection in its associated spatial reference.
123			* Eg. if Geometry is in geographical coordinate system it returns the length in degrees
124			*
125			* @return float
126			*/
127			public function getLength(): float
128			{
129			$length = 0.0;
130			foreach ($this->components as $component) {
131			$length += $component->getLength();
132			}
133			return $length;
134			}
135
136			public function length3D(): float
137			{
138			$length = 0.0;
139			foreach ($this->components as $component) {
140			$length += $component->length3D();
141			}
142			return $length;
143			}
144
145			/**
146			* Returns the degree based Geometry' length in meters
147			*
148			* @param float\|int $radius Default is the semi-major axis of WGS84.
149			* @return float the length in meters
150			*/
151			public function greatCircleLength($radius = geoPHP::EARTH_WGS84_SEMI_MAJOR_AXIS): float
152			{
153			$length = 0.0;
154			foreach ($this->components as $component) {
155			$length += $component->greatCircleLength($radius);
156			}
157			return $length;
158			}
159
160			/**
161			* @return float sum haversine length of all components
162			*/
163			public function haversineLength(): float
164			{
165			$length = 0.0;
166			foreach ($this->components as $component) {
167			$length += $component->haversineLength();
168			}
169			return $length;
170			}
171
172			public function minimumZ()
173			{
174			$min = PHP_INT_MAX;
175			foreach ($this->components as $component) {
176			$componentMin = $component->minimumZ();
177			if (null !== $componentMin && $componentMin < $min) {
178			$min = $componentMin;
179			}
180			}
181			return $min !== PHP_INT_MAX ? $min : null;
182			}
183
184			public function maximumZ()
185			{
186			$max = PHP_INT_MIN;
187			foreach ($this->components as $component) {
188			$componentMax = $component->maximumZ();
189			if ($componentMax > $max) {
190			$max = $componentMax;
191			}
192			}
193			return $max !== PHP_INT_MIN ? $max : null;
194			}
195
196			public function zDifference()
197			{
198			$startPoint = $this->startPoint();
			0 ignored issues – show Bug introduced 2022-08-18 15:20 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$startPoint` is correct as `$this->startPoint()` targeting `geoPHP\Geometry\Geometry::startPoint()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
199			$endPoint = $this->endPoint();
			0 ignored issues – show Bug introduced 2022-08-18 15:20 UTC by Report Bug Copy Issue Report Are you sure the assignment to `$endPoint` is correct as `$this->endPoint()` targeting `geoPHP\Geometry\Geometry::endPoint()` seems to always return null. This check looks for function or method calls that always return null and whose return value is assigned to a variable. class A { function getObject() { return null; } } $a = new A(); $object = $a->getObject(); The method `getObject()` can return nothing but null, so it makes no sense to assign that value to a variable. The reason is most likely that a function or method is imcomplete or has been reduced for debug purposes. Loading history...
200			if ($startPoint && $endPoint && $startPoint->hasZ() && $endPoint->hasZ()) {
			0 ignored issues – show introduced 2022-08-18 15:20 UTC by Report Bug Copy Issue Report `$startPoint` is of type `null`, thus it always evaluated to `false`. Loading history...
201			return abs($startPoint->getZ() - $endPoint->getZ());
202			}
203
204			return null;
205			}
206
207			/**
208			*
209			* @param int\|float $verticalTolerance
210			* @return int\|float\|null
211			*/
212			public function elevationGain($verticalTolerance = 0)
213			{
214			$gain = null;
215			foreach ($this->components as $component) {
216			$gain += $component->elevationGain($verticalTolerance);
217			}
218			return $gain;
219			}
220
221			public function elevationLoss($verticalTolerance = 0)
222			{
223			$loss = null;
224			foreach ($this->components as $component) {
225			$loss += $component->elevationLoss($verticalTolerance);
226			}
227			return $loss;
228			}
229
230			public function minimumM()
231			{
232			$min = PHP_INT_MAX;
233			foreach ($this->components as $component) {
234			$componentMin = $component->minimumM();
235			if ($componentMin < $min) {
236			$min = $componentMin;
237			}
238			}
239			return $min !== PHP_INT_MAX ? $min : null;
240			}
241
242			public function maximumM()
243			{
244			$max = PHP_INT_MIN;
245			foreach ($this->components as $component) {
246			$componentMax = $component->maximumM();
247			if ($componentMax > $max) {
248			$max = $componentMax;
249			}
250			}
251			return $max !== PHP_INT_MIN ? $max : null;
252			}
253
254			public function isClosed(): bool
255			{
256			return true;
257			}
258			}
259

swen100 / geoPHP

MultiGeometry::elevationGain() A last analyzed 2022-08-18 15:20 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

MultiGeometry::elevationGain() A
last analyzed 2022-08-18 15:20 UTC