Completed
Push — EZP-30969-fetch-reverse-relati... ( d71d24...a0ef69 )
by
unknown
137:48 queued 117:08
created

ContentService::countReverseRelations()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
c 0
b 0
f 0
cc 1
nc 1
nop 1
rs 10
1
<?php
2
3
/**
4
 * ContentService class.
5
 *
6
 * @copyright Copyright (C) eZ Systems AS. All rights reserved.
7
 * @license For full copyright and license information view LICENSE file distributed with this source code.
8
 */
9
namespace eZ\Publish\Core\SignalSlot;
10
11
use eZ\Publish\API\Repository\ContentService as ContentServiceInterface;
12
use eZ\Publish\API\Repository\Values\Content\ContentCreateStruct;
13
use eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct;
14
use eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct;
15
use eZ\Publish\API\Repository\Values\Content\Language;
16
use eZ\Publish\API\Repository\Values\Content\LocationCreateStruct;
17
use eZ\Publish\API\Repository\Values\Content\ContentInfo;
18
use eZ\Publish\API\Repository\Values\Content\RelationList;
19
use eZ\Publish\API\Repository\Values\Content\VersionInfo;
20
use eZ\Publish\API\Repository\Values\ContentType\ContentType;
21
use eZ\Publish\API\Repository\Values\User\User;
22
use eZ\Publish\Core\SignalSlot\Signal\ContentService\CreateContentSignal;
23
use eZ\Publish\Core\SignalSlot\Signal\ContentService\DeleteTranslationSignal;
24
use eZ\Publish\Core\SignalSlot\Signal\ContentService\HideContentSignal;
25
use eZ\Publish\Core\SignalSlot\Signal\ContentService\RemoveTranslationSignal;
26
use eZ\Publish\Core\SignalSlot\Signal\ContentService\RevealContentSignal;
27
use eZ\Publish\Core\SignalSlot\Signal\ContentService\UpdateContentMetadataSignal;
28
use eZ\Publish\Core\SignalSlot\Signal\ContentService\DeleteContentSignal;
29
use eZ\Publish\Core\SignalSlot\Signal\ContentService\CreateContentDraftSignal;
30
use eZ\Publish\Core\SignalSlot\Signal\ContentService\UpdateContentSignal;
31
use eZ\Publish\Core\SignalSlot\Signal\ContentService\PublishVersionSignal;
32
use eZ\Publish\Core\SignalSlot\Signal\ContentService\DeleteVersionSignal;
33
use eZ\Publish\Core\SignalSlot\Signal\ContentService\CopyContentSignal;
34
use eZ\Publish\Core\SignalSlot\Signal\ContentService\AddRelationSignal;
35
use eZ\Publish\Core\SignalSlot\Signal\ContentService\DeleteRelationSignal;
36
37
/**
38
 * ContentService class.
39
 */
