GlobeCoordinateValue::assertIsPrecision() - Code Metrics - Inspection of "Add missing type and range checks to GlobeCoordina..." - DataValues/Geo - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#53)

by no

created 2015-12-29 07:45 UTC

GlobeCoordinateValue::assertIsPrecision() B

↳ Parent: GlobeCoordinateValue

Complexity

Conditions	6
Paths	4

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

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

<?php

namespace DataValues\Geo\Values;

use DataValues\DataValueObject;
use DataValues\IllegalValueException;

/**
 * Class representing a geographical coordinate value.
 *
 * @since 0.1
 *
 * @licence GNU GPL v2+
 * @author Jeroen De Dauw < [email protected] >
 * @author Thiemo Mättig
 */
class GlobeCoordinateValue extends DataValueObject {

	/**
	 * @var LatLongValue
	 */
	private $latLang;

	/**
	 * The precision of the coordinate in degrees, e.g. 0.01.
	 *
	 * @var float|int|null
	 */
	private $precision;

	/**
	 * IRI of the globe on which the location resides.
	 *
	 * @var string
	 */
	private $globe;

	const GLOBE_EARTH = 'http://www.wikidata.org/entity/Q2';

	/**
	 * @param LatLongValue $latLang
	 * @param float|int|null $precision in degrees, e.g. 0.01.
	 * @param string|null $globe IRI, defaults to 'http://www.wikidata.org/entity/Q2'.
	 *
	 * @throws IllegalValueException
	 */
	public function __construct( LatLongValue $latLang, $precision = null, $globe = null ) {
		$this->assertIsPrecision( $precision );

		if ( $globe === null ) {
			$globe = self::GLOBE_EARTH;
		} elseif ( !is_string( $globe ) || $globe === '' ) {
			throw new IllegalValueException( '$globe must be a non-empty string or null' );
		}

		$this->latLang = $latLang;
		$this->precision = $precision;
		$this->globe = $globe;
	}

	/**
	 * @see LatLongValue::assertIsLatitude
	 * @see LatLongValue::assertIsLongitude
	 *
	 * @param float|int|null $precision
	 *
	 * @throws IllegalValueException
	 */
	private function assertIsPrecision( $precision ) {
		if ( $precision !== null ) {
			if ( !is_float( $precision ) && !is_int( $precision ) ) {
				throw new IllegalValueException( '$precision must be a float, integer or null' );
			} elseif ( $precision < -360 || $precision > 360 ) {
				throw new IllegalValueException( '$precision needs to be between -360 and 360' );
			}
		}
	}

	/**
	 * @see Serializable::serialize
	 *
	 * @return string
	 */
	public function serialize() {
		return json_encode( array_values( $this->getArrayValue() ) );
	}

	/**
	 * @see Serializable::unserialize
	 *
	 * @param string $value
	 *
	 * @throws IllegalValueException
	 */
	public function unserialize( $value ) {
		list( $latitude, $longitude, $altitude, $precision, $globe ) = json_decode( $value );
<?php

function returnThreeValues() {
    return array('a', 'b', 'c');
}

list($a, $b, $c) = returnThreeValues();

print $a . " - " . $c;
		$this->__construct( new LatLongValue( $latitude, $longitude ), $precision, $globe );
	}

	/**
	 * @see DataValue::getType
	 *
	 * @return string
	 */
	public static function getType() {
		return 'globecoordinate';
	}

	/**
	 * @see DataValue::getSortKey
	 *
	 * @return float
	 */
	public function getSortKey() {
		return $this->getLatitude();
	}

	/**
	 * Returns the latitude.
	 *
	 * @since 0.1
	 *
	 * @return float
	 */
	public function getLatitude() {
		return $this->latLang->getLatitude();
	}

	/**
	 * Returns the longitude.
	 *
	 * @since 0.1
	 *
	 * @return float
	 */
	public function getLongitude() {
		return $this->latLang->getLongitude();
	}

	/**
	 * Returns the text.
	 * @see DataValue::getValue
	 *
	 * @return GlobeCoordinateValue
	 */
	public function getValue() {
		return $this;
	}

