1
|
|
|
<?php |
2
|
|
|
/* |
3
|
|
|
* This file is part of the FreshDoctrineEnumBundle |
4
|
|
|
* |
5
|
|
|
* (c) Artem Genvald <[email protected]> |
6
|
|
|
* |
7
|
|
|
* For the full copyright and license information, please view the LICENSE |
8
|
|
|
* file that was distributed with this source code. |
9
|
|
|
*/ |
10
|
|
|
|
11
|
|
|
namespace Fresh\DoctrineEnumBundle\DBAL\Types; |
12
|
|
|
|
13
|
|
|
use Doctrine\DBAL\Platforms\AbstractPlatform; |
14
|
|
|
use Doctrine\DBAL\Platforms\MySqlPlatform; |
15
|
|
|
use Doctrine\DBAL\Platforms\PostgreSqlPlatform; |
16
|
|
|
use Doctrine\DBAL\Platforms\SqlitePlatform; |
17
|
|
|
use Doctrine\DBAL\Platforms\SQLServerPlatform; |
18
|
|
|
use Doctrine\DBAL\Types\Type; |
19
|
|
|
|
20
|
|
|
/** |
21
|
|
|
* AbstractEnumType. |
22
|
|
|
* |
23
|
|
|
* Provides support of ENUM type for Doctrine in Symfony applications. |
24
|
|
|
* |
25
|
|
|
* @author Artem Genvald <[email protected]> |
26
|
|
|
* @author Ben Davies <[email protected]> |
27
|
|
|
* @author Jaik Dean <[email protected]> |
28
|
|
|
*/ |
29
|
|
|
abstract class AbstractEnumType extends Type |
30
|
|
|
{ |
31
|
|
|
/** |
32
|
|
|
* @var string |
33
|
|
|
*/ |
34
|
|
|
protected $name = ''; |
35
|
|
|
|
36
|
|
|
/** |
37
|
|
|
* @var array Array of ENUM Values, where ENUM values are keys and their readable versions are values |
38
|
|
|
* @static |
39
|
|
|
*/ |
40
|
|
|
protected static $choices = []; |
41
|
|
|
|
42
|
|
|
/** |
43
|
|
|
* {@inheritdoc} |
44
|
|
|
*/ |
45
|
|
|
public function convertToDatabaseValue($value, AbstractPlatform $platform) |
46
|
|
|
{ |
47
|
|
|
if (null === $value) { |
48
|
|
|
return; |
49
|
|
|
} |
50
|
|
|
|
51
|
|
|
if (!isset(static::$choices[$value])) { |
52
|
|
|
throw new \InvalidArgumentException(sprintf('Invalid value "%s" for ENUM "%s".', $value, $this->getName())); |
53
|
|
|
} |
54
|
|
|
|
55
|
|
|
return $value; |
56
|
|
|
} |
57
|
|
|
|
58
|
|
|
/** |
59
|
|
|
* {@inheritdoc} |
60
|
|
|
*/ |
61
|
|
|
public function getSqlDeclaration(array $fieldDeclaration, AbstractPlatform $platform) |
62
|
|
|
{ |
63
|
|
|
$values = implode( |
64
|
|
|
', ', |
65
|
|
|
array_map( |
66
|
|
|
function ($value) { |
67
|
|
|
return "'{$value}'"; |
68
|
|
|
}, |
69
|
|
|
static::getValues() |
70
|
|
|
) |
71
|
|
|
); |
72
|
|
|
|
73
|
|
|
if ($platform instanceof SqlitePlatform) { |
74
|
|
|
return sprintf('TEXT CHECK(%s IN (%s))', $fieldDeclaration['name'], $values); |
75
|
|
|
} |
76
|
|
|
|
77
|
|
|
if ($platform instanceof PostgreSqlPlatform || $platform instanceof SQLServerPlatform) { |
78
|
|
|
return sprintf('VARCHAR(255) CHECK(%s IN (%s))', $fieldDeclaration['name'], $values); |
79
|
|
|
} |
80
|
|
|
|
81
|
|
|
return sprintf('ENUM(%s)', $values); |
82
|
|
|
} |
83
|
|
|
|
84
|
|
|
/** |
85
|
|
|
* {@inheritdoc} |
86
|
|
|
*/ |
87
|
|
|
public function requiresSQLCommentHint(AbstractPlatform $platform) |
88
|
|
|
{ |
89
|
|
|
return true; |
90
|
|
|
} |
91
|
|
|
|
92
|
|
|
/** |
93
|
|
|
* {@inheritdoc} |
94
|
|
|
*/ |
95
|
|
|
public function getName() |
96
|
|
|
{ |
97
|
|
|
return $this->name ?: array_search(get_class($this), self::getTypesMap(), true); |
|
|
|
|
98
|
|
|
} |
99
|
|
|
|
100
|
|
|
/** |
101
|
|
|
* Get readable choices for the ENUM field. |
102
|
|
|
* |
103
|
|
|
* @static |
104
|
|
|
* |
105
|
|
|
* @return array Values for the ENUM field |
106
|
|
|
*/ |
107
|
|
|
public static function getChoices() |
108
|
|
|
{ |
109
|
|
|
return array_flip(static::$choices); |
110
|
|
|
} |
111
|
|
|
|
112
|
|
|
/** |
113
|
|
|
* Get values for the ENUM field. |
114
|
|
|
* |
115
|
|
|
* @static |
116
|
|
|
* |
117
|
|
|
* @return array Values for the ENUM field |
118
|
|
|
*/ |
119
|
|
|
public static function getValues() |
120
|
|
|
{ |
121
|
|
|
return array_keys(static::$choices); |
122
|
|
|
} |
123
|
|
|
|
124
|
|
|
/** |
125
|
|
|
* Get array of ENUM Values, where ENUM values are keys and their readable versions are values. |
126
|
|
|
* |
127
|
|
|
* @static |
128
|
|
|
* |
129
|
|
|
* @return array Array of values with readable format |
130
|
|
|
*/ |
131
|
|
|
public static function getReadableValues() |
132
|
|
|
{ |
133
|
|
|
return static::$choices; |
134
|
|
|
} |
135
|
|
|
|
136
|
|
|
/** |
137
|
|
|
* Asserts that given choice exists in the array of ENUM values. |
138
|
|
|
* |
139
|
|
|
* @param string $value ENUM value |
140
|
|
|
* |
141
|
|
|
* @throws \InvalidArgumentException |
142
|
|
|
*/ |
143
|
|
|
public static function assertValidChoice($value) |
144
|
|
|
{ |
145
|
|
|
if (!isset(static::$choices[$value])) { |
146
|
|
|
throw new \InvalidArgumentException(sprintf('Invalid value "%s" for ENUM type "%s".', $value, get_called_class())); |
147
|
|
|
} |
148
|
|
|
} |
149
|
|
|
|
150
|
|
|
/** |
151
|
|
|
* Get value in readable format. |
152
|
|
|
* |
153
|
|
|
* @param string $value ENUM value |
154
|
|
|
* |
155
|
|
|
* @static |
156
|
|
|
* |
157
|
|
|
* @return string|null $value Value in readable format |
158
|
|
|
* |
159
|
|
|
* @throws \InvalidArgumentException |
160
|
|
|
*/ |
161
|
|
|
public static function getReadableValue($value) |
162
|
|
|
{ |
163
|
|
|
static::assertValidChoice($value); |
164
|
|
|
|
165
|
|
|
return static::$choices[$value]; |
166
|
|
|
} |
167
|
|
|
|
168
|
|
|
/** |
169
|
|
|
* Check if some string value exists in the array of ENUM values. |
170
|
|
|
* |
171
|
|
|
* @param string $value ENUM value |
172
|
|
|
* |
173
|
|
|
* @static |
174
|
|
|
* |
175
|
|
|
* @return bool |
176
|
|
|
*/ |
177
|
|
|
public static function isValueExist($value) |
178
|
|
|
{ |
179
|
|
|
return isset(static::$choices[$value]); |
180
|
|
|
} |
181
|
|
|
|
182
|
|
|
/** |
183
|
|
|
* Gets an array of database types that map to this Doctrine type. |
184
|
|
|
* |
185
|
|
|
* @param \Doctrine\DBAL\Platforms\AbstractPlatform $platform |
186
|
|
|
* |
187
|
|
|
* @return array |
188
|
|
|
*/ |
189
|
|
|
public function getMappedDatabaseTypes(AbstractPlatform $platform) |
190
|
|
|
{ |
191
|
|
|
if ($platform instanceof MySqlPlatform) { |
192
|
|
|
return array_merge( |
193
|
|
|
parent::getMappedDatabaseTypes($platform), |
194
|
|
|
[ |
195
|
|
|
'enum', |
196
|
|
|
] |
197
|
|
|
); |
198
|
|
|
} |
199
|
|
|
|
200
|
|
|
return parent::getMappedDatabaseTypes($platform); |
201
|
|
|
} |
202
|
|
|
} |
203
|
|
|
|