1	<?php
2	namespace Fdsn\Webservices\Event\Structs;
3
4	/**
5	* Data structure to handle magnitude type and value
6	*
7	* @param string $magnitudeType     Magnitude type
8	* @param float $magnitudeValue        Magniude value
9	*/
10	class Magnitude {
11	private string $type;
12	private float $value;
13
14	private $validTypes = array('ml', 'md', 'mb', 'ms', 'mw', 'mwp', 'mwpd');
15	private $validValues = array('min' => -12, 'max' => 12);
16
17	function __construct( string $type, float $value) {
18
19	if( empty($type) )
20	throw new \InvalidArgumentException("Magnitude type unset or empty string");
21
22	if( ! $this->isValidType($type) )
23	throw new \InvalidArgumentException( sprintf("Magnitude '%s' type invalid", $type) );
24
25	if( ! $this->isValidValue($value) )
26	throw new \InvalidArgumentException("Magnitude value invalid");
27
28	$this->type = $type;
29	$this->value = $value;
30	}
31
32	function __destruct(){ }
33
34	/**
35	* Returns magnitude
36	*
37	* @return string Magnitude type and value in "%s %.1f" format
38	*/
39	function __toString(){ return sprintf("%s %.1f", $this->type, $this->value); }
40
41	/**
42	* Get magnitude value
43	*
44	* @param int $roundTo (nullable) if set, return value rounded to `roundTo` decimals
45	* @return float Magnitude value
46	*/
47	public function value(?int $roundTo = null):float{ return is_null($roundTo) ? $this->value : round($this->value, $roundTo); }
48
49	/**
50	* Get magnitude type
51	*
52	* @return string     Magnitude type
53	*/
54	public function type():string{ return $this->type; }
55
56	/**
57	* Get magnitude type in lower case
58	*
59	* @return string     Magnitude type in lowercase
60	*/
61	public function typeLowerCase():string{ return strtolower($this->type() ); }
62
63	/**
64	* Get magnitude type in upper case first letter
65	*
66	* @return string     Magnitude type upper case first letter
67	*/
68	public function typeUppercaseFirst():string{ return ucfirst( $this->typeLowerCase() ) ; }
69
70	/**
71	* Check is type is supported
72	*
73	* @return bool  True is supported, false otherwise
74	*/
75	private function isValidType(string $type){ return in_array(strtolower($type), $this->validTypes); }
76
77	/**
78	* Check is value is valid
79	*
80	* @return bool  True is valid, false otherwise
81	*/
82	private function isValidValue(float $value){ return ($this->validValues['min'] <= $value && $value <= $this->validValues['max']); }
83
84	/**
85	* Compare two objects
86	* @return bool        true are equals, false otherwise
87	*/
88	public function equals(self $other):bool{ return $this->value == $other->value && $this->type == $other->type; }
89	}

---

Branches

Below are the source code lines that represent each code branch as identified by Xdebug. Please note a branch is not necessarily coterminous with a line, a line may contain multiple branches and therefore show up more than once. Please also be aware that some branches may be implicit rather than explicit, e.g. an if statement always has an else as part of its logical flow even if you didn't write one.

Magnitude->__construct

17	function __construct( string $type, float $value) {
18
19	if( empty($type) )

20	throw new \InvalidArgumentException("Magnitude type unset or empty string");

22	if( ! $this->isValidType($type) )

23	throw new \InvalidArgumentException( sprintf("Magnitude '%s' type invalid", $type) );

25	if( ! $this->isValidValue($value) )

26	throw new \InvalidArgumentException("Magnitude value invalid");

28	$this->type = $type;
29	$this->value = $value;
30	}

Magnitude->__destruct

32	function __destruct(){ }

Magnitude->__toString

39	function __toString(){ return sprintf("%s %.1f", $this->type, $this->value); }

Magnitude->equals

88	public function equals(self $other):bool{ return $this->value == $other->value && $this->type == $other->type; }

88	public function equals(self $other):bool{ return $this->value == $other->value && $this->type == $other->type; }

88	public function equals(self $other):bool{ return $this->value == $other->value && $this->type == $other->type; }

Magnitude->isValidType

75	private function isValidType(string $type){ return in_array(strtolower($type), $this->validTypes); }

Magnitude->isValidValue

82	private function isValidValue(float $value){ return ($this->validValues['min'] <= $value && $value <= $this->validValues['max']); }

82	private function isValidValue(float $value){ return ($this->validValues['min'] <= $value && $value <= $this->validValues['max']); }

82	private function isValidValue(float $value){ return ($this->validValues['min'] <= $value && $value <= $this->validValues['max']); }

Magnitude->type

54	public function type():string{ return $this->type; }

Magnitude->typeLowerCase

61	public function typeLowerCase():string{ return strtolower($this->type() ); }

Magnitude->typeUppercaseFirst

68	public function typeUppercaseFirst():string{ return ucfirst( $this->typeLowerCase() ) ; }

Magnitude->value

47	public function value(?int $roundTo = null):float{ return is_null($roundTo) ? $this->value : round($this->value, $roundTo); }

47	public function value(?int $roundTo = null):float{ return is_null($roundTo) ? $this->value : round($this->value, $roundTo); }

47	public function value(?int $roundTo = null):float{ return is_null($roundTo) ? $this->value : round($this->value, $roundTo); }

47	public function value(?int $roundTo = null):float{ return is_null($roundTo) ? $this->value : round($this->value, $roundTo); }