Repository navigation
Expand file tree
/
Copy pathAbstractRowGateway.php
More file actions
295 lines (239 loc) · 7.58 KB
/
Copy pathAbstractRowGateway.php
File metadata and controls
295 lines (239 loc) · 7.58 KB
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
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
<?php
declare(strict_types=1);
namespace PhpDb\RowGateway;
use ArrayAccess;
use Countable;
use Override;
use PhpDb\Sql\Sql;
use PhpDb\Sql\TableIdentifier;
use ReturnTypeWillChange;
use function array_key_exists;
use function count;
abstract class AbstractRowGateway implements ArrayAccess, Countable, RowGatewayInterface
{
protected bool $isInitialized = false;
protected TableIdentifier|string|null $table = null;
protected ?array $primaryKeyColumn = null;
protected ?array $primaryKeyData = null;
protected array $data = [];
protected ?Sql $sql = null;
protected ?Feature\FeatureSet $featureSet = null;
/**
* initialize()
*/
public function initialize(): void
{
if ($this->isInitialized) {
return;
}
if (! $this->featureSet instanceof Feature\FeatureSet) {
$this->featureSet = new Feature\FeatureSet();
}
$this->featureSet->setRowGateway($this);
$this->featureSet->apply('preInitialize', []);
if ($this->table === null) {
throw new Exception\RuntimeException('This row object does not have a valid table set.');
}
if ($this->primaryKeyColumn === null) {
throw new Exception\RuntimeException('This row object does not have a primary key column set.');
}
if ($this->sql === null) {
throw new Exception\RuntimeException('This row object does not have a Sql object set.');
}
$this->featureSet->apply('postInitialize', []);
$this->isInitialized = true;
}
/**
* Populate Data
*/
public function populate(array $rowData, bool $rowExistsInDatabase = false): RowGatewayInterface
{
$this->initialize();
$this->data = $rowData;
if ($rowExistsInDatabase === true) {
$this->processPrimaryKeyData();
} else {
$this->primaryKeyData = null;
}
return $this;
}
/**
* docs: Behaviour has changed - this no longer returns RowGatewayInterface but
* instead an array of the old data as per original PHP spec.
*
* @return array<string, mixed>
*/
public function exchangeArray(array $array): array
{
$oldData = $this->data;
$this->populate($array, true);
return $oldData;
}
#[Override]
public function save(): int
{
$this->initialize();
$rowsAffected = 0;
if ($this->rowExistsInDatabase()) {
$data = $this->data;
$where = [];
$isPkModified = false;
foreach ($this->primaryKeyColumn as $pkColumn) {
$where[$pkColumn] = $this->primaryKeyData[$pkColumn];
if ($data[$pkColumn] === $this->primaryKeyData[$pkColumn]) {
unset($data[$pkColumn]);
} else {
$isPkModified = true;
}
}
$statement = $this->sql->prepareStatementForSqlObject($this->sql->update()->set($data)->where($where));
$result = $statement->execute();
$rowsAffected = $result->getAffectedRows();
unset($statement, $result);
if ($isPkModified) {
foreach ($this->primaryKeyColumn as $pkColumn) {
if ($data[$pkColumn] !== $this->primaryKeyData[$pkColumn]) {
$where[$pkColumn] = $data[$pkColumn];
}
}
}
} else {
$insert = $this->sql->insert();
$insert->values($this->data);
$statement = $this->sql->prepareStatementForSqlObject($insert);
$result = $statement->execute();
if (($primaryKeyValue = $result->getGeneratedValue()) && count($this->primaryKeyColumn) === 1) {
$this->primaryKeyData = [$this->primaryKeyColumn[0] => $primaryKeyValue];
} else {
$this->processPrimaryKeyData();
}
$rowsAffected = $result->getAffectedRows();
unset($statement, $result);
$where = [];
foreach ($this->primaryKeyColumn as $pkColumn) {
$where[$pkColumn] = $this->primaryKeyData[$pkColumn];
}
}
$statement = $this->sql->prepareStatementForSqlObject($this->sql->select()->where($where));
$result = $statement->execute();
$rowData = $result->current();
unset($statement, $result);
$this->populate($rowData, true);
return $rowsAffected;
}
#[Override]
public function delete(): int
{
$this->initialize();
$where = [];
foreach ($this->primaryKeyColumn as $pkColumn) {
$where[$pkColumn] = $this->primaryKeyData[$pkColumn] ?? null;
}
// @todo determine if we need to do a select to ensure 1 row will be affected
$rowsAffected = 0;
$statement = $this->sql->prepareStatementForSqlObject($this->sql->delete()->where($where));
$result = $statement->execute();
$rowsAffected = $result->getAffectedRows();
if ($rowsAffected === 1) {
$this->primaryKeyData = null;
}
return $rowsAffected;
}
/**
* Offset Exists
*
* @param string $offset
*/
#[Override]
#[ReturnTypeWillChange]
public function offsetExists($offset): bool
{
return array_key_exists($offset, $this->data);
}
/**
* Offset get
*
* @param string $offset
*/
#[Override]
#[ReturnTypeWillChange]
public function offsetGet($offset): mixed
{
return $this->data[$offset];
}
/**
* Offset set
*
* @param string $offset
*/
#[Override]
#[ReturnTypeWillChange]
public function offsetSet($offset, mixed $value): static
{
$this->data[$offset] = $value;
return $this;
}
/**
* Offset unset
*
* @param string $offset
*/
#[Override]
#[ReturnTypeWillChange]
public function offsetUnset($offset): static
{
$this->data[$offset] = null;
return $this;
}
#[Override]
#[ReturnTypeWillChange]
public function count(): int
{
return count($this->data);
}
public function toArray(): array
{
return $this->data;
}
/**
* @throws Exception\InvalidArgumentException
*/
public function __get(string $name): mixed
{
if (array_key_exists($name, $this->data)) {
return $this->data[$name];
}
throw new Exception\InvalidArgumentException('Not a valid column in this row: ' . $name);
}
public function __set(string $name, mixed $value): void
{
$this->offsetSet($name, $value);
}
public function __isset(string $name): bool
{
return $this->offsetExists($name);
}
public function __unset(string $name): void
{
$this->offsetUnset($name);
}
public function rowExistsInDatabase(): bool
{
return $this->primaryKeyData !== null;
}
/**
* @throws Exception\RuntimeException
*/
protected function processPrimaryKeyData(): void
{
$this->primaryKeyData = [];
foreach ($this->primaryKeyColumn as $column) {
if (! isset($this->data[$column])) {
throw new Exception\RuntimeException(
'While processing primary key data, a known key ' . $column . ' was not found in the data array'
);
}
$this->primaryKeyData[$column] = $this->data[$column];
}
}
}