40
class ContentService implements ContentServiceInterface
41
{
42
    /**
43
     * Aggregated service.
44
     *
45
     * @var \eZ\Publish\API\Repository\ContentService
46
     */
47
    protected $service;
48
49
    /**
50
     * SignalDispatcher.
51
     *
52
     * @var \eZ\Publish\Core\SignalSlot\SignalDispatcher
53
     */
54
    protected $signalDispatcher;
55
56
    /**
57
     * Constructor.
58
     *
59
     * Construct service object from aggregated service and signal
60
     * dispatcher
61
     *
62
     * @param \eZ\Publish\API\Repository\ContentService $service
63
     * @param \eZ\Publish\Core\SignalSlot\SignalDispatcher $signalDispatcher
64
     */
65
    public function __construct(ContentServiceInterface $service, SignalDispatcher $signalDispatcher)
66
    {
67
        $this->service = $service;
68
        $this->signalDispatcher = $signalDispatcher;
69
    }
70
71
    /**
72
     * Loads a content info object.
73
     *
74
     * To load fields use loadContent
75
     *
76
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the content
77
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given id does not exist
78
     *
79
     * @param int $contentId
80
     *
81
     * @return \eZ\Publish\API\Repository\Values\Content\ContentInfo
82
     */
83
    public function loadContentInfo($contentId)
84
    {
85
        return $this->service->loadContentInfo($contentId);
86
    }
87
88
    /**
89
     * {@inheritdoc}
90
     */
91
    public function loadContentInfoList(array $contentIds): iterable
92
    {
93
        return $this->service->loadContentInfoList($contentIds);
94
    }
95
96
    /**
97
     * Loads a content info object for the given remoteId.
98
     *
99
     * To load fields use loadContent
100
     *
101
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the content
102
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given remote id does not exist
103
     *
104
     * @param string $remoteId
105
     *
106
     * @return \eZ\Publish\API\Repository\Values\Content\ContentInfo
107
     */
108
    public function loadContentInfoByRemoteId($remoteId)
109
    {
110
        return $this->service->loadContentInfoByRemoteId($remoteId);
111
    }
112
113
    /**
114
     * Loads a version info of the given content object.
115
     *
116
     * If no version number is given, the method returns the current version
117
     *
118
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the version with the given number does not exist
119
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
120
     *
121
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
122
     * @param int $versionNo the version number. If not given the current version is returned.
123
     *
124
     * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo
125
     */
126
    public function loadVersionInfo(ContentInfo $contentInfo, $versionNo = null)
127
    {
128
        return $this->service->loadVersionInfo($contentInfo, $versionNo);
129
    }
130
131
    /**
132
     * Loads a version info of the given content object id.
133
     *
134
     * If no version number is given, the method returns the current version
135
     *
136
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the version with the given number does not exist
137
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
138
     *
139
     * @param mixed $contentId
140
     * @param int $versionNo the version number. If not given the current version is returned.
141
     *
142
     * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo
143
     */
144
    public function loadVersionInfoById($contentId, $versionNo = null)
145
    {
146
        return $this->service->loadVersionInfoById($contentId, $versionNo);
147
    }
148
149
    /**
150
     * Loads content in a version for the given content info object.
151
     *
152
     * If no version number is given, the method returns the current version
153
     *
154
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if version with the given number does not exist
155
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
156
     *
157
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
158
     * @param array $languages A language filter for fields. If not given all languages are returned
159
     * @param int $versionNo the version number. If not given the current version is returned
160
     * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true
161
     *
162
     * @return \eZ\Publish\API\Repository\Values\Content\Content
163
     */
164
    public function loadContentByContentInfo(ContentInfo $contentInfo, array $languages = null, $versionNo = null, $useAlwaysAvailable = true)
165
    {
166
        return $this->service->loadContentByContentInfo($contentInfo, $languages, $versionNo, $useAlwaysAvailable);
167
    }
168
169
    /**
170
     * Loads content in the version given by version info.
171
     *
172
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
173
     *
174
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
175
     * @param array $languages A language filter for fields. If not given all languages are returned
176
     * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true
177
     *
178
     * @return \eZ\Publish\API\Repository\Values\Content\Content
179
     */
180
    public function loadContentByVersionInfo(VersionInfo $versionInfo, array $languages = null, $useAlwaysAvailable = true)
181
    {
182
        return $this->service->loadContentByVersionInfo($versionInfo, $languages, $useAlwaysAvailable);
183
    }
184
185
    /**
186
     * Loads content in a version of the given content object.
187
     *
188
     * If no version number is given, the method returns the current version
189
     *
190
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if the content or version with the given id and languages does not exist
191
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
192
     *
193
     * @param int $contentId
194
     * @param array $languages A language filter for fields. If not given all languages are returned
195
     * @param int $versionNo the version number. If not given the current version is returned
196
     * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true
197
     *
198
     * @return \eZ\Publish\API\Repository\Values\Content\Content
199
     */
200
    public function loadContent($contentId, array $languages = null, $versionNo = null, $useAlwaysAvailable = true)
201
    {
202
        return $this->service->loadContent($contentId, $languages, $versionNo, $useAlwaysAvailable);
203
    }
204
205
    /**
206
     * Loads content in a version for the content object reference by the given remote id.
207
     *
208
     * If no version is given, the method returns the current version
209
     *
210
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content or version with the given remote id does not exist
211
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
212
     *
213
     * @param string $remoteId
214
     * @param array $languages A language filter for fields. If not given all languages are returned
215
     * @param int $versionNo the version number. If not given the current version is returned
216
     * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true
217
     *
218
     * @return \eZ\Publish\API\Repository\Values\Content\Content
219
     */
220
    public function loadContentByRemoteId($remoteId, array $languages = null, $versionNo = null, $useAlwaysAvailable = true)
221
    {
222
        return $this->service->loadContentByRemoteId($remoteId, $languages, $versionNo, $useAlwaysAvailable);
223
    }
224
225
    /**
226
     * Creates a new content draft assigned to the authenticated user.
227
     *
228
     * If a different userId is given in $contentCreateStruct it is assigned to the given user
229
     * but this required special rights for the authenticated user
230
     * (this is useful for content staging where the transfer process does not
231
     * have to authenticate with the user which created the content object in the source server).
232
     * The user has to publish the draft if it should be visible.
233
     * In 4.x at least one location has to be provided in the location creation array.
234
     *
235
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to create the content in the given location
236
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if there is a provided remoteId which exists in the system
237
     *                                                                        or there is no location provided (4.x) or multiple locations
238
     *                                                                        are under the same parent or if the a field value is not accepted by the field type
239
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $contentCreateStruct is not valid
240
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is missing or is set to an empty value
241
     *
242
     * @param \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct $contentCreateStruct
243
     * @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct[] $locationCreateStructs For each location parent under which a location should be created for the content
244
     *
245
     * @return \eZ\Publish\API\Repository\Values\Content\Content - the newly created content draft
246
     */
247
    public function createContent(ContentCreateStruct $contentCreateStruct, array $locationCreateStructs = [])
248
    {
249
        $returnValue = $this->service->createContent($contentCreateStruct, $locationCreateStructs);
250
        $this->signalDispatcher->emit(
251
            new CreateContentSignal(
252
                [
253
                    'contentId' => $returnValue->getVersionInfo()->getContentInfo()->id,
254
                    'versionNo' => $returnValue->getVersionInfo()->versionNo,
255
                ]
256
            )
257
        );
258
259
        return $returnValue;
260
    }
261
262
    /**
263
     * Updates the metadata.
264
     *
265
     * (see {@link ContentMetadataUpdateStruct}) of a content object - to update fields use updateContent
266
     *
267
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to update the content meta data
268
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the remoteId in $contentMetadataUpdateStruct is set but already exists
269
     *
270
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
271
     * @param \eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct $contentMetadataUpdateStruct
272
     *
273
     * @return \eZ\Publish\API\Repository\Values\Content\Content the content with the updated attributes
274
     */
275
    public function updateContentMetadata(ContentInfo $contentInfo, ContentMetadataUpdateStruct $contentMetadataUpdateStruct)
276
    {
277
        $returnValue = $this->service->updateContentMetadata($contentInfo, $contentMetadataUpdateStruct);
278
        $this->signalDispatcher->emit(
279
            new UpdateContentMetadataSignal(
280
                [
281
                    'contentId' => $contentInfo->id,
282
                ]
283
            )
284
        );
285
286
        return $returnValue;
287
    }
288
289
    /**
290
     * Deletes a content object including all its versions and locations including their subtrees.
291
     *
292
     * @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)
293
     *
294
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
295
     *
296
     * @return mixed[] Affected Location Id's
297
     */
298
    public function deleteContent(ContentInfo $contentInfo)
299
    {
300
        $returnValue = $this->service->deleteContent($contentInfo);
301
        $this->signalDispatcher->emit(
302
            new DeleteContentSignal(
303
                [
304
                    'contentId' => $contentInfo->id,
305
                    'affectedLocationIds' => $returnValue,
306
                ]
307
            )
308
        );
309
310
        return $returnValue;
311
    }
312
313
    /**
314
     * Creates a draft from a published or archived version.
315
     *
316
     * If no version is given, the current published version is used.
317
     * 4.x: The draft is created with the initialLanguage code of the source version or if not present with the main language.
318
     * It can be changed on updating the version.
319
     *
320
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to create the draft
321
     *
322
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
323
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
324
     * @param \eZ\Publish\API\Repository\Values\User\User $user if set given user is used to create the draft - otherwise the current user is used
325
     *
326
     * @return \eZ\Publish\API\Repository\Values\Content\Content - the newly created content draft
327
     */
328
    public function createContentDraft(ContentInfo $contentInfo, VersionInfo $versionInfo = null, User $user = null)
329
    {
330
        $returnValue = $this->service->createContentDraft($contentInfo, $versionInfo, $user);
331
        $this->signalDispatcher->emit(
332
            new CreateContentDraftSignal(
333
                [
334
                    'contentId' => $contentInfo->id,
335
                    'versionNo' => ($versionInfo !== null ? $versionInfo->versionNo : null),
336
                    'newVersionNo' => $returnValue->getVersionInfo()->versionNo,
337
                    'userId' => ($user !== null ? $user->id : null),
338
                ]
339
            )
340
        );
341
342
        return $returnValue;
343
    }
344
345
    /**
346
     * Loads drafts for a user.
347
     *
348
     * If no user is given the drafts for the authenticated user a returned
349
     *
350
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load the draft list
351
     *
352
     * @param \eZ\Publish\API\Repository\Values\User\User $user
353
     *
354
     * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo[] the drafts ({@link VersionInfo}) owned by the given user
355
     */
356
    public function loadContentDrafts(User $user = null)
357
    {
358
        return $this->service->loadContentDrafts($user);
359
    }
360
361
    /**
362
     * Updates the fields of a draft.
363
     *
364
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to update this version
365
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
366
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $contentUpdateStruct is not valid
367
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is set to an empty value
368
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if a field value is not accepted by the field type
369
     *
370
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
371
     * @param \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct $contentUpdateStruct
372
     *
373
     * @return \eZ\Publish\API\Repository\Values\Content\Content the content draft with the updated fields
374
     */
375
    public function updateContent(VersionInfo $versionInfo, ContentUpdateStruct $contentUpdateStruct)
376
    {
377
        $returnValue = $this->service->updateContent($versionInfo, $contentUpdateStruct);
378
        $this->signalDispatcher->emit(
379
            new UpdateContentSignal(
380
                [
381
                    'contentId' => $versionInfo->getContentInfo()->id,
382
                    'versionNo' => $versionInfo->versionNo,
383
                ]
384
            )
385
        );
386
387
        return $returnValue;
388
    }
389
390
    /**
391
     * Publishes a content version.
392
     *
393
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to publish this version
394
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
395
     *
396
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
397
     * @param string[] $translations
398
     *
399
     * @return \eZ\Publish\API\Repository\Values\Content\Content
400
     */
401
    public function publishVersion(VersionInfo $versionInfo, array $translations = Language::ALL)
402
    {
403
        $returnValue = $this->service->publishVersion($versionInfo, $translations);
404
        $this->signalDispatcher->emit(
405
            new PublishVersionSignal(
406
                [
407
                    'contentId' => $versionInfo->getContentInfo()->id,
408
                    'versionNo' => $versionInfo->versionNo,
409
                    'affectedTranslations' => $translations,
410
                ]
411
            )
412
        );
413
414
        return $returnValue;
415
    }
416
417
    /**
418
     * Removes the given version.
419
     *
420
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is in
421
     *         published state or is the last version of the Content
422
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to remove this version
423
     *
424
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
425
     */
426
    public function deleteVersion(VersionInfo $versionInfo)
427
    {
428
        $returnValue = $this->service->deleteVersion($versionInfo);
429
        $this->signalDispatcher->emit(
430
            new DeleteVersionSignal(
431
                [
432
                    'contentId' => $versionInfo->contentInfo->id,
433
                    'versionNo' => $versionInfo->versionNo,
434
                ]
435
            )
436
        );
437
438
        return $returnValue;
439
    }
440
441
    /**
442
     * Loads all versions for the given content.
443
     *
444
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to list versions
445
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the given status is invalid
446
     *
447
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
448
     * @param int|null $status
449
     *
450
     * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo[] Sorted by creation date
451
     */
452
    public function loadVersions(ContentInfo $contentInfo, ?int $status = null)
453
    {
454
        return $this->service->loadVersions($contentInfo, $status);
455
    }
456
457
    /**
458
     * Copies the content to a new location. If no version is given,
459
     * all versions are copied, otherwise only the given version.
460
     *
461
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to copy the content to the given location
462
     *
463
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
464
     * @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct $destinationLocationCreateStruct the target location where the content is copied to
465
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
466
     *
467
     * @return \eZ\Publish\API\Repository\Values\Content\Content
468
     */
469
    public function copyContent(ContentInfo $contentInfo, LocationCreateStruct $destinationLocationCreateStruct, VersionInfo $versionInfo = null)
470
    {
471
        $returnValue = $this->service->copyContent($contentInfo, $destinationLocationCreateStruct, $versionInfo);
472
        $this->signalDispatcher->emit(
473
            new CopyContentSignal(
474
                [
475
                    'srcContentId' => $contentInfo->id,
476
                    'srcVersionNo' => ($versionInfo !== null ? $versionInfo->versionNo : null),
477
                    'dstContentId' => $returnValue->getVersionInfo()->getContentInfo()->id,
478
                    'dstVersionNo' => $returnValue->getVersionInfo()->versionNo,
479
                    'dstParentLocationId' => $destinationLocationCreateStruct->parentLocationId,
480
                ]
481
            )
482
        );
483
484
        return $returnValue;
485
    }
486
487
    /**
488
     * Loads all outgoing relations for the given version.
489
     *
490
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read this version
491
     *
492
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
493
     *
494
     * @return \eZ\Publish\API\Repository\Values\Content\Relation[]
495
     */
496
    public function loadRelations(VersionInfo $versionInfo)
497
    {
498
        return $this->service->loadRelations($versionInfo);
499
    }
500
501
    /**
502
     * Loads all incoming relations for a content object.
503
     *
504
     * The relations come only from published versions of the source content objects
505
     *
506
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read this version
507
     *
508
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
509
     *
510
     * @return \eZ\Publish\API\Repository\Values\Content\Relation[]
511
     */
512
    public function loadReverseRelations(ContentInfo $contentInfo)
513
    {
514
        return $this->service->loadReverseRelations($contentInfo);
515
    }
516
517
    /**
518
     * {@inheritdoc}
519
     */
520
    public function loadReverseRelationList(ContentInfo $contentInfo, int $offset = 0, int $limit = -1): RelationList
521
    {
522
        return $this->service->loadReverseRelationList($contentInfo, $offset, $limit);
523
    }
524
525
    /**
526
     * Adds a relation of type common.
527
     *
528
     * The source of the relation is the content and version
529
     * referenced by $versionInfo.
530
     *
531
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to edit this version
532
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
533
     *
534
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $sourceVersion
535
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $destinationContent the destination of the relation
536
     *
537
     * @return \eZ\Publish\API\Repository\Values\Content\Relation the newly created relation
538
     */
539
    public function addRelation(VersionInfo $sourceVersion, ContentInfo $destinationContent)
540
    {
541
        $returnValue = $this->service->addRelation($sourceVersion, $destinationContent);
542
        $this->signalDispatcher->emit(
543
            new AddRelationSignal(
544
                [
545
                    'srcContentId' => $sourceVersion->contentInfo->id,
546
                    'srcVersionNo' => $sourceVersion->versionNo,
547
                    'dstContentId' => $destinationContent->id,
548
                ]
549
            )
550
        );
551
552
        return $returnValue;
553
    }
554
555
    /**
556
     * Removes a relation of type COMMON from a draft.
557
     *
558
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed edit this version
559
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
560
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if there is no relation of type COMMON for the given destination
561
     *
562
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $sourceVersion
563
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $destinationContent
564
     */
565
    public function deleteRelation(VersionInfo $sourceVersion, ContentInfo $destinationContent)
566
    {
567
        $returnValue = $this->service->deleteRelation($sourceVersion, $destinationContent);
568
        $this->signalDispatcher->emit(
569
            new DeleteRelationSignal(
570
                [
571
                    'srcContentId' => $sourceVersion->contentInfo->id,
572
                    'srcVersionNo' => $sourceVersion->versionNo,
573
                    'dstContentId' => $destinationContent->id,
574
                ]
575
            )
576
        );
577
578
        return $returnValue;
579
    }
580
581
    /**
582
     * {@inheritdoc}
583
     */
584
    public function removeTranslation(ContentInfo $contentInfo, $languageCode)
585
    {
586
        @trigger_error(
0 ignored issues
show
Security Best Practice introduced by
It seems like you do not handle an error condition here. This can introduce security issues, and is generally not recommended.

If you suppress an error, we recommend checking for the error condition explicitly:

// For example instead of
@mkdir($dir);

// Better use
if (@mkdir($dir) === false) {
    throw new \RuntimeException('The directory '.$dir.' could not be created.');
}
Loading history...
587
            __METHOD__ . ' is deprecated, use deleteTranslation instead',
588
            E_USER_DEPRECATED
589
        );
590
        $this->deleteTranslation($contentInfo, $languageCode);
591
    }
592
593
    /**
594
     * Delete Content item Translation from all Versions (including archived ones) of a Content Object.
595
     *
596
     * NOTE: this operation is risky and permanent, so user interface should provide a warning before performing it.
597
     *
598
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the specified Translation
599
     *         is the Main Translation of a Content Item.
600
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed
601
     *         to delete the content (in one of the locations of the given Content Item).
602
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if languageCode argument
603
     *         is invalid for the given content.
604
     *
605
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
606
     * @param string $languageCode
607
     *
608
     * @since 6.13
609
     */
610
    public function deleteTranslation(ContentInfo $contentInfo, $languageCode)
611
    {
612
        $this->service->deleteTranslation($contentInfo, $languageCode);
613
        $this->signalDispatcher->emit(
614
            new RemoveTranslationSignal(['contentId' => $contentInfo->id, 'languageCode' => $languageCode])
0 ignored issues
show
Deprecated Code introduced by
The class eZ\Publish\Core\SignalSl...RemoveTranslationSignal has been deprecated with message: since 6.13, use DeleteTranslationSignal

This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message.

The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead.

Loading history...
615
        );
616
        $this->signalDispatcher->emit(
617
            new DeleteTranslationSignal(['contentId' => $contentInfo->id, 'languageCode' => $languageCode])
618
        );
619
    }
620
621
    /**
622
     * Delete specified Translation from a Content Draft.
623
     *
624
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the specified Translation
625
     *         is the only one the Content Draft has or it is the main Translation of a Content Object.
626
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed
627
     *         to edit the Content (in one of the locations of the given Content Object).
628
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if languageCode argument
629
     *         is invalid for the given Draft.
630
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if specified Version was not found
631
     *
632
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo Content Version Draft
633
     * @param string $languageCode Language code of the Translation to be removed
634
     *
635
     * @return \eZ\Publish\API\Repository\Values\Content\Content Content Draft w/o the specified Translation
636
     *
637
     * @since 6.12
638
     */
639
    public function deleteTranslationFromDraft(VersionInfo $versionInfo, $languageCode)
640
    {
641
        return $this->service->deleteTranslationFromDraft($versionInfo, $languageCode);
642
    }
643
644
    /**
645
     * Bulk-load Content items by the list of ContentInfo Value Objects.
646
     *
647
     * Note: it does not throw exceptions on load, just ignores erroneous Content item.
648
     * Moreover, since the method works on pre-loaded ContentInfo list, it is assumed that user is
649
     * allowed to access every Content on the list.
650
     *
651
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo[] $contentInfoList
652
     * @param string[] $languages A language priority, filters returned fields and is used as prioritized language code on
653
     *                            returned value object. If not given all languages are returned.
654
     * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true,
655
     *                                 unless all languages have been asked for.
656
     *
657
     * @return \eZ\Publish\API\Repository\Values\Content\Content[] list of Content items with Content Ids as keys
658
     */
659
    public function loadContentListByContentInfo(
660
        array $contentInfoList,
661
        array $languages = [],
662
        $useAlwaysAvailable = true
663
    ) {
664
        return $this->service->loadContentListByContentInfo(
665
            $contentInfoList,
666
            $languages,
667
            $useAlwaysAvailable
668
        );
669
    }
670
671
    /**
672
     * Hides Content by making all the Locations appear hidden.
673
     * It does not persist hidden state on Location object itself.
674
     *
675
     * Content hidden by this API can be revealed by revealContent API.
676
     *
677
     * @see revealContent
678
     *
679
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
680
     */
681
    public function hideContent(ContentInfo $contentInfo): void
682
    {
683
        $this->service->hideContent($contentInfo);
684
        $this->signalDispatcher->emit(
685
            new HideContentSignal([
686
                'contentId' => $contentInfo->id,
687
            ])
688
        );
689
    }
690
691
    /**
692
     * Reveals Content hidden by hideContent API.
693
     * Locations which were hidden before hiding Content will remain hidden.
694
     *
695
     * @see hideContent
696
     *
697
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
698
     */
699
    public function revealContent(ContentInfo $contentInfo): void
700
    {
701
        $this->service->revealContent($contentInfo);
702
        $this->signalDispatcher->emit(
703
            new RevealContentSignal([
704
                'contentId' => $contentInfo->id,
705
            ])
706
        );
707
    }
708
709
    /**
710
     * Instantiates a new content create struct object.
711
     *
712
     * alwaysAvailable is set to the ContentType's defaultAlwaysAvailable
713
     *
714
     * @param \eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType
715
     * @param string $mainLanguageCode
716
     *
717
     * @return \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct
718
     */
719
    public function newContentCreateStruct(ContentType $contentType, $mainLanguageCode)
720
    {
721
        return $this->service->newContentCreateStruct($contentType, $mainLanguageCode);
722
    }
723
724
    /**
725
     * Instantiates a new content meta data update struct.
726
     *
727
     * @return \eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct
728
     */
729
    public function newContentMetadataUpdateStruct()
730
    {
731
        return $this->service->newContentMetadataUpdateStruct();
732
    }
733
734
    /**
735
     * Instantiates a new content update struct.
736
     *
737
     * @return \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct
738
     */
739
    public function newContentUpdateStruct()
740
    {
741
        return $this->service->newContentUpdateStruct();
742
    }
743
}
744