GlobeCoordinateValue::serialize() - 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 2016-10-28 07:53 UTC

GlobeCoordinateValue::serialize() A

↳ Parent: GlobeCoordinateValue

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?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();
	}

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

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

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

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

	/**
	 * 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->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 of the DataValue from the provided data.
	 * This can round-trip with @see getArrayValue
	 *
	 * @since 0.1
	 *
	 * @param array $data
	 *
	 * @return self
	 * @throws IllegalValueException
	 */
	public static function newFromArray( array $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			public function __construct( LatLongValue $latLong, $precision = null, $globe = null ) {
51			$this->assertIsPrecision( $precision );
52
53			if ( $globe === null ) {
54			$globe = self::GLOBE_EARTH;
55			} elseif ( !is_string( $globe ) \|\| $globe === '' ) {
56			throw new IllegalValueException( '$globe must be a non-empty string or null' );
57			}
58
59			$this->latLong = $latLong;
60			$this->precision = $precision;
61			$this->globe = $globe;
62			}
63
64			/**
65			* @see LatLongValue::assertIsLatitude
66			* @see LatLongValue::assertIsLongitude
67			*
68			* @param float\|int\|null $precision
69			*
70			* @throws IllegalValueException
71			*/
72			private function assertIsPrecision( $precision ) {
73			if ( $precision !== null ) {
74			if ( !is_float( $precision ) && !is_int( $precision ) ) {
75			throw new IllegalValueException( '$precision must be a number or null' );
76			} elseif ( $precision < -360 \|\| $precision > 360 ) {
77			throw new IllegalValueException( '$precision needs to be between -360 and 360' );
78			}
79			}
80			}
81
82			/**
83			* @see Serializable::serialize
84			*
85			* @return string
86			*/
87			public function serialize() {
88			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			public function unserialize( $value ) {
99			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			$this->__construct( new LatLongValue( $latitude, $longitude ), $precision, $globe );
101			}
102
103			/**
104			* @see DataValue::getType
105			*
106			* @return string
107			*/
108			public static function getType() {
109			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			* Returns the latitude.
123			*
124			* @since 0.1
125			*
126			* @return float
127			*/
128			public function getLatitude() {
129			return $this->latLong->getLatitude();
130			}
131
132			/**
133			* Returns the longitude.
134			*
135			* @since 0.1
136			*
137			* @return float
138			*/
139			public function getLongitude() {
140			return $this->latLong->getLongitude();
141			}
142
143			/**
144			* Returns the text.
145			* @see DataValue::getValue
146			*
147			* @return self
148			*/
149			public function getValue() {
150			return $this;
151			}
152
153			/**
154			* @since 0.1
155			*
156			* @return LatLongValue
157			*/
158			public function getLatLong() {
159			return $this->latLong;
160			}
161
162			/**
163			* Returns the precision of the coordinate in degrees, e.g. 0.01.
164			*
165			* @since 0.1
166			*
167			* @return float\|int\|null
168			*/
169			public function getPrecision() {
170			return $this->precision;
171			}
172
173			/**
174			* Returns the IRI of the globe on which the location resides.
175			*
176			* @since 0.1
177			*
178			* @return string
179			*/
180			public function getGlobe() {
181			return $this->globe;
182			}
183
184			/**
185			* @see DataValue::getArrayValue
186			*
187			* @return array
188			*/
189			public function getArrayValue() {
190			return array(
191			'latitude' => $this->latLong->getLatitude(),
192			'longitude' => $this->latLong->getLongitude(),
193
194			// The altitude field is no longer used in this class.
195			// It is kept here for compatibility reasons.
196			'altitude' => null,
197
198			'precision' => $this->precision,
199			'globe' => $this->globe,
200			);
201			}
202
203			/**
204			* Constructs a new instance of the DataValue from the provided data.
205			* This can round-trip with @see getArrayValue
206			*
207			* @since 0.1
208			*
209			* @param array $data
210			*
211			* @return self
212			* @throws IllegalValueException
213			*/
214			public static function newFromArray( array $data ) {
215			self::requireArrayFields( $data, array( 'latitude', 'longitude' ) );
216
217			return new static(
218			new LatLongValue(
219			$data['latitude'],
220			$data['longitude']
221			),
222			( isset( $data['precision'] ) ) ? $data['precision'] : null,
223			( isset( $data['globe'] ) ) ? $data['globe'] : null
224			);
225			}
226
227			}
228

DataValues / Geo

Pull Request — master (#53)

GlobeCoordinateValue::serialize() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like