-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
BinaryUuidType.php
168 lines (153 loc) · 4.39 KB
/
BinaryUuidType.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
<?php
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.6.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Database\Type;
use Cake\Core\Exception\Exception;
use Cake\Database\Driver;
use Cake\Database\Type;
use Cake\Database\TypeInterface;
use Cake\Utility\Text;
use PDO;
/**
* Binary UUID type converter.
*
* Use to convert binary uuid data between PHP and the database types.
*/
class BinaryUuidType extends Type implements TypeInterface
{
/**
* Identifier name for this type.
*
* (This property is declared here again so that the inheritance from
* Cake\Database\Type can be removed in the future.)
*
* @var string|null
*/
protected $_name;
/**
* Constructor.
*
* (This method is declared here again so that the inheritance from
* Cake\Database\Type can be removed in the future.)
*
* @param string|null $name The name identifying this type
*/
public function __construct($name = null)
{
$this->_name = $name;
}
/**
* Convert binary uuid data into the database format.
*
* Binary data is not altered before being inserted into the database.
* As PDO will handle reading file handles.
*
* @param string|resource $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return string|resource
*/
public function toDatabase($value, Driver $driver)
{
if (is_string($value)) {
return $this->convertStringToBinaryUuid($value);
}
return $value;
}
/**
* Generate a new binary UUID
*
* @return string A new primary key value.
*/
public function newId()
{
return Text::uuid();
}
/**
* Convert binary uuid into resource handles
*
* @param resource|string|null $value The value to convert.
* @param \Cake\Database\Driver $driver The driver instance to convert with.
* @return resource|string|null
* @throws \Cake\Core\Exception\Exception
*/
public function toPHP($value, Driver $driver)
{
if ($value === null) {
return null;
}
if (is_string($value)) {
return $this->convertBinaryUuidToString($value);
}
if (is_resource($value)) {
return $value;
}
throw new Exception(sprintf('Unable to convert %s into binary uuid.', gettype($value)));
}
/**
* Get the correct PDO binding type for Binary data.
*
* @param mixed $value The value being bound.
* @param \Cake\Database\Driver $driver The driver.
* @return int
*/
public function toStatement($value, Driver $driver)
{
return PDO::PARAM_LOB;
}
/**
* Marshals flat data into PHP objects.
*
* Most useful for converting request data into PHP objects
* that make sense for the rest of the ORM/Database layers.
*
* @param mixed $value The value to convert.
*
* @return mixed Converted value.
*/
public function marshal($value)
{
return $value;
}
/**
* Converts a binary uuid to a string representation
*
*
* @param mixed $binary The value to convert.
*
* @return string Converted value.
*/
protected function convertBinaryUuidToString($binary)
{
$string = unpack("H*", $binary);
$string = preg_replace(
"/([0-9a-f]{8})([0-9a-f]{4})([0-9a-f]{4})([0-9a-f]{4})([0-9a-f]{12})/",
"$1-$2-$3-$4-$5",
$string
);
return $string[1];
}
/**
* Converts a string uuid to a binary representation
*
*
* @param string $string The value to convert.
*
* @return string Converted value.
*/
protected function convertStringToBinaryUuid($string)
{
$string = str_replace('-', '', $string);
return pack("H*", $string);
}
}