GlobeCoordinateValue::assertIsPrecision() - Code Metrics - Inspection of "Add ALL the type hints" - DataValues/Geo - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — php71 ( 95a24c...2c708a )

by Jeroen De

created 2018-03-20 11:16 UTC

GlobeCoordinateValue::assertIsPrecision() B

↳ Parent: GlobeCoordinateValue

Complexity

Conditions	6
Paths	4

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	6.105

Importance

Changes

Metric	Value
dl	0
loc	9
ccs	6
cts	7
cp	0.8571
rs	8.8571
c	0
b	0
f	0
cc	6
eloc	6
nc	4
nop	1
crap	6.105

<?php

namespace DataValues\Geo\Values;

use DataValues\DataValueObject;
use DataValues\IllegalValueException;

/**
 * Class representing a geographical coordinate value.
 *
 * @since 0.1
 *
 * @license GPL-2.0-or-later
 * @author Jeroen De Dauw < [email protected] >
 * @author Thiemo Kreuz
 */
class GlobeCoordinateValue extends DataValueObject {

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

	/**
	 * 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;

	/**
	 * Wikidata concept URI for the Earth. Used as default value when no other globe was specified.
	 */
	public const GLOBE_EARTH = 'http://www.wikidata.org/entity/Q2';

	/**
	 * @param LatLongValue $latLong
	 * @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 $latLong, float $precision = null, string $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->latLong = $latLong;
		$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 number 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(): string {
		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(): string {
		return 'globecoordinate';
	}

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

	public function getLatitude(): float {
		return $this->latLong->getLatitude();
	}

	public function getLongitude(): float {
		return $this->latLong->getLongitude();
	}

	/**
	 * @see DataValue::getValue
	 *
	 * @return self
	 */
	public function getValue(): self {
		return $this;
	}

	public function getLatLong(): LatLongValue {
		return $this->latLong;
	}

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

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

	/**
	 * @see Hashable::getHash
	 *
	 * @since 2.0
	 *
	 * @return string
	 */
	public function getHash(): string {
		return md5( $this->latLong->getLatitude() . '|'
			. $this->latLong->getLongitude() . '|'
			. $this->precision . '|'
			. $this->globe );
	}