	/**
	 * @since 0.1
	 *
	 * @return LatLongValue
	 */
	public function getLatLong() {
		return $this->latLang;
	}

	/**
	 * Returns the precision of the coordinate in degrees, e.g. 0.01.
	 *
	 * @since 0.1
	 *
	 * @return float|int|null
	 */
	public function getPrecision() {
		return $this->precision;
	}

	/**
	 * Returns the IRI of the globe on which the location resides.
	 *
	 * @since 0.1
	 *
	 * @return string
	 */
	public function getGlobe() {
		return $this->globe;
	}

	/**
	 * @see DataValue::getArrayValue
	 *
	 * @return array
	 */
	public function getArrayValue() {
		return array(
			'latitude' => $this->latLang->getLatitude(),
			'longitude' => $this->latLang->getLongitude(),

			// The altitude field is no longer used in this class.
			// It is kept here for compatibility reasons.
			'altitude' => null,

			'precision' => $this->precision,
			'globe' => $this->globe,
		);
	}

	/**
	 * Constructs a new instance of the DataValue from the provided data.
	 * This can round-trip with @see getArrayValue
	 *
	 * @since 0.1
	 *
	 * @param array $data
	 *
	 * @return GlobeCoordinateValue
	 * @throws IllegalValueException
	 */
	public static function newFromArray( $data ) {
		self::requireArrayFields( $data, array( 'latitude', 'longitude' ) );

		return new static(
			new LatLongValue(
				$data['latitude'],
				$data['longitude']
			),
			( isset( $data['precision'] ) ) ? $data['precision'] : null,
			( isset( $data['globe'] ) ) ? $data['globe'] : null
		);
	}

}


