|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
/** |
|
4
|
|
|
* GpsLab component. |
|
5
|
|
|
* |
|
6
|
|
|
* @author Peter Gribanov <[email protected]> |
|
7
|
|
|
* @copyright Copyright (c) 2011, Peter Gribanov |
|
8
|
|
|
* @license http://opensource.org/licenses/MIT |
|
9
|
|
|
*/ |
|
10
|
|
|
|
|
11
|
|
|
namespace GpsLab\Component\Enum; |
|
12
|
|
|
|
|
13
|
|
|
use GpsLab\Component\Enum\Exception\OutOfEnumException; |
|
14
|
|
|
|
|
15
|
|
|
abstract class ExplicitEnum implements Enum, \Serializable |
|
16
|
|
|
{ |
|
17
|
|
|
/** |
|
18
|
|
|
* @var mixed |
|
19
|
|
|
*/ |
|
20
|
|
|
private $value = ''; |
|
21
|
|
|
|
|
22
|
|
|
/** |
|
23
|
|
|
* @var Enum[] |
|
24
|
|
|
*/ |
|
25
|
|
|
private static $instances = []; |
|
26
|
|
|
|
|
27
|
|
|
/** |
|
28
|
|
|
* @param mixed $value |
|
29
|
|
|
*/ |
|
30
|
|
|
final private function __construct($value) |
|
31
|
|
|
{ |
|
32
|
|
|
$this->value = $value; |
|
33
|
|
|
} |
|
34
|
|
|
|
|
35
|
|
|
/** |
|
36
|
|
|
* @param mixed $value |
|
37
|
|
|
* |
|
38
|
|
|
* @return Enum |
|
39
|
|
|
*/ |
|
40
|
|
|
final public static function byValue($value) |
|
41
|
|
|
{ |
|
42
|
|
|
$key = get_called_class().'|'.$value; |
|
43
|
|
|
|
|
44
|
|
|
// limitation of count object instances |
|
45
|
|
|
if (!isset(self::$instances[$key])) { |
|
46
|
|
|
if (!static::isValid($value)) { |
|
47
|
|
|
throw OutOfEnumException::create($value, get_called_class()); |
|
48
|
|
|
} |
|
49
|
|
|
|
|
50
|
|
|
self::$instances[$key] = new static($value); |
|
51
|
|
|
} |
|
52
|
|
|
|
|
53
|
|
|
return self::$instances[$key]; |
|
54
|
|
|
} |
|
55
|
|
|
|
|
56
|
|
|
/** |
|
57
|
|
|
* @return mixed |
|
58
|
|
|
*/ |
|
59
|
|
|
final public function value() |
|
60
|
|
|
{ |
|
61
|
|
|
return $this->value; |
|
62
|
|
|
} |
|
63
|
|
|
|
|
64
|
|
|
/** |
|
65
|
|
|
* Available values. |
|
66
|
|
|
* |
|
67
|
|
|
* @return Enum[] |
|
68
|
|
|
*/ |
|
69
|
|
|
final public static function values() |
|
70
|
|
|
{ |
|
71
|
|
|
$values = []; |
|
72
|
|
|
foreach (static::choices() as $value => $label) { |
|
73
|
|
|
$values[$label] = self::byValue($value); |
|
74
|
|
|
} |
|
75
|
|
|
|
|
76
|
|
|
return $values; |
|
77
|
|
|
} |
|
78
|
|
|
|
|
79
|
|
|
/** |
|
80
|
|
|
* @param Enum $enum |
|
81
|
|
|
* |
|
82
|
|
|
* @return bool |
|
83
|
|
|
*/ |
|
84
|
|
|
final public function equals(Enum $enum) |
|
85
|
|
|
{ |
|
86
|
|
|
return $this === $enum || ($this->value() === $enum->value() && get_called_class() == get_class($enum)); |
|
87
|
|
|
} |
|
88
|
|
|
|
|
89
|
|
|
/** |
|
90
|
|
|
* Is value supported. |
|
91
|
|
|
* |
|
92
|
|
|
* @param mixed $value |
|
93
|
|
|
* |
|
94
|
|
|
* @return bool |
|
95
|
|
|
*/ |
|
96
|
|
|
final public static function isValid($value) |
|
97
|
|
|
{ |
|
98
|
|
|
return array_key_exists($value, static::choices()); |
|
99
|
|
|
} |
|
100
|
|
|
|
|
101
|
|
|
/** |
|
102
|
|
|
* Return readable value. |
|
103
|
|
|
* |
|
104
|
|
|
* @return string |
|
105
|
|
|
*/ |
|
106
|
|
|
public function __toString() |
|
107
|
|
|
{ |
|
108
|
|
|
return static::choices()[$this->value()]; |
|
109
|
|
|
} |
|
110
|
|
|
|
|
111
|
|
|
final public function __clone() |
|
112
|
|
|
{ |
|
113
|
|
|
throw new \LogicException('Enumerations are not cloneable'); |
|
114
|
|
|
} |
|
115
|
|
|
|
|
116
|
|
|
/** |
|
117
|
|
|
* @return mixed |
|
118
|
|
|
*/ |
|
119
|
|
|
public function serialize() |
|
120
|
|
|
{ |
|
121
|
|
|
return serialize($this->value); |
|
122
|
|
|
} |
|
123
|
|
|
|
|
124
|
|
|
/** |
|
125
|
|
|
* @param mixed $data |
|
126
|
|
|
*/ |
|
127
|
|
|
public function unserialize($data) |
|
128
|
|
|
{ |
|
129
|
|
|
static::byValue($this->value = unserialize($data)); |
|
130
|
|
|
} |
|
131
|
|
|
} |
|
132
|
|
|
|
gpslab /
enum
