forked from ezsystems/ezpublish-kernel
-
Notifications
You must be signed in to change notification settings - Fork 0
/
FieldHandler.php
448 lines (408 loc) · 17.2 KB
/
FieldHandler.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
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
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
<?php
/**
* File containing the Content FieldHandler class.
*
* @copyright Copyright (C) eZ Systems AS. All rights reserved.
* @license For full copyright and license information view LICENSE file distributed with this source code.
*/
namespace eZ\Publish\Core\Persistence\Legacy\Content;
use eZ\Publish\SPI\Persistence\Content;
use eZ\Publish\SPI\Persistence\Content\Type;
use eZ\Publish\SPI\Persistence\Content\VersionInfo;
use eZ\Publish\SPI\Persistence\Content\Field;
use eZ\Publish\SPI\Persistence\Content\UpdateStruct;
use eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition;
use eZ\Publish\Core\Persistence\FieldTypeRegistry;
use eZ\Publish\SPI\Persistence\Content\Language\Handler as LanguageHandler;
/**
* Field Handler.
*/
class FieldHandler
{
/**
* Content Gateway.
*
* @var \eZ\Publish\Core\Persistence\Legacy\Content\Gateway
*/
protected $contentGateway;
/**
* @var \eZ\Publish\Core\Persistence\Legacy\Content\Language\Handler
*/
protected $languageHandler;
/**
* Content Mapper.
*
* @var \eZ\Publish\Core\Persistence\Legacy\Content\Mapper
*/
protected $mapper;
/**
* Storage Handler.
*
* @var \eZ\Publish\Core\Persistence\Legacy\Content\StorageHandler
*/
protected $storageHandler;
/**
* FieldType registry.
*
* @var \eZ\Publish\Core\Persistence\FieldTypeRegistry
*/
protected $fieldTypeRegistry;
/**
* Hash of SPI FieldTypes or callable callbacks to generate one.
*
* @var array
*/
protected $fieldTypes;
/**
* Creates a new Field Handler.
*
* @param \eZ\Publish\Core\Persistence\Legacy\Content\Gateway $contentGateway
* @param \eZ\Publish\Core\Persistence\Legacy\Content\Mapper $mapper
* @param \eZ\Publish\Core\Persistence\Legacy\Content\StorageHandler $storageHandler
* @param \eZ\Publish\SPI\Persistence\Content\Language\Handler $languageHandler
* @param \eZ\Publish\Core\Persistence\FieldTypeRegistry $fieldTypeRegistry
*/
public function __construct(
Gateway $contentGateway,
Mapper $mapper,
StorageHandler $storageHandler,
LanguageHandler $languageHandler,
FieldTypeRegistry $fieldTypeRegistry
) {
$this->contentGateway = $contentGateway;
$this->mapper = $mapper;
$this->storageHandler = $storageHandler;
$this->languageHandler = $languageHandler;
$this->fieldTypeRegistry = $fieldTypeRegistry;
}
/**
* Creates new fields in the database from $content of $contentType.
*
* @param \eZ\Publish\SPI\Persistence\Content $content
* @param \eZ\Publish\SPI\Persistence\Content\Type $contentType
*/
public function createNewFields(Content $content, Type $contentType)
{
$fieldsToCopy = array();
$languageCodes = array();
$fields = $this->getFieldMap($content->fields, $languageCodes);
$languageCodes[$content->versionInfo->contentInfo->mainLanguageCode] = true;
foreach ($contentType->fieldDefinitions as $fieldDefinition) {
foreach (array_keys($languageCodes) as $languageCode) {
// Create fields passed from struct
if (isset($fields[$fieldDefinition->id][$languageCode])) {
$field = $fields[$fieldDefinition->id][$languageCode];
$this->createNewField($field, $content);
} elseif (
!$fieldDefinition->isTranslatable
&& isset($fields[$fieldDefinition->id][$content->versionInfo->contentInfo->mainLanguageCode])
) {
// Copy only for untranslatable field and when field in main language exists
// Only register here, process later as field copied should be already stored
$fieldsToCopy[$fieldDefinition->id][$languageCode] =
$fields[$fieldDefinition->id][$content->versionInfo->contentInfo->mainLanguageCode];
} else { // In all other cases create empty field
$field = $this->getEmptyField($fieldDefinition, $languageCode);
$content->fields[] = $field;
$this->createNewField($field, $content);
}
}
}
$this->copyFields($fieldsToCopy, $content);
}
/**
* Returns empty Field object for given field definition and language code.
*
* Uses FieldType to create empty field value.
*
* @param \eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition $fieldDefinition
* @param string $languageCode
*
* @return \eZ\Publish\SPI\Persistence\Content\Field
*/
protected function getEmptyField(FieldDefinition $fieldDefinition, $languageCode)
{
$fieldType = $this->fieldTypeRegistry->getFieldType($fieldDefinition->fieldType);
return new Field(
array(
'fieldDefinitionId' => $fieldDefinition->id,
'type' => $fieldDefinition->fieldType,
'value' => $fieldType->getEmptyValue(),
'languageCode' => $languageCode,
)
);
}
/**
* Creates existing fields in a new version for $content.
*
* @param \eZ\Publish\SPI\Persistence\Content $content
*/
public function createExistingFieldsInNewVersion(Content $content)
{
foreach ($content->fields as $field) {
$this->createExistingFieldInNewVersion($field, $content);
}
}
/**
* Creates a new field in the database.
*
* Used by self::createNewFields() and self::updateFields()
*
* @param \eZ\Publish\SPI\Persistence\Content\Field $field
* @param \eZ\Publish\SPI\Persistence\Content $content
*/
protected function createNewField(Field $field, Content $content)
{
$field->versionNo = $content->versionInfo->versionNo;
$field->id = $this->contentGateway->insertNewField(
$content,
$field,
$this->mapper->convertToStorageValue($field)
);
// If the storage handler returns true, it means that $field value has been modified
// So we need to update it in order to store those modifications
// Field converter is called once again via the Mapper
if ($this->storageHandler->storeFieldData($content->versionInfo, $field) === true) {
$this->contentGateway->updateField(
$field,
$this->mapper->convertToStorageValue($field)
);
}
}
/**
* @param array $fields
* @param \eZ\Publish\SPI\Persistence\Content $content
*/
protected function copyFields(array $fields, Content $content)
{
foreach ($fields as $languageFields) {
foreach ($languageFields as $languageCode => $field) {
$this->copyField($field, $languageCode, $content);
}
}
}
/**
* Copies existing field to new field for given $languageCode.
*
* Used by self::createNewFields() and self::updateFields()
*
* @param \eZ\Publish\SPI\Persistence\Content\Field $originalField
* @param string $languageCode
* @param \eZ\Publish\SPI\Persistence\Content $content
*/
protected function copyField(Field $originalField, $languageCode, Content $content)
{
$originalField->versionNo = $content->versionInfo->versionNo;
$field = clone $originalField;
$field->languageCode = $languageCode;
$field->id = $this->contentGateway->insertNewField(
$content,
$field,
$this->mapper->convertToStorageValue($field)
);
// If the storage handler returns true, it means that $field value has been modified
// So we need to update it in order to store those modifications
// Field converter is called once again via the Mapper
if ($this->storageHandler->copyFieldData($content->versionInfo, $field, $originalField) === true) {
$this->contentGateway->updateField(
$field,
$this->mapper->convertToStorageValue($field)
);
}
$content->fields[] = $field;
}
/**
* Updates an existing field in the database.
*
* Used by self::createNewFields() and self::updateFields()
*
* @param \eZ\Publish\SPI\Persistence\Content\Field $field
* @param \eZ\Publish\SPI\Persistence\Content $content
*/
protected function updateField(Field $field, Content $content)
{
$this->contentGateway->updateField(
$field,
$this->mapper->convertToStorageValue($field)
);
// If the storage handler returns true, it means that $field value has been modified
// So we need to update it in order to store those modifications
// Field converter is called once again via the Mapper
if ($this->storageHandler->storeFieldData($content->versionInfo, $field) === true) {
$this->contentGateway->updateField(
$field,
$this->mapper->convertToStorageValue($field)
);
}
}
/**
* Creates an existing field in a new version, no new ID is generated.
*
* Used to insert a field with an existing ID but a new version number.
* $content is used for new version data, needed by Content gateway and external storage.
*
* External data is being copied here as some FieldTypes require original field external data.
* By default copying falls back to storing, it is upon external storage implementation to override
* the behaviour as needed.
*
* @param Field $field
* @param Content $content
*/
protected function createExistingFieldInNewVersion(Field $field, Content $content)
{
$originalField = clone $field;
$field->versionNo = $content->versionInfo->versionNo;
$this->contentGateway->insertExistingField(
$content,
$field,
$this->mapper->convertToStorageValue($field)
);
// If the storage handler returns true, it means that $field value has been modified
// So we need to update it in order to store those modifications
// Field converter is called once again via the Mapper
if ($this->storageHandler->copyFieldData($content->versionInfo, $field, $originalField) === true) {
$this->contentGateway->updateField(
$field,
$this->mapper->convertToStorageValue($field)
);
}
}
/**
* Performs external loads for the fields in $content.
*
* @param Content $content
*/
public function loadExternalFieldData(Content $content)
{
foreach ($content->fields as $field) {
$this->storageHandler->getFieldData($content->versionInfo, $field);
}
}
/**
* Updates the fields in for content identified by $contentId and $versionNo in the database in respect to $updateStruct.
*
* @param \eZ\Publish\SPI\Persistence\Content $content
* @param \eZ\Publish\SPI\Persistence\Content\UpdateStruct $updateStruct
* @param \eZ\Publish\SPI\Persistence\Content\Type $contentType
*/
public function updateFields(Content $content, UpdateStruct $updateStruct, Type $contentType)
{
$updatedFields = array();
$fieldsToCopy = array();
$nonTranslatableCopiesUpdateSet = array();
$mainLanguageCode = $content->versionInfo->contentInfo->mainLanguageCode;
$languageCodes = $existingLanguageCodes = array_fill_keys($content->versionInfo->languageCodes, true);
$contentFieldMap = $this->getFieldMap($content->fields);
$updateFieldMap = $this->getFieldMap($updateStruct->fields, $languageCodes);
$initialLanguageCode = $this->languageHandler->load($updateStruct->initialLanguageId)->languageCode;
$languageCodes[$initialLanguageCode] = true;
foreach ($contentType->fieldDefinitions as $fieldDefinition) {
foreach (array_keys($languageCodes) as $languageCode) {
if (isset($updateFieldMap[$fieldDefinition->id][$languageCode])) {
$field = clone $updateFieldMap[$fieldDefinition->id][$languageCode];
$field->versionNo = $content->versionInfo->versionNo;
if (isset($field->id)) {
$this->updateField($field, $content);
$updatedFields[$fieldDefinition->id][$languageCode] = $field;
} else {
$this->createNewField($field, $content);
}
} elseif (!isset($existingLanguageCodes[$languageCode])) {
// If field is not set for new language
if ($fieldDefinition->isTranslatable) {
// Use empty value for translatable field
$field = $this->getEmptyField($fieldDefinition, $languageCode);
$this->createNewField($field, $content);
} else {
// Use value from main language code for untranslatable field
$fieldsToCopy[$fieldDefinition->id][$languageCode] =
isset($updateFieldMap[$fieldDefinition->id][$mainLanguageCode])
? $updateFieldMap[$fieldDefinition->id][$mainLanguageCode]
: $contentFieldMap[$fieldDefinition->id][$mainLanguageCode];
}
} elseif (!$fieldDefinition->isTranslatable
&& isset($updateFieldMap[$fieldDefinition->id][$mainLanguageCode])
) {
// If field is not set for existing language and is untranslatable and main language is updated,
// also update copied field data
// Register for processing after all given fields are updated
$nonTranslatableCopiesUpdateSet[$fieldDefinition->id][] = $languageCode;
}
// If no above conditions were met - do nothing
}
}
foreach ($nonTranslatableCopiesUpdateSet as $fieldDefinitionId => $languageCodes) {
foreach ($languageCodes as $languageCode) {
$this->updateCopiedField(
$contentFieldMap[$fieldDefinitionId][$languageCode],
$updateFieldMap[$fieldDefinitionId][$mainLanguageCode],
$updatedFields[$fieldDefinitionId][$mainLanguageCode],
$content
);
}
}
$this->copyFields($fieldsToCopy, $content);
}
/**
* Updates a language copy of a non-translatable field.
*
* External data is being copied here as some FieldTypes require original field external data.
* By default copying falls back to storing, it is upon external storage implementation to override
* the behaviour as needed.
*
* @param \eZ\Publish\SPI\Persistence\Content\Field $field
* @param \eZ\Publish\SPI\Persistence\Content\Field $updateField
* @param \eZ\Publish\SPI\Persistence\Content\Field $originalField
* @param \eZ\Publish\SPI\Persistence\Content $content
*/
protected function updateCopiedField(Field $field, Field $updateField, Field $originalField, Content $content)
{
$field->versionNo = $content->versionInfo->versionNo;
$field->value = clone $updateField->value;
$this->contentGateway->updateField(
$field,
$this->mapper->convertToStorageValue($field)
);
// If the storage handler returns true, it means that $field value has been modified
// So we need to update it in order to store those modifications
// Field converter is called once again via the Mapper
if ($this->storageHandler->copyFieldData($content->versionInfo, $field, $originalField) === true) {
$this->contentGateway->updateField(
$field,
$this->mapper->convertToStorageValue($field)
);
}
}
/**
* Returns given $fields structured in hash array with field definition ids and language codes as keys.
*
* @param \eZ\Publish\SPI\Persistence\Content\Field[] $fields
* @param array $languageCodes
*
* @return \eZ\Publish\SPI\Persistence\Content\Field[][]
*/
protected function getFieldMap(array $fields, &$languageCodes = null)
{
$fieldMap = array();
foreach ($fields as $field) {
if (isset($languageCodes)) {
$languageCodes[$field->languageCode] = true;
}
$fieldMap[$field->fieldDefinitionId][$field->languageCode] = $field;
}
return $fieldMap;
}
/**
* Deletes the fields for $contentId in $versionInfo from the database.
*
* @param int $contentId
* @param \eZ\Publish\SPI\Persistence\Content\VersionInfo $versionInfo
*/
public function deleteFields($contentId, VersionInfo $versionInfo)
{
foreach ($this->contentGateway->getFieldIdsByType($contentId, $versionInfo->versionNo) as $fieldType => $ids) {
$this->storageHandler->deleteFieldData($fieldType, $versionInfo, $ids);
}
$this->contentGateway->deleteFields($contentId, $versionInfo->versionNo);
}
}