1			<?php
2
3			namespace DataValues\Geo\Values;
4
5			use DataValues\DataValueObject;
6			use DataValues\IllegalValueException;
7
8			/**
9			* Class representing a geographical coordinate value.
10			*
11			* @since 0.1
12			*
13			* @licence GNU GPL v2+
14			* @author Jeroen De Dauw < [email protected] >
15			* @author Thiemo Mättig
16			*/
17			class GlobeCoordinateValue extends DataValueObject {
18
19			/**
20			* @var LatLongValue
21			*/
22			private $latLang;
23
24			/**
25			* The precision of the coordinate in degrees, e.g. 0.01.
26			*
27			* @var float\|int\|null
28			*/
29			private $precision;
30
31			/**
32			* IRI of the globe on which the location resides.
33			*
34			* @var string
35			*/
36			private $globe;
37
38			const GLOBE_EARTH = 'http://www.wikidata.org/entity/Q2';
39
40			/**
41			* @param LatLongValue $latLang
42			* @param float\|int\|null $precision in degrees, e.g. 0.01.
43			* @param string\|null $globe IRI, defaults to 'http://www.wikidata.org/entity/Q2'.
44			*
45			* @throws IllegalValueException
46			*/
47			public function __construct( LatLongValue $latLang, $precision = null, $globe = null ) {
48			$this->assertIsPrecision( $precision );
49
50			if ( $globe === null ) {
51			$globe = self::GLOBE_EARTH;
52			} elseif ( !is_string( $globe ) \|\| $globe === '' ) {
53			throw new IllegalValueException( '$globe must be a non-empty string or null' );
54			}
55
56			$this->latLang = $latLang;
57			$this->precision = $precision;
58			$this->globe = $globe;
59			}
60
61			/**
62			* @see LatLongValue::assertIsLatitude
63			* @see LatLongValue::assertIsLongitude
64			*
65			* @param float\|int\|null $precision
66			*
67			* @throws IllegalValueException
68			*/
69			private function assertIsPrecision( $precision ) {
70			if ( $precision !== null ) {
71			if ( !is_float( $precision ) && !is_int( $precision ) ) {
72			throw new IllegalValueException( '$precision must be a float, integer or null' );
73			} elseif ( $precision < -360 \|\| $precision > 360 ) {
74			throw new IllegalValueException( '$precision needs to be between -360 and 360' );
75			}
76			}
77			}
78
79			/**
80			* @see Serializable::serialize
81			*
82			* @return string
83			*/
84			public function serialize() {
85			return json_encode( array_values( $this->getArrayValue() ) );
86			}
87
88			/**
89			* @see Serializable::unserialize
90			*
91			* @param string $value
92			*
93			* @throws IllegalValueException
94			*/
95			public function unserialize( $value ) {
96			list( $latitude, $longitude, $altitude, $precision, $globe ) = json_decode( $value );
			0 ignored issues – show Unused Code introduced 2015-12-14 19:58 UTC by Report Bug Copy Issue Report The assignment to `$altitude` is unused. Consider omitting it like so `list($first,,$third)`. This checks looks for assignemnts to variables using the `list(...)` function, where not all assigned variables are subsequently used. Consider the following code example. <?php function returnThreeValues() { return array('a', 'b', 'c'); } list($a, $b, $c) = returnThreeValues(); print $a . " - " . $c; Only the variables `$a` and `$c` are used. There was no need to assign `$b`. Instead, the list call could have been. list($a,, $c) = returnThreeValues(); Loading history...
97			$this->__construct( new LatLongValue( $latitude, $longitude ), $precision, $globe );
98			}
99
100			/**
101			* @see DataValue::getType
102			*
103			* @return string
104			*/
105			public static function getType() {
106			return 'globecoordinate';
107			}
108
109			/**
110			* @see DataValue::getSortKey
111			*
112			* @return float
113			*/
114			public function getSortKey() {
115			return $this->getLatitude();
116			}
117
118			/**
119			* Returns the latitude.
120			*
121			* @since 0.1
122			*
123			* @return float
124			*/
125			public function getLatitude() {
126			return $this->latLang->getLatitude();
127			}
128
129			/**
130			* Returns the longitude.
131			*
132			* @since 0.1
133			*
134			* @return float
135			*/
136			public function getLongitude() {
137			return $this->latLang->getLongitude();
138			}
139
140			/**
141			* Returns the text.
142			* @see DataValue::getValue
143			*
144			* @return GlobeCoordinateValue
145			*/
146			public function getValue() {
147			return $this;
148			}
149
150			/**
151			* @since 0.1
152			*
153			* @return LatLongValue
154			*/
155			public function getLatLong() {
156			return $this->latLang;
157			}
158
159			/**
160			* Returns the precision of the coordinate in degrees, e.g. 0.01.
161			*
162			* @since 0.1
163			*
164			* @return float\|int\|null
165			*/
166			public function getPrecision() {
167			return $this->precision;
168			}
169
170			/**
171			* Returns the IRI of the globe on which the location resides.
172			*
173			* @since 0.1
174			*
175			* @return string
176			*/
177			public function getGlobe() {
178			return $this->globe;
179			}
180
181			/**
182			* @see DataValue::getArrayValue
183			*
184			* @return array
185			*/
186			public function getArrayValue() {
187			return array(
188			'latitude' => $this->latLang->getLatitude(),
189			'longitude' => $this->latLang->getLongitude(),
190
191			// The altitude field is no longer used in this class.
192			// It is kept here for compatibility reasons.
193			'altitude' => null,
194
195			'precision' => $this->precision,
196			'globe' => $this->globe,
197			);
198			}
199
200			/**
201			* Constructs a new instance of the DataValue from the provided data.
202			* This can round-trip with @see getArrayValue
203			*
204			* @since 0.1
205			*
206			* @param array $data
207			*
208			* @return GlobeCoordinateValue
209			* @throws IllegalValueException
210			*/
211			public static function newFromArray( $data ) {
212			self::requireArrayFields( $data, array( 'latitude', 'longitude' ) );
213
214			return new static(
215			new LatLongValue(
216			$data['latitude'],
217			$data['longitude']
218			),
219			( isset( $data['precision'] ) ) ? $data['precision'] : null,
220			( isset( $data['globe'] ) ) ? $data['globe'] : null
221			);
222			}
223
224			}
225

DataValues / Geo

Pull Request — master (#53)

GlobeCoordinateValue::assertIsPrecision() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like