	/**
	 * @see DataValue::getArrayValue
	 *
	 * @return array
	 */
	public function getArrayValue(): array {
		return [
			'latitude' => $this->latLong->getLatitude(),
			'longitude' => $this->latLong->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 from the provided data. Required for @see DataValueDeserializer.
	 * This is expected to round-trip with @see getArrayValue.
	 *
	 * @deprecated since 2.0.1. Static DataValue::newFromArray constructors like this are
	 *  underspecified (not in the DataValue interface), and misleadingly named (should be named
	 *  newFromArrayValue). Instead, use DataValue builder callbacks in @see DataValueDeserializer.
	 *
	 * @param mixed $data Warning! Even if this is expected to be a value as returned by
	 *  @see getArrayValue, callers of this specific newFromArray implementation can not guarantee
	 *  this. This is not even guaranteed to be an array!
	 *
	 * @throws IllegalValueException if $data is not in the expected format. Subclasses of
	 *  InvalidArgumentException are expected and properly handled by @see DataValueDeserializer.
	 * @return self
	 */
	public static function newFromArray( $data ): self {
		self::requireArrayFields( $data, [ '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		* @license GPL-2.0-or-later
14		* @author Jeroen De Dauw < [email protected] >
15		* @author Thiemo Kreuz
16		*/
17		class GlobeCoordinateValue extends DataValueObject {
18
19		/**
20		* @var LatLongValue
21		*/
22		private $latLong;
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		/**
39		* Wikidata concept URI for the Earth. Used as default value when no other globe was specified.
40		*/
41		public const GLOBE_EARTH = 'http://www.wikidata.org/entity/Q2';
42
43		/**
44		* @param LatLongValue $latLong
45		* @param float\|int\|null $precision in degrees, e.g. 0.01.
46		* @param string\|null $globe IRI, defaults to 'http://www.wikidata.org/entity/Q2'.
47		*
48		* @throws IllegalValueException
49		*/
50	70	public function __construct( LatLongValue $latLong, float $precision = null, string $globe = null ) {
51	70	$this->assertIsPrecision( $precision );
52
53	68	if ( $globe === null ) {
54	12	$globe = self::GLOBE_EARTH;
55	56	} elseif ( !is_string( $globe ) \|\| $globe === '' ) {
56	1	throw new IllegalValueException( '$globe must be a non-empty string or null' );
57		}
58
59	67	$this->latLong = $latLong;
60	67	$this->precision = $precision;
61	67	$this->globe = $globe;
62	67	}
63
64		/**
65		* @see LatLongValue::assertIsLatitude
66		* @see LatLongValue::assertIsLongitude
67		*
68		* @param float\|int\|null $precision
69		*
70		* @throws IllegalValueException
71		*/
72	70	private function assertIsPrecision( $precision ) {
73	70	if ( $precision !== null ) {
74	66	if ( !is_float( $precision ) && !is_int( $precision ) ) {
75		throw new IllegalValueException( '$precision must be a number or null' );
76	66	} elseif ( $precision < -360 \|\| $precision > 360 ) {
77	2	throw new IllegalValueException( '$precision needs to be between -360 and 360' );
78		}
79		}
80	68	}
81
82		/**
83		* @see Serializable::serialize
84		*
85		* @return string
86		*/
87	48	public function serialize(): string {
88	48	return json_encode( array_values( $this->getArrayValue() ) );
89		}
90
91		/**
92		* @see Serializable::unserialize
93		*
94		* @param string $value
95		*
96		* @throws IllegalValueException
97		*/
98	49	public function unserialize( $value ) {
99	49	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...
100	49	$this->__construct( new LatLongValue( $latitude, $longitude ), $precision, $globe );
101	49	}
102
103		/**
104		* @see DataValue::getType
105		*
106		* @return string
107		*/
108	32	public static function getType(): string {
109	32	return 'globecoordinate';
110		}
111
112		/**
113		* @see DataValue::getSortKey
114		*
115		* @return float
116		*/
117		public function getSortKey(): float {
118		return $this->getLatitude();
119		}
120
121	18	public function getLatitude(): float {
122	18	return $this->latLong->getLatitude();
123		}
124
125	18	public function getLongitude(): float {
126	18	return $this->latLong->getLongitude();
127		}
128
129		/**
130		* @see DataValue::getValue
131		*
132		* @return self
133		*/
134	16	public function getValue(): self {
135	16	return $this;
136		}
137
138		public function getLatLong(): LatLongValue {
139		return $this->latLong;
140		}
141
142		/**
143		* Returns the precision of the coordinate in degrees, e.g. 0.01.
144		*
145		* @return float\|int\|null
146		*/
147	18	public function getPrecision(): ?float {
148	18	return $this->precision;
149		}
150
151		/**
152		* Returns the IRI of the globe on which the location resides.
153		*
154		* @return string
155		*/
156	18	public function getGlobe(): string {
157	18	return $this->globe;
158		}
159
160		/**
161		* @see Hashable::getHash
162		*
163		* @since 2.0
164		*
165		* @return string
166		*/
167	17	public function getHash(): string {
168	17	return md5( $this->latLong->getLatitude() . '\|'
169	17	. $this->latLong->getLongitude() . '\|'
170	17	. $this->precision . '\|'
171	17	. $this->globe );
172		}
173
174		/**
175		* @see DataValue::getArrayValue
176		*
177		* @return array
178		*/
179	80	public function getArrayValue(): array {
180		return [
181	80	'latitude' => $this->latLong->getLatitude(),
182	80	'longitude' => $this->latLong->getLongitude(),
183
184		// The altitude field is no longer used in this class.
185		// It is kept here for compatibility reasons.
186		'altitude' => null,
187
188	80	'precision' => $this->precision,
189	80	'globe' => $this->globe,
190		];
191		}
192
193		/**
194		* Constructs a new instance from the provided data. Required for @see DataValueDeserializer.
195		* This is expected to round-trip with @see getArrayValue.
196		*
197		* @deprecated since 2.0.1. Static DataValue::newFromArray constructors like this are
198		* underspecified (not in the DataValue interface), and misleadingly named (should be named
199		* newFromArrayValue). Instead, use DataValue builder callbacks in @see DataValueDeserializer.
200		*
201		* @param mixed $data Warning! Even if this is expected to be a value as returned by
202		* @see getArrayValue, callers of this specific newFromArray implementation can not guarantee
203		* this. This is not even guaranteed to be an array!
204		*
205		* @throws IllegalValueException if $data is not in the expected format. Subclasses of
206		* InvalidArgumentException are expected and properly handled by @see DataValueDeserializer.
207		* @return self
208		*/
209	6	public static function newFromArray( $data ): self {
210	6	self::requireArrayFields( $data, [ 'latitude', 'longitude' ] );
211
212	1	return new static(
213	1	new LatLongValue(
214	1	$data['latitude'],
215	1	$data['longitude']
216		),
217	1	( isset( $data['precision'] ) ) ? $data['precision'] : null,
218	1	( isset( $data['globe'] ) ) ? $data['globe'] : null
219		);
220		}
221
222		}
223

DataValues / Geo

Push — php71 ( 95a24c...2c708a )

GlobeCoordinateValue::assertIsPrecision() B

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like