Code Coverage for /builds/fdsn/webservices-library/src/Event/Structs/Depth.php

1	<?php
2	namespace Fdsn\Webservices\Event\Structs;
3
4	/**
5	* Data structure to handle Depth value
6	*
7	* @param float $value depth
8	*/
9	class Depth {
10	private float $value;
11
12	private $validValues = array('min' => -100, 'max' => 10000);
13
14	function __construct( float $value) {
15
16	if( ! $this->isValid($value) )
17	throw new \InvalidArgumentException("Depth value invalid");
18
19	$this->value = $value;
20	}
21
22	function __destruct(){ }
23
24	/**
25	* Get depth value
26	*
27	* @return string Depth value in "%.2f km" format
28	*/
29	function __toString(){ return sprintf("%d km", round($this->value)); }
30
31	/**
32	* Get depth value
33	*
34	* @param int $roundTo (nullable) if set, return value rounded to `roundTo` decimals
35	* @return float Depth value
36	*/
37	public function value(?int $roundTo = null):float { return is_null($roundTo) ? $this->value : round($this->value, $roundTo) ; }
38
39	/**
40	* Check if depth value is valid
41	*
42	* @return bool True if is valid, false otherwise
43	*/
44	private function isValid(float $value):bool { return ($this->validValues['min'] <= $value && $value <= $this->validValues['max']); }
45
46	/**
47	* Compare two objects
48	*
49	* @return bool true are equals, false otherwise
50	*/
51	public function equals(self $other):bool{ return $this->value == $other->value; }
52	}