|
1
|
|
|
<?php |
|
2
|
|
|
|
|
3
|
|
|
namespace Kaliop\eZMigrationBundle\Core\Executor; |
|
4
|
|
|
|
|
5
|
|
|
use eZ\Publish\API\Repository\Values\ContentType\ContentType; |
|
6
|
|
|
use eZ\Publish\API\Repository\Values\ContentType\FieldDefinition; |
|
7
|
|
|
use eZ\Publish\API\Repository\Values\Content\Content; |
|
8
|
|
|
use eZ\Publish\API\Repository\Values\Content\ContentCreateStruct; |
|
9
|
|
|
use eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct; |
|
10
|
|
|
use Kaliop\eZMigrationBundle\API\Collection\ContentCollection; |
|
11
|
|
|
use Kaliop\eZMigrationBundle\API\MigrationGeneratorInterface; |
|
12
|
|
|
use Kaliop\eZMigrationBundle\Core\ComplexField\ComplexFieldManager; |
|
13
|
|
|
use Kaliop\eZMigrationBundle\Core\Matcher\ContentMatcher; |
|
14
|
|
|
use Kaliop\eZMigrationBundle\Core\Matcher\SectionMatcher; |
|
15
|
|
|
use Kaliop\eZMigrationBundle\Core\Matcher\UserMatcher; |
|
16
|
|
|
use Kaliop\eZMigrationBundle\Core\Matcher\ObjectStateMatcher; |
|
17
|
|
|
use Kaliop\eZMigrationBundle\Core\Helper\SortConverter; |
|
18
|
|
|
use eZ\Publish\Core\Base\Exceptions\NotFoundException; |
|
19
|
|
|
|
|
20
|
|
|
/** |
|
21
|
|
|
* Implements the actions for managing (create/update/delete) Content in the system through |
|
22
|
|
|
* migrations and abstracts away the eZ Publish Public API. |
|
23
|
|
|
* |
|
24
|
|
|
* @todo add support for updating of content metadata |
|
25
|
|
|
*/ |
|
26
|
|
|
class ContentManager extends RepositoryExecutor implements MigrationGeneratorInterface |
|
27
|
20 |
|
{ |
|
28
|
|
|
protected $supportedStepTypes = array('content'); |
|
29
|
20 |
|
protected $supportedActions = array('create', 'load', 'update', 'delete'); |
|
30
|
20 |
|
|
|
31
|
20 |
|
protected $contentMatcher; |
|
32
|
|
|
protected $sectionMatcher; |
|
33
|
|
|
protected $userMatcher; |
|
34
|
|
|
protected $objectStateMatcher; |
|
35
|
|
|
protected $complexFieldManager; |
|
36
|
4 |
|
protected $locationManager; |
|
37
|
|
|
protected $sortConverter; |
|
38
|
4 |
|
|
|
39
|
4 |
|
public function __construct( |
|
40
|
4 |
|
ContentMatcher $contentMatcher, |
|
41
|
|
|
SectionMatcher $sectionMatcher, |
|
42
|
4 |
|
UserMatcher $userMatcher, |
|
43
|
4 |
|
ObjectStateMatcher $objectStateMatcher, |
|
44
|
3 |
|
ComplexFieldManager $complexFieldManager, |
|
45
|
3 |
|
LocationManager $locationManager, |
|
46
|
4 |
|
SortConverter $sortConverter |
|
47
|
|
|
) { |
|
48
|
4 |
|
$this->contentMatcher = $contentMatcher; |
|
49
|
4 |
|
$this->sectionMatcher = $sectionMatcher; |
|
50
|
|
|
$this->userMatcher = $userMatcher; |
|
51
|
4 |
|
$this->objectStateMatcher = $objectStateMatcher; |
|
52
|
1 |
|
$this->complexFieldManager = $complexFieldManager; |
|
53
|
1 |
|
$this->locationManager = $locationManager; |
|
54
|
|
|
$this->sortConverter = $sortConverter; |
|
55
|
|
|
} |
|
56
|
4 |
|
|
|
57
|
4 |
|
/** |
|
58
|
1 |
|
* Handle the content create migration action type |
|
59
|
1 |
|
*/ |
|
60
|
4 |
|
protected function create() |
|
61
|
4 |
|
{ |
|
62
|
1 |
|
$contentService = $this->repository->getContentService(); |
|
63
|
1 |
|
$locationService = $this->repository->getLocationService(); |
|
64
|
|
|
$contentTypeService = $this->repository->getContentTypeService(); |
|
65
|
4 |
|
|
|
66
|
1 |
|
$contentTypeIdentifier = $this->dsl['content_type']; |
|
67
|
1 |
|
$contentTypeIdentifier = $this->referenceResolver->resolveReference($contentTypeIdentifier); |
|
68
|
|
|
/// @todo use a contenttypematcher |
|
69
|
4 |
|
$contentType = $contentTypeService->loadContentTypeByIdentifier($contentTypeIdentifier); |
|
70
|
|
|
|
|
71
|
4 |
|
$contentCreateStruct = $contentService->newContentCreateStruct($contentType, $this->getLanguageCode()); |
|
72
|
|
|
|
|
73
|
|
|
$this->setFields($contentCreateStruct, $this->dsl['attributes'], $contentType); |
|
74
|
|
|
|
|
75
|
|
|
if (isset($this->dsl['always_available'])) { |
|
76
|
|
|
$contentCreateStruct->alwaysAvailable = $this->dsl['always_available']; |
|
77
|
|
|
} else { |
|
78
|
|
|
// Could be removed when https://github.com/ezsystems/ezpublish-kernel/pull/1874 is merged, |
|
79
|
|
|
// but we strive to support old eZ kernel versions as well... |
|
80
|
|
|
$contentCreateStruct->alwaysAvailable = $contentType->defaultAlwaysAvailable; |
|
81
|
|
|
} |
|
82
|
|
|
|
|
83
|
4 |
|
if (isset($this->dsl['remote_id'])) { |
|
84
|
3 |
|
$contentCreateStruct->remoteId = $this->dsl['remote_id']; |
|
85
|
|
|
} |
|
86
|
3 |
|
|
|
87
|
3 |
View Code Duplication |
if (isset($this->dsl['section'])) { |
|
|
|
|
|
|
88
|
|
|
$sectionKey = $this->referenceResolver->resolveReference($this->dsl['section']); |
|
89
|
|
|
$section = $this->sectionMatcher->matchOneByKey($sectionKey); |
|
90
|
|
|
$contentCreateStruct->sectionId = $section->id; |
|
91
|
|
|
} |
|
92
|
|
|
|
|
93
|
|
View Code Duplication |
if (isset($this->dsl['owner'])) { |
|
|
|
|
|
|
94
|
1 |
|
$owner = $this->getUser($this->dsl['owner']); |
|
95
|
|
|
$contentCreateStruct->ownerId = $owner->id; |
|
96
|
1 |
|
} |
|
97
|
1 |
|
|
|
98
|
|
|
// This is a bit tricky, as the eZPublish API does not support having a different creator and owner with only 1 version. |
|
99
|
|
|
// We allow it, hoping that nothing gets broken because of it |
|
100
|
|
|
if (isset($this->dsl['version_creator'])) { |
|
101
|
|
|
$realContentOwnerId = $contentCreateStruct->ownerId; |
|
102
|
|
|
if ($realContentOwnerId == null) { |
|
103
|
|
|
$realContentOwnerId = $this->repository->getCurrentUser()->id; |
|
104
|
|
|
} |
|
105
|
|
|
$versionCreator = $this->getUser($this->dsl['version_creator']); |
|
106
|
|
|
$contentCreateStruct->ownerId = $versionCreator->id; |
|
107
|
|
|
} |
|
108
|
|
|
|
|
109
|
|
|
if (isset($this->dsl['modification_date'])) { |
|
110
|
|
|
$contentCreateStruct->modificationDate = $this->toDateTime($this->dsl['modification_date']); |
|
111
|
|
|
} |
|
112
|
|
|
|
|
113
|
|
|
// instantiate a location create struct from the parent location: |
|
114
|
|
|
// BC |
|
115
|
|
|
$locationId = isset($this->dsl['parent_location']) ? $this->dsl['parent_location'] : ( |
|
116
|
|
|
isset($this->dsl['main_location']) ? $this->dsl['main_location'] : null |
|
117
|
|
|
); |
|
118
|
|
|
// 1st resolve references |
|
119
|
|
|
$locationId = $this->referenceResolver->resolveReference($locationId); |
|
120
|
|
|
// 2nd allow to specify the location via remote_id |
|
121
|
1 |
|
$locationId = $this->locationManager->matchLocationByKey($locationId)->id; |
|
122
|
|
|
$locationCreateStruct = $locationService->newLocationCreateStruct($locationId); |
|
123
|
1 |
|
|
|
124
|
|
|
if (isset($this->dsl['location_remote_id'])) { |
|
125
|
|
|
$locationCreateStruct->remoteId = $this->dsl['location_remote_id']; |
|
126
|
|
|
} |
|
127
|
1 |
|
|
|
128
|
|
|
if (isset($this->dsl['priority'])) { |
|
129
|
1 |
|
$locationCreateStruct->priority = $this->dsl['priority']; |
|
130
|
1 |
|
} |
|
131
|
|
|
|
|
132
|
1 |
|
if (isset($this->dsl['is_hidden'])) { |
|
133
|
1 |
|
$locationCreateStruct->hidden = $this->dsl['is_hidden']; |
|
134
|
1 |
|
} |
|
135
|
|
|
|
|
136
|
1 |
|
if (isset($this->dsl['sort_field'])) { |
|
137
|
|
|
$locationCreateStruct->sortField = $this->sortConverter->hash2SortField($this->dsl['sort_field']); |
|
138
|
1 |
|
} else { |
|
139
|
1 |
|
$locationCreateStruct->sortField = $contentType->defaultSortField; |
|
140
|
1 |
|
} |
|
141
|
|
|
|
|
142
|
1 |
|
if (isset($this->dsl['sort_order'])) { |
|
143
|
1 |
|
$locationCreateStruct->sortOrder = $this->sortConverter->hash2SortOrder($this->dsl['sort_order']); |
|
144
|
1 |
|
} else { |
|
145
|
|
|
$locationCreateStruct->sortOrder = $contentType->defaultSortOrder; |
|
146
|
1 |
|
} |
|
147
|
|
|
|
|
148
|
|
|
$locations = array($locationCreateStruct); |
|
149
|
|
|
|
|
150
|
|
|
// BC |
|
151
|
|
|
$other_locations = isset($this->dsl['other_parent_locations']) ? $this->dsl['other_parent_locations'] : ( |
|
152
|
|
|
isset($this->dsl['other_locations']) ? $this->dsl['other_locations'] : null |
|
153
|
|
|
); |
|
154
|
|
|
if (isset($other_locations)) { |
|
155
|
|
|
foreach ($other_locations as $locationId) { |
|
156
|
|
|
$locationId = $this->referenceResolver->resolveReference($locationId); |
|
157
|
|
|
$locationId = $this->locationManager->matchLocationByKey($locationId)->id; |
|
158
|
|
|
$secondaryLocationCreateStruct = $locationService->newLocationCreateStruct($locationId); |
|
159
|
|
|
array_push($locations, $secondaryLocationCreateStruct); |
|
160
|
|
|
} |
|
161
|
1 |
|
} |
|
162
|
1 |
|
|
|
163
|
1 |
|
// create a draft using the content and location create struct and publish it |
|
164
|
|
|
$draft = $contentService->createContent($contentCreateStruct, $locations); |
|
165
|
|
|
$content = $contentService->publishVersion($draft->versionInfo); |
|
166
|
|
|
|
|
167
|
|
|
if (isset($this->dsl['object_states'])) { |
|
168
|
3 |
|
$this->setObjectStates($content, $this->dsl['object_states']); |
|
169
|
|
|
} |
|
170
|
3 |
|
|
|
171
|
|
|
// 2nd part of the hack: re-set the content owner to its intended value |
|
172
|
3 |
|
if (isset($this->dsl['version_creator']) || isset($this->dsl['publication_date'])) { |
|
173
|
|
|
$contentMetaDataUpdateStruct = $contentService->newContentMetadataUpdateStruct(); |
|
174
|
3 |
|
|
|
175
|
|
|
if (isset($this->dsl['version_creator'])) { |
|
176
|
3 |
|
$contentMetaDataUpdateStruct->ownerId = $realContentOwnerId; |
|
|
|
|
|
|
177
|
3 |
|
} |
|
178
|
|
|
if (isset($this->dsl['publication_date'])) { |
|
179
|
|
|
$contentMetaDataUpdateStruct->publishedDate = $this->toDateTime($this->dsl['publication_date']); |
|
180
|
|
|
} |
|
181
|
3 |
|
|
|
182
|
3 |
|
$contentService->updateContentMetadata($content->contentInfo, $contentMetaDataUpdateStruct); |
|
183
|
|
|
} |
|
184
|
|
|
|
|
185
|
|
|
$this->setReferences($content); |
|
186
|
|
|
|
|
187
|
|
|
return $content; |
|
188
|
|
|
} |
|
189
|
3 |
|
|
|
190
|
|
View Code Duplication |
protected function load() |
|
|
|
|
|
|
191
|
3 |
|
{ |
|
192
|
|
|
$contentCollection = $this->matchContents('load'); |
|
193
|
|
|
|
|
194
|
|
|
if (count($contentCollection) > 1 && isset($this->dsl['references'])) { |
|
195
|
|
|
throw new \Exception("Can not execute Content load because multiple contents match, and a references section is specified in the dsl. References can be set when only 1 content matches"); |
|
196
|
3 |
|
} |
|
197
|
1 |
|
|
|
198
|
1 |
|
$this->setReferences($contentCollection); |
|
|
|
|
|
|
199
|
1 |
|
|
|
200
|
|
|
return $contentCollection; |
|
201
|
|
|
} |
|
202
|
1 |
|
|
|
203
|
|
|
/** |
|
204
|
3 |
|
* Handle the content update migration action type |
|
205
|
|
|
* |
|
206
|
|
|
* @todo handle updating of more metadata fields |
|
207
|
3 |
|
*/ |
|
208
|
3 |
|
protected function update() |
|
209
|
1 |
|
{ |
|
210
|
1 |
|
$contentService = $this->repository->getContentService(); |
|
211
|
1 |
|
$contentTypeService = $this->repository->getContentTypeService(); |
|
212
|
1 |
|
|
|
213
|
1 |
|
$contentCollection = $this->matchContents('update'); |
|
214
|
1 |
|
|
|
215
|
3 |
|
if (count($contentCollection) > 1 && isset($this->dsl['references'])) { |
|
216
|
3 |
|
throw new \Exception("Can not execute Content update because multiple contents match, and a references section is specified in the dsl. References can be set when only 1 content matches"); |
|
217
|
3 |
|
} |
|
218
|
|
|
|
|
219
|
3 |
|
$contentType = null; |
|
220
|
|
|
|
|
221
|
3 |
|
foreach ($contentCollection as $key => $content) { |
|
|
|
|
|
|
222
|
|
|
$contentInfo = $content->contentInfo; |
|
223
|
|
|
|
|
224
|
|
|
if ($contentType == null) { |
|
225
|
|
|
$contentType = $contentTypeService->loadContentType($contentInfo->contentTypeId); |
|
226
|
|
|
} |
|
227
|
|
|
|
|
228
|
|
|
$contentUpdateStruct = $contentService->newContentUpdateStruct(); |
|
229
|
|
|
|
|
230
|
|
|
if (isset($this->dsl['attributes'])) { |
|
231
|
4 |
|
$this->setFields($contentUpdateStruct, $this->dsl['attributes'], $contentType); |
|
232
|
|
|
} |
|
233
|
4 |
|
|
|
234
|
|
|
$versionCreator = null; |
|
235
|
|
|
if (isset($this->dsl['version_creator'])) { |
|
236
|
4 |
|
$versionCreator = $this->getUser($this->dsl['version_creator']); |
|
237
|
|
|
} |
|
238
|
4 |
|
|
|
239
|
|
|
$draft = $contentService->createContentDraft($contentInfo, null, $versionCreator); |
|
240
|
4 |
|
$contentService->updateContent($draft->versionInfo, $contentUpdateStruct); |
|
241
|
|
|
$content = $contentService->publishVersion($draft->versionInfo); |
|
242
|
1 |
|
|
|
243
|
1 |
|
if (isset($this->dsl['always_available']) || |
|
244
|
|
|
isset($this->dsl['new_remote_id']) || |
|
245
|
4 |
|
isset($this->dsl['owner']) || |
|
246
|
3 |
|
isset($this->dsl['modification_date']) || |
|
247
|
|
|
isset($this->dsl['publication_date'])) { |
|
248
|
4 |
|
|
|
249
|
4 |
|
$contentMetaDataUpdateStruct = $contentService->newContentMetadataUpdateStruct(); |
|
250
|
4 |
|
|
|
251
|
|
|
if (isset($this->dsl['always_available'])) { |
|
252
|
|
|
$contentMetaDataUpdateStruct->alwaysAvailable = $this->dsl['always_available']; |
|
253
|
|
|
} |
|
254
|
|
|
|
|
255
|
|
|
if (isset($this->dsl['new_remote_id'])) { |
|
256
|
|
|
$contentMetaDataUpdateStruct->remoteId = $this->dsl['new_remote_id']; |
|
257
|
|
|
} |
|
258
|
|
|
|
|
259
|
|
View Code Duplication |
if (isset($this->dsl['owner'])) { |
|
|
|
|
|
|
260
|
|
|
$owner = $this->getUser($this->dsl['owner']); |
|
261
|
|
|
$contentMetaDataUpdateStruct->ownerId = $owner->id; |
|
262
|
4 |
|
} |
|
263
|
|
|
|
|
264
|
4 |
|
if (isset($this->dsl['modification_date'])) { |
|
265
|
4 |
|
$contentMetaDataUpdateStruct->modificationDate = $this->toDateTime($this->dsl['modification_date']); |
|
266
|
|
|
} |
|
267
|
|
|
|
|
268
|
4 |
|
if (isset($this->dsl['publication_date'])) { |
|
269
|
4 |
|
$contentMetaDataUpdateStruct->publishedDate = $this->toDateTime($this->dsl['publication_date']); |
|
270
|
4 |
|
} |
|
271
|
|
|
|
|
272
|
4 |
|
$content = $contentService->updateContentMetadata($content->contentInfo, $contentMetaDataUpdateStruct); |
|
273
|
1 |
|
} |
|
274
|
1 |
|
|
|
275
|
|
|
if (isset($this->dsl['section'])) { |
|
276
|
4 |
|
$this->setSection($content, $this->dsl['section']); |
|
277
|
|
|
} |
|
278
|
|
|
|
|
279
|
|
|
if (isset($this->dsl['object_states'])) { |
|
280
|
|
|
$this->setObjectStates($content, $this->dsl['object_states']); |
|
281
|
|
|
} |
|
282
|
|
|
|
|
283
|
|
|
$contentCollection[$key] = $content; |
|
284
|
|
|
} |
|
285
|
|
|
|
|
286
|
|
|
$this->setReferences($contentCollection); |
|
|
|
|
|
|
287
|
1 |
|
|
|
288
|
|
|
return $contentCollection; |
|
289
|
1 |
|
} |
|
290
|
1 |
|
|
|
291
|
|
|
/** |
|
292
|
|
|
* Handle the content delete migration action type |
|
293
|
|
|
*/ |
|
294
|
|
|
protected function delete() |
|
295
|
|
|
{ |
|
296
|
|
|
$contentService = $this->repository->getContentService(); |
|
297
|
|
|
|
|
298
|
|
|
$contentCollection = $this->matchContents('delete'); |
|
299
|
|
|
|
|
300
|
|
|
foreach ($contentCollection as $content) { |
|
|
|
|
|
|
301
|
|
|
try { |
|
302
|
3 |
|
$contentService->deleteContent($content->contentInfo); |
|
303
|
|
|
} catch (NotFoundException $e) { |
|
304
|
3 |
|
// Someone else (or even us, by virtue of location tree?) removed the content which we found just a |
|
305
|
2 |
|
// second ago. We can safely ignore this |
|
306
|
|
|
} |
|
307
|
|
|
} |
|
308
|
3 |
|
|
|
309
|
|
|
return $contentCollection; |
|
310
|
|
|
} |
|
311
|
|
|
|
|
312
|
|
|
/** |
|
313
|
|
|
* @param string $action |
|
314
|
|
|
* @return ContentCollection |
|
315
|
3 |
|
* @throws \Exception |
|
316
|
|
|
*/ |
|
317
|
3 |
View Code Duplication |
protected function matchContents($action) |
|
|
|
|
|
|
318
|
3 |
|
{ |
|
319
|
3 |
|
if (!isset($this->dsl['object_id']) && !isset($this->dsl['remote_id']) && !isset($this->dsl['match'])) { |
|
320
|
3 |
|
throw new \Exception("The ID or remote ID of an object or a Match Condition is required to $action a new location."); |
|
321
|
3 |
|
} |
|
322
|
3 |
|
|
|
323
|
2 |
|
// Backwards compat |
|
324
|
2 |
|
if (!isset($this->dsl['match'])) { |
|
325
|
2 |
|
if (isset($this->dsl['object_id'])) { |
|
326
|
1 |
|
$this->dsl['match'] = array('content_id' => $this->dsl['object_id']); |
|
327
|
1 |
|
} elseif (isset($this->dsl['remote_id'])) { |
|
328
|
1 |
|
$this->dsl['match'] = array('content_remote_id' => $this->dsl['remote_id']); |
|
329
|
1 |
|
} |
|
330
|
|
|
} |
|
331
|
|
|
|
|
332
|
|
|
$match = $this->dsl['match']; |
|
333
|
3 |
|
|
|
334
|
|
|
// convert the references passed in the match |
|
335
|
3 |
|
foreach ($match as $condition => $values) { |
|
336
|
3 |
|
if (is_array($values)) { |
|
337
|
|
|
foreach ($values as $position => $value) { |
|
338
|
3 |
|
$match[$condition][$position] = $this->referenceResolver->resolveReference($value); |
|
339
|
|
|
} |
|
340
|
|
|
} else { |
|
341
|
|
|
$match[$condition] = $this->referenceResolver->resolveReference($values); |
|
342
|
|
|
} |
|
343
|
|
|
} |
|
344
|
|
|
|
|
345
|
|
|
return $this->contentMatcher->match($match); |
|
346
|
|
|
} |
|
347
|
|
|
|
|
348
|
|
|
/** |
|
349
|
|
|
* Helper function to set the fields of a ContentCreateStruct based on the DSL attribute settings. |
|
350
|
|
|
* |
|
351
|
|
|
* @param ContentCreateStruct|ContentUpdateStruct $createOrUpdateStruct |
|
352
|
|
|
* @param ContentType $contentType |
|
353
|
|
|
* @param array $fields see description of expected format in code below |
|
354
|
|
|
* @throws \Exception |
|
355
|
|
|
*/ |
|
356
|
|
|
protected function setFields($createOrUpdateStruct, array $fields, ContentType $contentType) |
|
357
|
|
|
{ |
|
358
|
|
|
$i = 0; |
|
359
|
|
|
// the 'easy' yml: key = field name, value = value |
|
360
|
|
|
// deprecated: the 'legacy' yml: key = numerical index, value = array ( field name => value ) |
|
361
|
|
|
foreach ($fields as $key => $field) { |
|
362
|
|
|
|
|
363
|
|
|
if ($key === $i && is_array($field) && count($field) == 1) { |
|
364
|
|
|
// each $field is one key value pair |
|
365
|
|
|
// eg.: $field = array($fieldIdentifier => $fieldValue) |
|
|
|
|
|
|
366
|
|
|
reset($field); |
|
367
|
|
|
$fieldIdentifier = key($field); |
|
368
|
|
|
$fieldValue = $field[$fieldIdentifier]; |
|
369
|
|
|
} else { |
|
370
|
|
|
$fieldIdentifier = $key; |
|
371
|
|
|
$fieldValue = $field; |
|
372
|
|
|
} |
|
373
|
|
|
|
|
374
|
|
|
if (!isset($contentType->fieldDefinitionsByIdentifier[$fieldIdentifier])) { |
|
|
|
|
|
|
375
|
|
|
throw new \Exception("Field '$fieldIdentifier' is not present in field type '{$contentType->identifier}'"); |
|
376
|
|
|
} |
|
377
|
|
|
|
|
378
|
|
|
$fieldDefinition = $contentType->fieldDefinitionsByIdentifier[$fieldIdentifier]; |
|
|
|
|
|
|
379
|
|
|
$fieldValue = $this->getFieldValue($fieldValue, $fieldDefinition, $contentType->identifier, $this->context); |
|
380
|
|
|
|
|
381
|
|
|
$createOrUpdateStruct->setField($fieldIdentifier, $fieldValue, $this->getLanguageCode()); |
|
382
|
|
|
|
|
383
|
|
|
$i++; |
|
384
|
|
|
} |
|
385
|
|
|
} |
|
386
|
|
|
|
|
387
|
|
View Code Duplication |
protected function setSection(Content $content, $sectionKey) |
|
|
|
|
|
|
388
|
|
|
{ |
|
389
|
|
|
$sectionKey = $this->referenceResolver->resolveReference($sectionKey); |
|
390
|
|
|
$section = $this->sectionMatcher->matchOneByKey($sectionKey); |
|
391
|
|
|
|
|
392
|
|
|
$sectionService = $this->repository->getSectionService(); |
|
393
|
|
|
$sectionService->assignSection($content->contentInfo, $section); |
|
394
|
|
|
} |
|
395
|
|
|
|
|
396
|
|
|
protected function setObjectStates(Content $content, array $stateKeys) |
|
397
|
|
|
{ |
|
398
|
|
|
foreach ($stateKeys as $stateKey) { |
|
399
|
|
|
$stateKey = $this->referenceResolver->resolveReference($stateKey); |
|
400
|
|
|
/** @var \eZ\Publish\API\Repository\Values\ObjectState\ObjectState $state */ |
|
401
|
|
|
$state = $this->objectStateMatcher->matchOneByKey($stateKey); |
|
402
|
|
|
|
|
403
|
|
|
$stateService = $this->repository->getObjectStateService(); |
|
404
|
|
|
$stateService->setContentState($content->contentInfo, $state->getObjectStateGroup(), $state); |
|
405
|
|
|
} |
|
406
|
|
|
} |
|
407
|
|
|
|
|
408
|
|
|
/** |
|
409
|
|
|
* Create the field value from the migration definition hash |
|
410
|
|
|
* |
|
411
|
|
|
* @param mixed $value |
|
412
|
|
|
* @param FieldDefinition $fieldDefinition |
|
413
|
|
|
* @param string $contentTypeIdentifier |
|
414
|
|
|
* @param array $context |
|
415
|
|
|
* @throws \InvalidArgumentException |
|
416
|
|
|
* @return mixed |
|
417
|
|
|
*/ |
|
418
|
|
|
protected function getFieldValue($value, FieldDefinition $fieldDefinition, $contentTypeIdentifier, array $context = array()) |
|
419
|
|
|
{ |
|
420
|
|
|
$fieldTypeIdentifier = $fieldDefinition->fieldTypeIdentifier; |
|
421
|
|
|
if (is_array($value) || $this->complexFieldManager->managesField($fieldTypeIdentifier, $contentTypeIdentifier)) { |
|
422
|
|
|
// inject info about the current content type and field into the context |
|
423
|
|
|
$context['contentTypeIdentifier'] = $contentTypeIdentifier; |
|
424
|
|
|
$context['fieldIdentifier'] = $fieldDefinition->identifier; |
|
425
|
|
|
return $this->complexFieldManager->hashToFieldValue($fieldTypeIdentifier, $contentTypeIdentifier, $value, $context); |
|
426
|
|
|
} |
|
427
|
|
|
|
|
428
|
|
|
return $this->getSingleFieldValue($value, $fieldDefinition, $contentTypeIdentifier, $context); |
|
429
|
|
|
} |
|
430
|
|
|
|
|
431
|
|
|
/** |
|
432
|
|
|
* Create the field value for a primitive field from the migration definition hash |
|
433
|
|
|
* |
|
434
|
|
|
* @param mixed $value |
|
435
|
|
|
* @param FieldDefinition $fieldDefinition |
|
436
|
|
|
* @param string $contentTypeIdentifier |
|
437
|
|
|
* @param array $context |
|
438
|
|
|
* @throws \InvalidArgumentException |
|
439
|
|
|
* @return mixed |
|
440
|
|
|
*/ |
|
441
|
|
|
protected function getSingleFieldValue($value, FieldDefinition $fieldDefinition, $contentTypeIdentifier, array $context = array()) |
|
|
|
|
|
|
442
|
|
|
{ |
|
443
|
|
|
// booleans were handled here. They are now handled as complextypes |
|
444
|
|
|
|
|
445
|
|
|
// q: do we really want this to happen by default on all scalar field values? |
|
446
|
|
|
// Note: if you want this *not* to happen, register a complex field for your scalar field... |
|
447
|
|
|
$value = $this->referenceResolver->resolveReference($value); |
|
448
|
|
|
|
|
449
|
|
|
return $value; |
|
450
|
|
|
} |
|
451
|
|
|
|
|
452
|
|
|
/** |
|
453
|
|
|
* Load user using either login, email, id - resolving eventual references |
|
454
|
|
|
* @param int|string $userKey |
|
455
|
|
|
* @return \eZ\Publish\API\Repository\Values\User\User |
|
456
|
|
|
*/ |
|
457
|
|
|
protected function getUser($userKey) |
|
458
|
|
|
{ |
|
459
|
|
|
$userKey = $this->referenceResolver->resolveReference($userKey); |
|
460
|
|
|
return $this->userMatcher->matchOneByKey($userKey); |
|
461
|
|
|
} |
|
462
|
|
|
|
|
463
|
|
|
/** |
|
464
|
|
|
* Sets references to certain content attributes. |
|
465
|
|
|
* |
|
466
|
|
|
* @param \eZ\Publish\API\Repository\Values\Content\Content|ContentCollection $content |
|
467
|
|
|
* @throws \InvalidArgumentException When trying to set a reference to an unsupported attribute |
|
468
|
|
|
* @return boolean |
|
469
|
|
|
* |
|
470
|
|
|
* @todo add support for other attributes: contentTypeId, contentTypeIdentifier, section, etc... ? |
|
471
|
|
|
*/ |
|
472
|
|
|
protected function setReferences($content) |
|
473
|
|
|
{ |
|
474
|
|
|
if (!array_key_exists('references', $this->dsl)) { |
|
475
|
|
|
return false; |
|
476
|
|
|
} |
|
477
|
|
|
|
|
478
|
|
|
if ($content instanceof ContentCollection) { |
|
479
|
|
|
if (count($content) > 1) { |
|
480
|
|
|
throw new \InvalidArgumentException('Content Manager does not support setting references for creating/updating of multiple contents'); |
|
481
|
|
|
} |
|
482
|
|
|
$content = reset($content); |
|
483
|
|
|
} |
|
484
|
|
|
|
|
485
|
|
|
foreach ($this->dsl['references'] as $reference) { |
|
486
|
|
|
|
|
487
|
|
|
switch ($reference['attribute']) { |
|
488
|
|
|
case 'object_id': |
|
489
|
|
|
case 'content_id': |
|
490
|
|
|
case 'id': |
|
491
|
|
|
$value = $content->id; |
|
492
|
|
|
break; |
|
493
|
|
|
case 'remote_id': |
|
494
|
|
|
case 'content_remote_id': |
|
495
|
|
|
$value = $content->contentInfo->remoteId; |
|
496
|
|
|
break; |
|
497
|
|
|
case 'always_available': |
|
498
|
|
|
$value = $content->contentInfo->alwaysAvailable; |
|
499
|
|
|
break; |
|
500
|
|
|
case 'content_type_id': |
|
501
|
|
|
$value = $content->contentInfo->contentTypeId; |
|
502
|
|
|
break; |
|
503
|
|
View Code Duplication |
case 'content_type_identifier': |
|
|
|
|
|
|
504
|
|
|
$contentTypeService = $this->repository->getContentTypeService(); |
|
505
|
|
|
$value = $contentTypeService->loadContentType($content->contentInfo->contentTypeId)->identifier; |
|
506
|
|
|
break; |
|
507
|
|
|
case 'current_version': |
|
508
|
|
|
case 'current_version_no': |
|
509
|
|
|
$value = $content->contentInfo->currentVersionNo; |
|
510
|
|
|
break; |
|
511
|
|
|
case 'location_id': |
|
512
|
|
|
case 'main_location_id': |
|
513
|
|
|
$value = $content->contentInfo->mainLocationId; |
|
514
|
|
|
break; |
|
515
|
|
|
case 'main_language_code': |
|
516
|
|
|
$value = $content->contentInfo->mainLanguageCode; |
|
517
|
|
|
break; |
|
518
|
|
|
case 'modification_date': |
|
519
|
|
|
$value = $content->contentInfo->modificationDate->getTimestamp(); |
|
520
|
|
|
break; |
|
521
|
|
|
case 'name': |
|
522
|
|
|
$value = $content->contentInfo->name; |
|
523
|
|
|
break; |
|
524
|
|
|
case 'owner_id': |
|
525
|
|
|
$value = $content->contentInfo->ownerId; |
|
526
|
|
|
break; |
|
527
|
|
|
case 'path': |
|
528
|
|
|
$locationService = $this->repository->getLocationService(); |
|
529
|
|
|
$value = $locationService->loadLocation($content->contentInfo->mainLocationId)->pathString; |
|
530
|
|
|
break; |
|
531
|
|
|
case 'publication_date': |
|
532
|
|
|
$value = $content->contentInfo->publishedDate->getTimestamp(); |
|
533
|
|
|
break; |
|
534
|
|
|
case 'section_id': |
|
535
|
|
|
$value = $content->contentInfo->sectionId; |
|
536
|
|
|
break; |
|
537
|
|
|
default: |
|
538
|
|
|
throw new \InvalidArgumentException('Content Manager does not support setting references for attribute ' . $reference['attribute']); |
|
539
|
|
|
} |
|
540
|
|
|
|
|
541
|
|
|
$this->referenceResolver->addReference($reference['identifier'], $value); |
|
|
|
|
|
|
542
|
|
|
} |
|
543
|
|
|
|
|
544
|
|
|
return true; |
|
545
|
|
|
} |
|
546
|
|
|
|
|
547
|
|
|
/** |
|
548
|
|
|
* @param int|string $date if integer, we assume a timestamp |
|
549
|
|
|
* @return \DateTime |
|
550
|
|
|
*/ |
|
551
|
|
|
protected function toDateTime($date) |
|
552
|
|
|
{ |
|
553
|
|
|
if (is_int($date)) { |
|
554
|
|
|
return new \DateTime("@" . $date); |
|
555
|
|
|
} else { |
|
556
|
|
|
return new \DateTime($date); |
|
557
|
|
|
} |
|
558
|
|
|
} |
|
559
|
|
|
|
|
560
|
|
|
/** |
|
561
|
|
|
* @param array $matchCondition |
|
562
|
|
|
* @param string $mode |
|
563
|
|
|
* @throws \Exception |
|
564
|
|
|
* @return array |
|
565
|
|
|
* |
|
566
|
|
|
* @todo add support for dumping all object languages |
|
567
|
|
|
* @todo add 2ndary locations when in 'update' mode |
|
568
|
|
|
* @todo add dumping of sort_field and sort_order for 2ndary locations |
|
569
|
|
|
*/ |
|
570
|
|
|
public function generateMigration(array $matchCondition, $mode) |
|
571
|
|
|
{ |
|
572
|
|
|
$previousUserId = $this->loginUser(self::ADMIN_USER_ID); |
|
573
|
|
|
$contentCollection = $this->contentMatcher->match($matchCondition); |
|
574
|
|
|
$data = array(); |
|
575
|
|
|
|
|
576
|
|
|
/** @var \eZ\Publish\API\Repository\Values\Content\Content $content */ |
|
577
|
|
|
foreach ($contentCollection as $content) { |
|
|
|
|
|
|
578
|
|
|
|
|
579
|
|
|
$location = $this->repository->getLocationService()->loadLocation($content->contentInfo->mainLocationId); |
|
580
|
|
|
$contentType = $this->repository->getContentTypeService()->loadContentType( |
|
581
|
|
|
$content->contentInfo->contentTypeId |
|
582
|
|
|
); |
|
583
|
|
|
|
|
584
|
|
|
$contentData = array( |
|
585
|
|
|
'type' => reset($this->supportedStepTypes), |
|
586
|
|
|
'mode' => $mode |
|
587
|
|
|
); |
|
588
|
|
|
|
|
589
|
|
|
switch ($mode) { |
|
590
|
|
|
case 'create': |
|
591
|
|
|
$contentData = array_merge( |
|
592
|
|
|
$contentData, |
|
593
|
|
|
array( |
|
594
|
|
|
'content_type' => $contentType->identifier, |
|
595
|
|
|
'parent_location' => $location->parentLocationId, |
|
596
|
|
|
'priority' => $location->priority, |
|
597
|
|
|
'is_hidden' => $location->invisible, |
|
598
|
|
|
'sort_field' => $this->sortConverter->sortField2Hash($location->sortField), |
|
599
|
|
|
'sort_order' => $this->sortConverter->sortOrder2Hash($location->sortOrder), |
|
600
|
|
|
'remote_id' => $content->contentInfo->remoteId, |
|
601
|
|
|
'location_remote_id' => $location->remoteId |
|
602
|
|
|
) |
|
603
|
|
|
); |
|
604
|
|
|
$locationService = $this->repository->getLocationService(); |
|
605
|
|
|
$locations = $locationService->loadLocations($content->contentInfo); |
|
606
|
|
|
if (count($locations) > 1) { |
|
607
|
|
|
$otherParentLocations = array(); |
|
608
|
|
|
foreach($locations as $otherLocation) { |
|
609
|
|
|
if ($otherLocation->id != $location->id) { |
|
610
|
|
|
$otherParentLocations[] = $otherLocation->parentLocationId; |
|
611
|
|
|
} |
|
612
|
|
|
} |
|
613
|
|
|
$contentData['other_parent_locations'] = $otherParentLocations; |
|
614
|
|
|
} |
|
615
|
|
|
break; |
|
616
|
|
View Code Duplication |
case 'update': |
|
|
|
|
|
|
617
|
|
|
$contentData = array_merge( |
|
618
|
|
|
$contentData, |
|
619
|
|
|
array( |
|
620
|
|
|
'match' => array( |
|
621
|
|
|
ContentMatcher::MATCH_CONTENT_REMOTE_ID => $content->contentInfo->remoteId |
|
622
|
|
|
), |
|
623
|
|
|
'new_remote_id' => $content->contentInfo->remoteId, |
|
624
|
|
|
) |
|
625
|
|
|
); |
|
626
|
|
|
break; |
|
627
|
|
View Code Duplication |
case 'delete': |
|
|
|
|
|
|
628
|
|
|
$contentData = array_merge( |
|
629
|
|
|
$contentData, |
|
630
|
|
|
array( |
|
631
|
|
|
'match' => array( |
|
632
|
|
|
ContentMatcher::MATCH_CONTENT_REMOTE_ID => $content->contentInfo->remoteId |
|
633
|
|
|
) |
|
634
|
|
|
) |
|
635
|
|
|
); |
|
636
|
|
|
break; |
|
637
|
|
|
default: |
|
638
|
|
|
throw new \Exception("Executor 'content' doesn't support mode '$mode'"); |
|
639
|
|
|
} |
|
640
|
|
|
|
|
641
|
|
|
if ($mode != 'delete') { |
|
642
|
|
|
|
|
643
|
|
|
$attributes = array(); |
|
644
|
|
|
foreach ($content->getFieldsByLanguage($this->getLanguageCode()) as $fieldIdentifier => $field) { |
|
645
|
|
|
$fieldDefinition = $contentType->getFieldDefinition($fieldIdentifier); |
|
646
|
|
|
$attributes[$field->fieldDefIdentifier] = $this->complexFieldManager->fieldValueToHash( |
|
647
|
|
|
$fieldDefinition->fieldTypeIdentifier, $contentType->identifier, $field->value |
|
648
|
|
|
); |
|
649
|
|
|
} |
|
650
|
|
|
|
|
651
|
|
|
$contentData = array_merge( |
|
652
|
|
|
$contentData, |
|
653
|
|
|
array( |
|
654
|
|
|
'lang' => $this->getLanguageCode(), |
|
655
|
|
|
'section' => $content->contentInfo->sectionId, |
|
656
|
|
|
'owner' => $content->contentInfo->ownerId, |
|
657
|
|
|
'modification_date' => $content->contentInfo->modificationDate->getTimestamp(), |
|
658
|
|
|
'publication_date' => $content->contentInfo->publishedDate->getTimestamp(), |
|
659
|
|
|
'always_available' => (bool)$content->contentInfo->alwaysAvailable, |
|
660
|
|
|
'attributes' => $attributes |
|
661
|
|
|
) |
|
662
|
|
|
); |
|
663
|
|
|
} |
|
664
|
|
|
|
|
665
|
|
|
$data[] = $contentData; |
|
666
|
|
|
} |
|
667
|
|
|
|
|
668
|
|
|
$this->loginUser($previousUserId); |
|
669
|
|
|
return $data; |
|
670
|
|
|
} |
|
671
|
|
|
} |
|
672
|
|
|
|
kaliop-uk /
ezmigrationbundle
Loading history...
Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.
You can also find more detailed suggestions in the “Code” section of your repository.