-
Notifications
You must be signed in to change notification settings - Fork 206
/
ContentService.php
468 lines (435 loc) · 23.6 KB
/
ContentService.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
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
<?php
/**
* File containing the eZ\Publish\API\Repository\ContentService 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\API\Repository;
use eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct;
use eZ\Publish\API\Repository\Values\ContentType\ContentType;
use eZ\Publish\API\Repository\Values\Content\TranslationInfo;
use eZ\Publish\API\Repository\Values\Content\TranslationValues;
use eZ\Publish\API\Repository\Values\Content\ContentCreateStruct;
use eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct;
use eZ\Publish\API\Repository\Values\Content\VersionInfo;
use eZ\Publish\API\Repository\Values\Content\ContentInfo;
use eZ\Publish\API\Repository\Values\User\User;
use eZ\Publish\API\Repository\Values\Content\LocationCreateStruct;
/**
* This class provides service methods for managing content.
*
* @example Examples/content.php
*/
interface ContentService
{
/**
* Loads a content info object.
*
* To load fields use loadContent
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the content
* @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given id does not exist
*
* @param int $contentId
*
* @return \eZ\Publish\API\Repository\Values\Content\ContentInfo
*/
public function loadContentInfo($contentId);
/**
* Loads a content info object for the given remoteId.
*
* To load fields use loadContent
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the content
* @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given remote id does not exist
*
* @param string $remoteId
*
* @return \eZ\Publish\API\Repository\Values\Content\ContentInfo
*/
public function loadContentInfoByRemoteId($remoteId);
/**
* Loads a version info of the given content object.
*
* If no version number is given, the method returns the current version
*
* @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the version with the given number does not exist
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
*
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
* @param int $versionNo the version number. If not given the current version is returned.
*
* @return \eZ\Publish\API\Repository\Values\Content\VersionInfo
*/
public function loadVersionInfo(ContentInfo $contentInfo, $versionNo = null);
/**
* Loads a version info of the given content object id.
*
* If no version number is given, the method returns the current version
*
* @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the version with the given number does not exist
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
*
* @param mixed $contentId
* @param int $versionNo the version number. If not given the current version is returned.
*
* @return \eZ\Publish\API\Repository\Values\Content\VersionInfo
*/
public function loadVersionInfoById($contentId, $versionNo = null);
/**
* Loads content in a version for the given content info object.
*
* If no version number is given, the method returns the current version
*
* @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if version with the given number does not exist
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
*
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
* @param array $languages A language priority, filters returned fields and is used as prioritized language code on
* returned value object. If not given all languages are returned.
* @param int $versionNo the version number. If not given the current version is returned from $contentInfo
* @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true
*
* @return \eZ\Publish\API\Repository\Values\Content\Content
*/
public function loadContentByContentInfo(ContentInfo $contentInfo, array $languages = null, $versionNo = null, $useAlwaysAvailable = true);
/**
* Loads content in the version given by version info.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
*
* @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
* @param array $languages A language priority, filters returned fields and is used as prioritized language code on
* returned value object. If not given all languages are returned.
* @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true
*
* @return \eZ\Publish\API\Repository\Values\Content\Content
*/
public function loadContentByVersionInfo(VersionInfo $versionInfo, array $languages = null, $useAlwaysAvailable = true);
/**
* Loads content in a version of the given content object.
*
* If no version number is given, the method returns the current version
*
* @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if the content or version with the given id and languages does not exist
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException If the user has no access to read content and in case of un-published content: read versions
*
* @param mixed $contentId
* @param array $languages A language priority, filters returned fields and is used as prioritized language code on
* returned value object. If not given all languages are returned.
* @param int $versionNo the version number. If not given the current version is returned
* @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true
*
* @return \eZ\Publish\API\Repository\Values\Content\Content
*/
public function loadContent($contentId, array $languages = null, $versionNo = null, $useAlwaysAvailable = true);
/**
* Loads content in a version for the content object reference by the given remote id.
*
* If no version is given, the method returns the current version
*
* @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content or version with the given remote id does not exist
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException If the user has no access to read content and in case of un-published content: read versions
*
* @param string $remoteId
* @param array $languages A language priority, filters returned fields and is used as prioritized language code on
* returned value object. If not given all languages are returned.
* @param int $versionNo the version number. If not given the current version is returned
* @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true
*
* @return \eZ\Publish\API\Repository\Values\Content\Content
*/
public function loadContentByRemoteId($remoteId, array $languages = null, $versionNo = null, $useAlwaysAvailable = true);
/**
* Creates a new content draft assigned to the authenticated user.
*
* If a different userId is given in $contentCreateStruct it is assigned to the given user
* but this required special rights for the authenticated user
* (this is useful for content staging where the transfer process does not
* have to authenticate with the user which created the content object in the source server).
* The user has to publish the draft if it should be visible.
* In 4.x at least one location has to be provided in the location creation array.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to create the content in the given location
* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if there is a provided remoteId which exists in the system
* or there is no location provided (4.x) or multiple locations
* are under the same parent or if the a field value is not accepted by the field type
* @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $contentCreateStruct is not valid
* @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is missing or is set to an empty value
*
* @param \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct $contentCreateStruct
* @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct[] $locationCreateStructs an array of {@link \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct} for each location parent under which a location should be created for the content
*
* @return \eZ\Publish\API\Repository\Values\Content\Content - the newly created content draft
*/
public function createContent(ContentCreateStruct $contentCreateStruct, array $locationCreateStructs = array());
/**
* Updates the metadata.
*
* (see {@link ContentMetadataUpdateStruct}) of a content object - to update fields use updateContent
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to update the content meta data
* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the remoteId in $contentMetadataUpdateStruct is set but already exists
*
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
* @param \eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct $contentMetadataUpdateStruct
*
* @return \eZ\Publish\API\Repository\Values\Content\Content the content with the updated attributes
*/
public function updateContentMetadata(ContentInfo $contentInfo, ContentMetadataUpdateStruct $contentMetadataUpdateStruct);
/**
* Deletes a content object including all its versions and locations including their subtrees.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to delete the content (in one of the locations of the given content object)
*
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
*
* @return mixed[] Affected Location Id's (List of Locations of the Content that was deleted)
*/
public function deleteContent(ContentInfo $contentInfo);
/**
* Creates a draft from a published or archived version.
*
* If no version is given, the current published version is used.
* 4.x: The draft is created with the initialLanguage code of the source version or if not present with the main language.
* It can be changed on updating the version.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the current-user is not allowed to create the draft
*
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
* @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
* @param \eZ\Publish\API\Repository\Values\User\User $creator Used as creator of the draft if given - otherwise uses current-user
*
* @return \eZ\Publish\API\Repository\Values\Content\Content - the newly created content draft
*/
public function createContentDraft(ContentInfo $contentInfo, VersionInfo $versionInfo = null, User $creator = null);
/**
* Loads drafts for a user.
*
* If no user is given the drafts for the authenticated user a returned
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the current-user is not allowed to load the draft list
*
* @param \eZ\Publish\API\Repository\Values\User\User $user The user to load drafts from if defined, otherwise drafts for current-user
*
* @return \eZ\Publish\API\Repository\Values\Content\VersionInfo[] the drafts ({@link VersionInfo}) owned by the given user
*/
public function loadContentDrafts(User $user = null);
/**
* Translate a version.
*
* updates the destination version given in $translationInfo with the provided translated fields in $translationValues
*
* @example Examples/translation_5x.php
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the current-user is not allowed to update this version
* @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the given destination version is not a draft
* @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is set to an empty value
* @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $translationValues is not valid
*
* @param \eZ\Publish\API\Repository\Values\Content\TranslationInfo $translationInfo
* @param \eZ\Publish\API\Repository\Values\Content\TranslationValues $translationValues
* @param \eZ\Publish\API\Repository\Values\User\User $modifier Taken as modifier of the version, otherwise current-user is used
*
* @return \eZ\Publish\API\Repository\Values\Content\Content the content draft with the translated fields
*
* @since 5.0
* @deprecated Never implemented, and might be redesigned if it ever is.
*/
public function translateVersion(TranslationInfo $translationInfo, TranslationValues $translationValues, User $modifier = null);
/**
* Updates the fields of a draft.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to update this version
* @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
* @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $contentUpdateStruct is not valid
* @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is set to an empty value
* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if a field value is not accepted by the field type
*
* @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
* @param \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct $contentUpdateStruct
*
* @return \eZ\Publish\API\Repository\Values\Content\Content the content draft with the updated fields
*/
public function updateContent(VersionInfo $versionInfo, ContentUpdateStruct $contentUpdateStruct);
/**
* Publishes a content version.
*
* Publishes a content version and deletes archive versions if they overflow max archive versions.
* Max archive versions are currently a configuration for default max limit, by default set to 5.
* @todo Introduce null|int ContentType->versionArchiveLimit to be able to let admins override this per type.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to publish this version
* @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
*
* @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
*
* @return \eZ\Publish\API\Repository\Values\Content\Content
*/
public function publishVersion(VersionInfo $versionInfo);
/**
* Removes the given version.
*
* @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is in
* published state or is a last version of the Content
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to remove this version
*
* @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
*/
public function deleteVersion(VersionInfo $versionInfo);
/**
* Loads all versions for the given content.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to list versions
*
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
*
* @return \eZ\Publish\API\Repository\Values\Content\VersionInfo[] an array of {@link \eZ\Publish\API\Repository\Values\Content\VersionInfo} sorted by creation date
*/
public function loadVersions(ContentInfo $contentInfo);
/**
* Copies the content to a new location. If no version is given,
* all versions are copied, otherwise only the given version.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to copy the content to the given location
*
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
* @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct $destinationLocationCreateStruct the target location where the content is copied to
* @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
*
* @return \eZ\Publish\API\Repository\Values\Content\Content
*/
public function copyContent(ContentInfo $contentInfo, LocationCreateStruct $destinationLocationCreateStruct, VersionInfo $versionInfo = null);
/**
* Loads all outgoing relations for the given version.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read this version
*
* @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
*
* @return \eZ\Publish\API\Repository\Values\Content\Relation[]
*/
public function loadRelations(VersionInfo $versionInfo);
/**
* Loads all incoming relations for a content object.
*
* The relations come only from published versions of the source content objects
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read this version
*
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
*
* @return \eZ\Publish\API\Repository\Values\Content\Relation[]
*/
public function loadReverseRelations(ContentInfo $contentInfo);
/**
* Adds a relation of type common.
*
* The source of the relation is the content and version
* referenced by $versionInfo.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to edit this version
* @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
*
* @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $sourceVersion
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $destinationContent the destination of the relation
*
* @return \eZ\Publish\API\Repository\Values\Content\Relation the newly created relation
*/
public function addRelation(VersionInfo $sourceVersion, ContentInfo $destinationContent);
/**
* Removes a relation of type COMMON from a draft.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed edit this version
* @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if there is no relation of type COMMON for the given destination
*
* @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $sourceVersion
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $destinationContent
*/
public function deleteRelation(VersionInfo $sourceVersion, ContentInfo $destinationContent);
/**
* Adds translation information to the content object.
*
* @example Examples/translation_5x.php
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed add a translation info
*
* @param \eZ\Publish\API\Repository\Values\Content\TranslationInfo $translationInfo
*
* @since 5.0
* @deprecated Never implemented, and might be redesigned if it ever is.
*/
public function addTranslationInfo(TranslationInfo $translationInfo);
/**
* lists the translations done on this content object.
*
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed read translation infos
*
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
* @param array $filter
*
* @todo TBD - filter by sourceversion destination version and languages
*
* @return \eZ\Publish\API\Repository\Values\Content\TranslationInfo[]
*
* @since 5.0
* @deprecated Never implemented, and might be redesigned if it ever is.
*/
public function loadTranslationInfos(ContentInfo $contentInfo, array $filter = array());
/**
* Remove Content Object translation from all Versions (including archived ones) of a Content Object.
*
* NOTE: this operation is risky and permanent, so user interface (ideally CLI) should provide
* a warning before performing it.
*
* @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the specified translation
* is the only one a Version has or it is the main translation of a Content Object.
* @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed
* to delete the content (in one of the locations of the given Content Object).
* @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if languageCode argument
* is invalid for the given content.
*
* @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
* @param string $languageCode
*
* @since 6.11
*/
public function removeTranslation(ContentInfo $contentInfo, $languageCode);
/**
* Instantiates a new content create struct object.
*
* alwaysAvailable is set to the ContentType's defaultAlwaysAvailable
*
* @param \eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType
* @param string $mainLanguageCode
*
* @return \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct
*/
public function newContentCreateStruct(ContentType $contentType, $mainLanguageCode);
/**
* Instantiates a new content meta data update struct.
*
* @return \eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct
*/
public function newContentMetadataUpdateStruct();
/**
* Instantiates a new content update struct.
*
* @return \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct
*/
public function newContentUpdateStruct();
/**
* Instantiates a new TranslationInfo object.
*
* @return \eZ\Publish\API\Repository\Values\Content\TranslationInfo
*/
public function newTranslationInfo();
/**
* Instantiates a Translation object.
*
* @return \eZ\Publish\API\Repository\Values\Content\TranslationValues
*/
public function newTranslationValues();
}