GlobeCoordinateValue::getSortKey() - Code Metrics - Inspection of "Remove bad array type hint from …::newFromArray co..." - DataValues/Geo - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 954049...2e99dd )

by Leszek

created 2017-06-26 07:23 UTC

GlobeCoordinateValue::getSortKey() A

↳ Parent: GlobeCoordinateValue

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace DataValues\Geo\Values;

use DataValues\DataValueObject;
use DataValues\IllegalValueException;

/**
 * Class representing a geographical coordinate value.
 *
 * @since 0.1
 *
 * @license GPL-2.0+
 * @author Jeroen De Dauw < [email protected] >
 * @author Thiemo Mättig
 */
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.
	 */
	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, $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->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() {
		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();
	}

	/**
	 * @return float
	 */
	public function getLatitude() {
		return $this->latLong->getLatitude();
	}

	/**
	 * @return float
	 */
	public function getLongitude() {
		return $this->latLong->getLongitude();
	}

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

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

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

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

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

	/**
	 * @see DataValue::getArrayValue
	 *
	 * @return array
	 */
	public function getArrayValue() {
		return array(
			'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::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		* @license GPL-2.0+
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 $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		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	77	public function __construct( LatLongValue $latLong, $precision = null, $globe = null ) {
51	77	$this->assertIsPrecision( $precision );
52
53	71	if ( $globe === null ) {
54	12	$globe = self::GLOBE_EARTH;
55	59	} elseif ( !is_string( $globe ) \|\| $globe === '' ) {
56	4	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	77	private function assertIsPrecision( $precision ) {
73	77	if ( $precision !== null ) {
74	73	if ( !is_float( $precision ) && !is_int( $precision ) ) {
75	4	throw new IllegalValueException( '$precision must be a number or null' );
76	69	} elseif ( $precision < -360 \|\| $precision > 360 ) {
77	2	throw new IllegalValueException( '$precision needs to be between -360 and 360' );
78		}
79		}
80	71	}
81
82		/**
83		* @see Serializable::serialize
84		*
85		* @return string
86		*/
87	48	public function serialize() {
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() {
109	32	return 'globecoordinate';
110		}
111
112		/**
113		* @see DataValue::getSortKey
114		*
115		* @return float
116		*/
117		public function getSortKey() {
118		return $this->getLatitude();
119		}
120
121		/**
122		* @return float
123		*/
124	18	public function getLatitude() {
125	18	return $this->latLong->getLatitude();
126		}
127
128		/**
129		* @return float
130		*/
131	18	public function getLongitude() {
132	18	return $this->latLong->getLongitude();
133		}
134
135		/**
136		* @see DataValue::getValue
137		*
138		* @return self
139		*/
140	16	public function getValue() {
141	16	return $this;
142		}
143
144		/**
145		* @return LatLongValue
146		*/
147		public function getLatLong() {
148		return $this->latLong;
149		}
150
151		/**
152		* Returns the precision of the coordinate in degrees, e.g. 0.01.
153		*
154		* @return float\|int\|null
155		*/
156	18	public function getPrecision() {
157	18	return $this->precision;
158		}
159
160		/**
161		* Returns the IRI of the globe on which the location resides.
162		*
163		* @return string
164		*/
165	18	public function getGlobe() {
166	18	return $this->globe;
167		}
168
169		/**
170		* @see Hashable::getHash
171		*
172		* @since 2.0
173		*
174		* @return string
175		*/
176	17	public function getHash() {
177	17	return md5( $this->latLong->getLatitude() . '\|'
178	17	. $this->latLong->getLongitude() . '\|'
179	17	. $this->precision . '\|'
180	17	. $this->globe );
181		}
182
183		/**
184		* @see DataValue::getArrayValue
185		*
186		* @return array
187		*/
188	80	public function getArrayValue() {
189		return array(
190	80	'latitude' => $this->latLong->getLatitude(),
191	80	'longitude' => $this->latLong->getLongitude(),
192
193		// The altitude field is no longer used in this class.
194		// It is kept here for compatibility reasons.
195		'altitude' => null,
196
197	80	'precision' => $this->precision,
198	80	'globe' => $this->globe,
199		);
200		}
201
202		/**
203		* Constructs a new instance from the provided data. Required for @see DataValueDeserializer.
204		* This is expected to round-trip with @see getArrayValue.
205		*
206		* @deprecated since 2.0.1. Static DataValue::newFromArray constructors like this are
207		* underspecified (not in the DataValue interface), and misleadingly named (should be named
208		* newFromArrayValue). Instead, use DataValue builder callbacks in @see DataValueDeserializer.
209		*
210		* @param mixed $data Warning! Even if this is expected to be a value as returned by
211		* @see getArrayValue, callers of this specific newFromArray implementation can not guarantee
212		* this. This is not even guaranteed to be an array!
213		*
214		* @throws IllegalValueException if $data is not in the expected format. Subclasses of
215		* InvalidArgumentException are expected and properly handled by @see DataValueDeserializer.
216		* @return self
217		*/
218		public static function newFromArray( $data ) {
219		self::requireArrayFields( $data, array( 'latitude', 'longitude' ) );
220
221		return new static(
222		new LatLongValue(
223		$data['latitude'],
224		$data['longitude']
225		),
226		( isset( $data['precision'] ) ) ? $data['precision'] : null,
227		( isset( $data['globe'] ) ) ? $data['globe'] : null
228		);
229		}
230
231		}
232

DataValues / Geo

Push — master ( 954049...2e99dd )

GlobeCoordinateValue::getSortKey() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like