Completed
Push — ezp-30936-edit-content-new-req... ( ff631a...b7022d )
by
unknown
20:25
created

copyTranslationsFromPublishedVersion()   D

Complexity

Conditions 15
Paths 39

Size

Total Lines 92

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 15
nc 39
nop 2
dl 0
loc 92
rs 4.9078
c 0
b 0
f 0

How to fix   Long Method    Complexity   

Long Method

Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.

For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.

Commonly applied refactorings include:

1
<?php
2
3
/**
4
 * File containing the eZ\Publish\Core\Repository\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\Repository;
10
11
use eZ\Publish\API\Repository\ContentService as ContentServiceInterface;
12
use eZ\Publish\API\Repository\Repository as RepositoryInterface;
13
use eZ\Publish\API\Repository\Values\Content\ContentDraftList;
14
use eZ\Publish\API\Repository\Values\Content\DraftList\Item\ContentDraftListItem;
15
use eZ\Publish\API\Repository\Values\Content\DraftList\Item\UnauthorizedContentDraftListItem;
16
use eZ\Publish\API\Repository\Values\Content\RelationList;
17
use eZ\Publish\API\Repository\Values\Content\RelationList\Item\RelationListItem;
18
use eZ\Publish\API\Repository\Values\Content\RelationList\Item\UnauthorizedRelationListItem;
19
use eZ\Publish\API\Repository\Values\User\UserReference;
20
use eZ\Publish\Core\Repository\Values\Content\Location;
21
use eZ\Publish\API\Repository\Values\Content\Language;
22
use eZ\Publish\SPI\Persistence\Handler;
23
use eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct as APIContentUpdateStruct;
24
use eZ\Publish\API\Repository\Values\ContentType\ContentType;
25
use eZ\Publish\API\Repository\Values\Content\ContentCreateStruct as APIContentCreateStruct;
26
use eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct;
27
use eZ\Publish\API\Repository\Values\Content\Content as APIContent;
28
use eZ\Publish\API\Repository\Values\Content\VersionInfo as APIVersionInfo;
29
use eZ\Publish\API\Repository\Values\Content\ContentInfo;
30
use eZ\Publish\API\Repository\Values\User\User;
31
use eZ\Publish\API\Repository\Values\Content\LocationCreateStruct;
32
use eZ\Publish\API\Repository\Values\Content\Field;
33
use eZ\Publish\API\Repository\Values\Content\Relation as APIRelation;
34
use eZ\Publish\API\Repository\Exceptions\NotFoundException as APINotFoundException;
35
use eZ\Publish\Core\Base\Exceptions\BadStateException;
36
use eZ\Publish\Core\Base\Exceptions\NotFoundException;
37
use eZ\Publish\Core\Base\Exceptions\InvalidArgumentException;
38
use eZ\Publish\Core\Base\Exceptions\ContentValidationException;
39
use eZ\Publish\Core\Base\Exceptions\ContentFieldValidationException;
40
use eZ\Publish\Core\Base\Exceptions\UnauthorizedException;
41
use eZ\Publish\Core\FieldType\ValidationError;
42
use eZ\Publish\Core\Repository\Values\Content\VersionInfo;
43
use eZ\Publish\Core\Repository\Values\Content\ContentCreateStruct;
44
use eZ\Publish\Core\Repository\Values\Content\ContentUpdateStruct;
45
use eZ\Publish\SPI\Limitation\Target;
46
use eZ\Publish\SPI\Persistence\Content\MetadataUpdateStruct as SPIMetadataUpdateStruct;
47
use eZ\Publish\SPI\Persistence\Content\CreateStruct as SPIContentCreateStruct;
48
use eZ\Publish\SPI\Persistence\Content\UpdateStruct as SPIContentUpdateStruct;
49
use eZ\Publish\SPI\Persistence\Content\Field as SPIField;
50
use eZ\Publish\SPI\Persistence\Content\Relation\CreateStruct as SPIRelationCreateStruct;
51
use Exception;
52
53
/**
54
 * This class provides service methods for managing content.
55
 *
56
 * @example Examples/content.php
57
 */
58
class ContentService implements ContentServiceInterface
59
{
60
    /** @var \eZ\Publish\Core\Repository\Repository */
61
    protected $repository;
62
63
    /** @var \eZ\Publish\SPI\Persistence\Handler */
64
    protected $persistenceHandler;
65
66
    /** @var array */
67
    protected $settings;
68
69
    /** @var \eZ\Publish\Core\Repository\Helper\DomainMapper */
70
    protected $domainMapper;
71
72
    /** @var \eZ\Publish\Core\Repository\Helper\RelationProcessor */
73
    protected $relationProcessor;
74
75
    /** @var \eZ\Publish\Core\Repository\Helper\NameSchemaService */
76
    protected $nameSchemaService;
77
78
    /** @var \eZ\Publish\Core\Repository\Helper\FieldTypeRegistry */
79
    protected $fieldTypeRegistry;
80
81
    /**
82
     * Setups service with reference to repository object that created it & corresponding handler.
83
     *
84
     * @param \eZ\Publish\API\Repository\Repository $repository
85
     * @param \eZ\Publish\SPI\Persistence\Handler $handler
86
     * @param \eZ\Publish\Core\Repository\Helper\DomainMapper $domainMapper
87
     * @param \eZ\Publish\Core\Repository\Helper\RelationProcessor $relationProcessor
88
     * @param \eZ\Publish\Core\Repository\Helper\NameSchemaService $nameSchemaService
89
     * @param \eZ\Publish\Core\Repository\Helper\FieldTypeRegistry $fieldTypeRegistry,
0 ignored issues
show
Documentation introduced by
There is no parameter named $fieldTypeRegistry,. Did you maybe mean $fieldTypeRegistry?

This check looks for PHPDoc comments describing methods or function parameters that do not exist on the corresponding method or function. It has, however, found a similar but not annotated parameter which might be a good fit.

Consider the following example. The parameter $ireland is not defined by the method finale(...).

/**
 * @param array $germany
 * @param array $ireland
 */
function finale($germany, $island) {
    return "2:1";
}

The most likely cause is that the parameter was changed, but the annotation was not.

Loading history...
90
     * @param array $settings
91
     */
92
    public function __construct(
93
        RepositoryInterface $repository,
94
        Handler $handler,
95
        Helper\DomainMapper $domainMapper,
96
        Helper\RelationProcessor $relationProcessor,
97
        Helper\NameSchemaService $nameSchemaService,
98
        Helper\FieldTypeRegistry $fieldTypeRegistry,
99
        array $settings = []
100
    ) {
101
        $this->repository = $repository;
0 ignored issues
show
Documentation Bug introduced by
$repository is of type object<eZ\Publish\API\Repository\Repository>, but the property $repository was declared to be of type object<eZ\Publish\Core\Repository\Repository>. Are you sure that you always receive this specific sub-class here, or does it make sense to add an instanceof check?

Our type inference engine has found a suspicous assignment of a value to a property. This check raises an issue when a value that can be of a given class or a super-class is assigned to a property that is type hinted more strictly.

Either this assignment is in error or an instanceof check should be added for that assignment.

class Alien {}

class Dalek extends Alien {}

class Plot
{
    /** @var  Dalek */
    public $villain;
}

$alien = new Alien();
$plot = new Plot();
if ($alien instanceof Dalek) {
    $plot->villain = $alien;
}
Loading history...
102
        $this->persistenceHandler = $handler;
103
        $this->domainMapper = $domainMapper;
104
        $this->relationProcessor = $relationProcessor;
105
        $this->nameSchemaService = $nameSchemaService;
106
        $this->fieldTypeRegistry = $fieldTypeRegistry;
107
        // Union makes sure default settings are ignored if provided in argument
108
        $this->settings = $settings + [
109
            // Version archive limit (0-50), only enforced on publish, not on un-publish.
110
            'default_version_archive_limit' => 5,
111
        ];
112
    }
113
114
    /**
115
     * Loads a content info object.
116
     *
117
     * To load fields use loadContent
118
     *
119
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the content
120
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given id does not exist
121
     *
122
     * @param int $contentId
123
     *
124
     * @return \eZ\Publish\API\Repository\Values\Content\ContentInfo
125
     */
126
    public function loadContentInfo($contentId)
127
    {
128
        $contentInfo = $this->internalLoadContentInfo($contentId);
129
        if (!$this->repository->canUser('content', 'read', $contentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
130
            throw new UnauthorizedException('content', 'read', ['contentId' => $contentId]);
131
        }
132
133
        return $contentInfo;
134
    }
135
136
    /**
137
     * {@inheritdoc}
138
     */
139
    public function loadContentInfoList(array $contentIds): iterable
140
    {
141
        $contentInfoList = [];
142
        $spiInfoList = $this->persistenceHandler->contentHandler()->loadContentInfoList($contentIds);
143
        foreach ($spiInfoList as $id => $spiInfo) {
144
            $contentInfo = $this->domainMapper->buildContentInfoDomainObject($spiInfo);
145
            if ($this->repository->canUser('content', 'read', $contentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
146
                $contentInfoList[$id] = $contentInfo;
147
            }
148
        }
149
150
        return $contentInfoList;
151
    }
152
153
    /**
154
     * Loads a content info object.
155
     *
156
     * To load fields use loadContent
157
     *
158
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given id does not exist
159
     *
160
     * @param mixed $id
161
     * @param bool $isRemoteId
162
     *
163
     * @return \eZ\Publish\API\Repository\Values\Content\ContentInfo
164
     */
165
    public function internalLoadContentInfo($id, $isRemoteId = false)
166
    {
167
        try {
168
            $method = $isRemoteId ? 'loadContentInfoByRemoteId' : 'loadContentInfo';
169
170
            return $this->domainMapper->buildContentInfoDomainObject(
171
                $this->persistenceHandler->contentHandler()->$method($id)
172
            );
173
        } catch (APINotFoundException $e) {
174
            throw new NotFoundException(
175
                'Content',
176
                $id,
177
                $e
178
            );
179
        }
180
    }
181
182
    /**
183
     * Loads a content info object for the given remoteId.
184
     *
185
     * To load fields use loadContent
186
     *
187
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the content
188
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given remote id does not exist
189
     *
190
     * @param string $remoteId
191
     *
192
     * @return \eZ\Publish\API\Repository\Values\Content\ContentInfo
193
     */
194
    public function loadContentInfoByRemoteId($remoteId)
195
    {
196
        $contentInfo = $this->internalLoadContentInfo($remoteId, true);
197
198
        if (!$this->repository->canUser('content', 'read', $contentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
199
            throw new UnauthorizedException('content', 'read', ['remoteId' => $remoteId]);
200
        }
201
202
        return $contentInfo;
203
    }
204
205
    /**
206
     * Loads a version info of the given content object.
207
     *
208
     * If no version number is given, the method returns the current version
209
     *
210
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the version with the given number does not exist
211
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
212
     *
213
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
214
     * @param int $versionNo the version number. If not given the current version is returned.
215
     *
216
     * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo
217
     */
218
    public function loadVersionInfo(ContentInfo $contentInfo, $versionNo = null)
219
    {
220
        return $this->loadVersionInfoById($contentInfo->id, $versionNo);
221
    }
222
223
    /**
224
     * Loads a version info of the given content object id.
225
     *
226
     * If no version number is given, the method returns the current version
227
     *
228
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the version with the given number does not exist
229
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version
230
     *
231
     * @param mixed $contentId
232
     * @param int $versionNo the version number. If not given the current version is returned.
233
     *
234
     * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo
235
     */
236
    public function loadVersionInfoById($contentId, $versionNo = null)
237
    {
238
        try {
239
            $spiVersionInfo = $this->persistenceHandler->contentHandler()->loadVersionInfo(
240
                $contentId,
241
                $versionNo
242
            );
243
        } catch (APINotFoundException $e) {
244
            throw new NotFoundException(
245
                'VersionInfo',
246
                [
247
                    'contentId' => $contentId,
248
                    'versionNo' => $versionNo,
249
                ],
250
                $e
251
            );
252
        }
253
254
        $versionInfo = $this->domainMapper->buildVersionInfoDomainObject($spiVersionInfo);
255
256
        if ($versionInfo->isPublished()) {
257
            $function = 'read';
258
        } else {
259
            $function = 'versionread';
260
        }
261
262
        if (!$this->repository->canUser('content', $function, $versionInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
263
            throw new UnauthorizedException('content', $function, ['contentId' => $contentId]);
264
        }
265
266
        return $versionInfo;
267
    }
268
269
    /**
270
     * {@inheritdoc}
271
     */
272
    public function loadContentByContentInfo(ContentInfo $contentInfo, array $languages = null, $versionNo = null, $useAlwaysAvailable = true)
273
    {
274
        // Change $useAlwaysAvailable to false to avoid contentInfo lookup if we know alwaysAvailable is disabled
275
        if ($useAlwaysAvailable && !$contentInfo->alwaysAvailable) {
276
            $useAlwaysAvailable = false;
277
        }
278
279
        return $this->loadContent(
280
            $contentInfo->id,
281
            $languages,
282
            $versionNo,// On purpose pass as-is and not use $contentInfo, to make sure to return actual current version on null
283
            $useAlwaysAvailable
284
        );
285
    }
286
287
    /**
288
     * {@inheritdoc}
289
     */
290
    public function loadContentByVersionInfo(APIVersionInfo $versionInfo, array $languages = null, $useAlwaysAvailable = true)
291
    {
292
        // Change $useAlwaysAvailable to false to avoid contentInfo lookup if we know alwaysAvailable is disabled
293
        if ($useAlwaysAvailable && !$versionInfo->getContentInfo()->alwaysAvailable) {
294
            $useAlwaysAvailable = false;
295
        }
296
297
        return $this->loadContent(
298
            $versionInfo->getContentInfo()->id,
299
            $languages,
300
            $versionInfo->versionNo,
301
            $useAlwaysAvailable
302
        );
303
    }
304
305
    /**
306
     * {@inheritdoc}
307
     */
308
    public function loadContent($contentId, array $languages = null, $versionNo = null, $useAlwaysAvailable = true)
309
    {
310
        $content = $this->internalLoadContent($contentId, $languages, $versionNo, false, $useAlwaysAvailable);
311
312
        if (!$this->repository->canUser('content', 'read', $content)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
313
            throw new UnauthorizedException('content', 'read', ['contentId' => $contentId]);
314
        }
315
        if (
316
            !$content->getVersionInfo()->isPublished()
317
            && !$this->repository->canUser('content', 'versionread', $content)
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
318
        ) {
319
            throw new UnauthorizedException('content', 'versionread', ['contentId' => $contentId, 'versionNo' => $versionNo]);
320
        }
321
322
        return $content;
323
    }
324
325
    /**
326
     * Loads content in a version of the given content object.
327
     *
328
     * If no version number is given, the method returns the current version
329
     *
330
     * @internal
331
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if the content or version with the given id and languages does not exist
332
     *
333
     * @param mixed $id
334
     * @param array|null $languages A language priority, filters returned fields and is used as prioritized language code on
335
     *                         returned value object. If not given all languages are returned.
336
     * @param int|null $versionNo the version number. If not given the current version is returned
337
     * @param bool $isRemoteId
338
     * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true
339
     *
340
     * @return \eZ\Publish\API\Repository\Values\Content\Content
341
     */
342
    public function internalLoadContent($id, array $languages = null, $versionNo = null, $isRemoteId = false, $useAlwaysAvailable = true)
343
    {
344
        try {
345
            // Get Content ID if lookup by remote ID
346
            if ($isRemoteId) {
347
                $spiContentInfo = $this->persistenceHandler->contentHandler()->loadContentInfoByRemoteId($id);
348
                $id = $spiContentInfo->id;
349
                // Set $isRemoteId to false as the next loads will be for content id now that we have it (for exception use now)
350
                $isRemoteId = false;
351
            }
352
353
            $loadLanguages = $languages;
354
            $alwaysAvailableLanguageCode = null;
355
            // Set main language on $languages filter if not empty (all) and $useAlwaysAvailable being true
356
            // @todo Move use always available logic to SPI load methods, like done in location handler in 7.x
357
            if (!empty($loadLanguages) && $useAlwaysAvailable) {
358
                if (!isset($spiContentInfo)) {
359
                    $spiContentInfo = $this->persistenceHandler->contentHandler()->loadContentInfo($id);
360
                }
361
362
                if ($spiContentInfo->alwaysAvailable) {
363
                    $loadLanguages[] = $alwaysAvailableLanguageCode = $spiContentInfo->mainLanguageCode;
364
                    $loadLanguages = array_unique($loadLanguages);
365
                }
366
            }
367
368
            $spiContent = $this->persistenceHandler->contentHandler()->load(
369
                $id,
370
                $versionNo,
371
                $loadLanguages
0 ignored issues
show
Bug introduced by
It seems like $loadLanguages defined by $languages on line 353 can also be of type array; however, eZ\Publish\SPI\Persistence\Content\Handler::load() does only seem to accept null|array<integer,string>, maybe add an additional type check?

If a method or function can return multiple different values and unless you are sure that you only can receive a single value in this context, we recommend to add an additional type check:

/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}

If this a common case that PHP Analyzer should handle natively, please let us know by opening an issue.

Loading history...
372
            );
373
        } catch (APINotFoundException $e) {
374
            throw new NotFoundException(
375
                'Content',
376
                [
377
                    $isRemoteId ? 'remoteId' : 'id' => $id,
378
                    'languages' => $languages,
379
                    'versionNo' => $versionNo,
380
                ],
381
                $e
382
            );
383
        }
384
385
        if ($languages === null) {
386
            $languages = [];
387
        }
388
389
        return $this->domainMapper->buildContentDomainObject(
390
            $spiContent,
391
            $this->repository->getContentTypeService()->loadContentType(
392
                $spiContent->versionInfo->contentInfo->contentTypeId,
393
                $languages
394
            ),
395
            $languages,
396
            $alwaysAvailableLanguageCode
397
        );
398
    }
399
400
    /**
401
     * Loads content in a version for the content object reference by the given remote id.
402
     *
403
     * If no version is given, the method returns the current version
404
     *
405
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content or version with the given remote id does not exist
406
     * @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
407
     *
408
     * @param string $remoteId
409
     * @param array $languages A language filter for fields. If not given all languages are returned
410
     * @param int $versionNo the version number. If not given the current version is returned
411
     * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true
412
     *
413
     * @return \eZ\Publish\API\Repository\Values\Content\Content
414
     */
415
    public function loadContentByRemoteId($remoteId, array $languages = null, $versionNo = null, $useAlwaysAvailable = true)
416
    {
417
        $content = $this->internalLoadContent($remoteId, $languages, $versionNo, true, $useAlwaysAvailable);
418
419
        if (!$this->repository->canUser('content', 'read', $content)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
420
            throw new UnauthorizedException('content', 'read', ['remoteId' => $remoteId]);
421
        }
422
423
        if (
424
            !$content->getVersionInfo()->isPublished()
425
            && !$this->repository->canUser('content', 'versionread', $content)
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
426
        ) {
427
            throw new UnauthorizedException('content', 'versionread', ['remoteId' => $remoteId, 'versionNo' => $versionNo]);
428
        }
429
430
        return $content;
431
    }
432
433
    /**
434
     * Bulk-load Content items by the list of ContentInfo Value Objects.
435
     *
436
     * Note: it does not throw exceptions on load, just ignores erroneous Content item.
437
     * Moreover, since the method works on pre-loaded ContentInfo list, it is assumed that user is
438
     * allowed to access every Content on the list.
439
     *
440
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo[] $contentInfoList
441
     * @param string[] $languages A language priority, filters returned fields and is used as prioritized language code on
442
     *                            returned value object. If not given all languages are returned.
443
     * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true,
444
     *                                 unless all languages have been asked for.
445
     *
446
     * @return \eZ\Publish\API\Repository\Values\Content\Content[] list of Content items with Content Ids as keys
447
     */
448
    public function loadContentListByContentInfo(
449
        array $contentInfoList,
450
        array $languages = [],
451
        $useAlwaysAvailable = true
452
    ) {
453
        $loadAllLanguages = $languages === Language::ALL;
454
        $contentIds = [];
455
        $contentTypeIds = [];
456
        $translations = $languages;
457
        foreach ($contentInfoList as $contentInfo) {
458
            $contentIds[] = $contentInfo->id;
459
            $contentTypeIds[] = $contentInfo->contentTypeId;
460
            // Unless we are told to load all languages, we add main language to translations so they are loaded too
461
            // Might in some case load more languages then intended, but prioritised handling will pick right one
462
            if (!$loadAllLanguages && $useAlwaysAvailable && $contentInfo->alwaysAvailable) {
463
                $translations[] = $contentInfo->mainLanguageCode;
464
            }
465
        }
466
467
        $contentList = [];
468
        $translations = array_unique($translations);
469
        $spiContentList = $this->persistenceHandler->contentHandler()->loadContentList(
470
            $contentIds,
471
            $translations
472
        );
473
        $contentTypeList = $this->repository->getContentTypeService()->loadContentTypeList(
474
            array_unique($contentTypeIds),
475
            $languages
476
        );
477
        foreach ($spiContentList as $contentId => $spiContent) {
478
            $contentInfo = $spiContent->versionInfo->contentInfo;
479
            $contentList[$contentId] = $this->domainMapper->buildContentDomainObject(
480
                $spiContent,
481
                $contentTypeList[$contentInfo->contentTypeId],
482
                $languages,
483
                $contentInfo->alwaysAvailable ? $contentInfo->mainLanguageCode : null
484
            );
485
        }
486
487
        return $contentList;
488
    }
489
490
    /**
491
     * Creates a new content draft assigned to the authenticated user.
492
     *
493
     * If a different userId is given in $contentCreateStruct it is assigned to the given user
494
     * but this required special rights for the authenticated user
495
     * (this is useful for content staging where the transfer process does not
496
     * have to authenticate with the user which created the content object in the source server).
497
     * The user has to publish the draft if it should be visible.
498
     * In 4.x at least one location has to be provided in the location creation array.
499
     *
500
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to create the content in the given location
501
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the provided remoteId exists in the system, required properties on
502
     *                                                                        struct are missing or invalid, or if multiple locations are under the
503
     *                                                                        same parent.
504
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $contentCreateStruct is not valid,
505
     *                                                                               or if a required field is missing / set to an empty value.
506
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException If field definition does not exist in the ContentType,
507
     *                                                                          or value is set for non-translatable field in language
508
     *                                                                          other than main.
509
     *
510
     * @param \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct $contentCreateStruct
511
     * @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct[] $locationCreateStructs For each location parent under which a location should be created for the content
512
     *
513
     * @return \eZ\Publish\API\Repository\Values\Content\Content - the newly created content draft
514
     */
515
    public function createContent(APIContentCreateStruct $contentCreateStruct, array $locationCreateStructs = [])
516
    {
517
        if ($contentCreateStruct->mainLanguageCode === null) {
518
            throw new InvalidArgumentException('$contentCreateStruct', "'mainLanguageCode' property must be set");
519
        }
520
521
        if ($contentCreateStruct->contentType === null) {
522
            throw new InvalidArgumentException('$contentCreateStruct', "'contentType' property must be set");
523
        }
524
525
        $contentCreateStruct = clone $contentCreateStruct;
526
527
        if ($contentCreateStruct->ownerId === null) {
528
            $contentCreateStruct->ownerId = $this->repository->getCurrentUserReference()->getUserId();
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Reposito...tCurrentUserReference() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::getCurrentUserReference() instead. Get current user reference.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
529
        }
530
531
        if ($contentCreateStruct->alwaysAvailable === null) {
532
            $contentCreateStruct->alwaysAvailable = $contentCreateStruct->contentType->defaultAlwaysAvailable ?: false;
533
        }
534
535
        $contentCreateStruct->contentType = $this->repository->getContentTypeService()->loadContentType(
536
            $contentCreateStruct->contentType->id
537
        );
538
539
        if (empty($contentCreateStruct->sectionId)) {
540
            if (isset($locationCreateStructs[0])) {
541
                $location = $this->repository->getLocationService()->loadLocation(
542
                    $locationCreateStructs[0]->parentLocationId
543
                );
544
                $contentCreateStruct->sectionId = $location->contentInfo->sectionId;
545
            } else {
546
                $contentCreateStruct->sectionId = 1;
547
            }
548
        }
549
550
        if (!$this->repository->canUser('content', 'create', $contentCreateStruct, $locationCreateStructs)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
551
            throw new UnauthorizedException(
552
                'content',
553
                'create',
554
                [
555
                    'parentLocationId' => isset($locationCreateStructs[0]) ?
556
                            $locationCreateStructs[0]->parentLocationId :
557
                            null,
558
                    'sectionId' => $contentCreateStruct->sectionId,
559
                ]
560
            );
561
        }
562
563
        if (!empty($contentCreateStruct->remoteId)) {
564
            try {
565
                $this->loadContentByRemoteId($contentCreateStruct->remoteId);
566
567
                throw new InvalidArgumentException(
568
                    '$contentCreateStruct',
569
                    "Another content with remoteId '{$contentCreateStruct->remoteId}' exists"
570
                );
571
            } catch (APINotFoundException $e) {
572
                // Do nothing
573
            }
574
        } else {
575
            $contentCreateStruct->remoteId = $this->domainMapper->getUniqueHash($contentCreateStruct);
576
        }
577
578
        $spiLocationCreateStructs = $this->buildSPILocationCreateStructs($locationCreateStructs);
579
580
        $languageCodes = $this->getLanguageCodesForCreate($contentCreateStruct);
581
        $fields = $this->mapFieldsForCreate($contentCreateStruct);
582
583
        $fieldValues = [];
584
        $spiFields = [];
585
        $allFieldErrors = [];
586
        $inputRelations = [];
587
        $locationIdToContentIdMapping = [];
588
589
        foreach ($contentCreateStruct->contentType->getFieldDefinitions() as $fieldDefinition) {
590
            /** @var $fieldType \eZ\Publish\Core\FieldType\FieldType */
591
            $fieldType = $this->fieldTypeRegistry->getFieldType(
592
                $fieldDefinition->fieldTypeIdentifier
593
            );
594
595
            foreach ($languageCodes as $languageCode) {
596
                $isEmptyValue = false;
597
                $valueLanguageCode = $fieldDefinition->isTranslatable ? $languageCode : $contentCreateStruct->mainLanguageCode;
598
                $isLanguageMain = $languageCode === $contentCreateStruct->mainLanguageCode;
599
                if (isset($fields[$fieldDefinition->identifier][$valueLanguageCode])) {
600
                    $fieldValue = $fields[$fieldDefinition->identifier][$valueLanguageCode]->value;
601
                } else {
602
                    $fieldValue = $fieldDefinition->defaultValue;
603
                }
604
605
                $fieldValue = $fieldType->acceptValue($fieldValue);
606
607
                if ($fieldType->isEmptyValue($fieldValue)) {
608
                    $isEmptyValue = true;
609
                    if ($fieldDefinition->isRequired) {
610
                        $allFieldErrors[$fieldDefinition->id][$languageCode] = new ValidationError(
611
                            "Value for required field definition '%identifier%' with language '%languageCode%' is empty",
612
                            null,
613
                            ['%identifier%' => $fieldDefinition->identifier, '%languageCode%' => $languageCode],
614
                            'empty'
615
                        );
616
                    }
617
                } else {
618
                    $fieldErrors = $fieldType->validate(
619
                        $fieldDefinition,
620
                        $fieldValue
621
                    );
622
                    if (!empty($fieldErrors)) {
623
                        $allFieldErrors[$fieldDefinition->id][$languageCode] = $fieldErrors;
624
                    }
625
                }
626
627
                if (!empty($allFieldErrors)) {
628
                    continue;
629
                }
630
631
                $this->relationProcessor->appendFieldRelations(
632
                    $inputRelations,
633
                    $locationIdToContentIdMapping,
634
                    $fieldType,
635
                    $fieldValue,
636
                    $fieldDefinition->id
637
                );
638
                $fieldValues[$fieldDefinition->identifier][$languageCode] = $fieldValue;
639
640
                // Only non-empty value for: translatable field or in main language
641
                if (
642
                    (!$isEmptyValue && $fieldDefinition->isTranslatable) ||
643
                    (!$isEmptyValue && $isLanguageMain)
644
                ) {
645
                    $spiFields[] = new SPIField(
646
                        [
647
                            'id' => null,
648
                            'fieldDefinitionId' => $fieldDefinition->id,
649
                            'type' => $fieldDefinition->fieldTypeIdentifier,
650
                            'value' => $fieldType->toPersistenceValue($fieldValue),
651
                            'languageCode' => $languageCode,
652
                            'versionNo' => null,
653
                        ]
654
                    );
655
                }
656
            }
657
        }
658
659
        if (!empty($allFieldErrors)) {
660
            throw new ContentFieldValidationException($allFieldErrors);
661
        }
662
663
        $spiContentCreateStruct = new SPIContentCreateStruct(
664
            [
665
                'name' => $this->nameSchemaService->resolve(
666
                    $contentCreateStruct->contentType->nameSchema,
667
                    $contentCreateStruct->contentType,
668
                    $fieldValues,
669
                    $languageCodes
670
                ),
671
                'typeId' => $contentCreateStruct->contentType->id,
672
                'sectionId' => $contentCreateStruct->sectionId,
673
                'ownerId' => $contentCreateStruct->ownerId,
674
                'locations' => $spiLocationCreateStructs,
675
                'fields' => $spiFields,
676
                'alwaysAvailable' => $contentCreateStruct->alwaysAvailable,
677
                'remoteId' => $contentCreateStruct->remoteId,
678
                'modified' => isset($contentCreateStruct->modificationDate) ? $contentCreateStruct->modificationDate->getTimestamp() : time(),
679
                'initialLanguageId' => $this->persistenceHandler->contentLanguageHandler()->loadByLanguageCode(
680
                    $contentCreateStruct->mainLanguageCode
681
                )->id,
682
            ]
683
        );
684
685
        $defaultObjectStates = $this->getDefaultObjectStates();
686
687
        $this->repository->beginTransaction();
688
        try {
689
            $spiContent = $this->persistenceHandler->contentHandler()->create($spiContentCreateStruct);
690
            $this->relationProcessor->processFieldRelations(
691
                $inputRelations,
692
                $spiContent->versionInfo->contentInfo->id,
693
                $spiContent->versionInfo->versionNo,
694
                $contentCreateStruct->contentType
695
            );
696
697
            $objectStateHandler = $this->persistenceHandler->objectStateHandler();
698
            foreach ($defaultObjectStates as $objectStateGroupId => $objectState) {
699
                $objectStateHandler->setContentState(
700
                    $spiContent->versionInfo->contentInfo->id,
701
                    $objectStateGroupId,
702
                    $objectState->id
703
                );
704
            }
705
706
            $this->repository->commit();
707
        } catch (Exception $e) {
708
            $this->repository->rollback();
709
            throw $e;
710
        }
711
712
        return $this->domainMapper->buildContentDomainObject(
713
            $spiContent,
714
            $contentCreateStruct->contentType
715
        );
716
    }
717
718
    /**
719
     * Returns an array of default content states with content state group id as key.
720
     *
721
     * @return \eZ\Publish\SPI\Persistence\Content\ObjectState[]
722
     */
723
    protected function getDefaultObjectStates()
724
    {
725
        $defaultObjectStatesMap = [];
726
        $objectStateHandler = $this->persistenceHandler->objectStateHandler();
727
728
        foreach ($objectStateHandler->loadAllGroups() as $objectStateGroup) {
729
            foreach ($objectStateHandler->loadObjectStates($objectStateGroup->id) as $objectState) {
730
                // Only register the first object state which is the default one.
731
                $defaultObjectStatesMap[$objectStateGroup->id] = $objectState;
732
                break;
733
            }
734
        }
735
736
        return $defaultObjectStatesMap;
737
    }
738
739
    /**
740
     * Returns all language codes used in given $fields.
741
     *
742
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if no field value is set in main language
743
     *
744
     * @param \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct $contentCreateStruct
745
     *
746
     * @return string[]
747
     */
748
    protected function getLanguageCodesForCreate(APIContentCreateStruct $contentCreateStruct)
749
    {
750
        $languageCodes = [];
751
752
        foreach ($contentCreateStruct->fields as $field) {
753
            if ($field->languageCode === null || isset($languageCodes[$field->languageCode])) {
754
                continue;
755
            }
756
757
            $this->persistenceHandler->contentLanguageHandler()->loadByLanguageCode(
758
                $field->languageCode
759
            );
760
            $languageCodes[$field->languageCode] = true;
761
        }
762
763
        if (!isset($languageCodes[$contentCreateStruct->mainLanguageCode])) {
764
            $this->persistenceHandler->contentLanguageHandler()->loadByLanguageCode(
765
                $contentCreateStruct->mainLanguageCode
766
            );
767
            $languageCodes[$contentCreateStruct->mainLanguageCode] = true;
768
        }
769
770
        return array_keys($languageCodes);
771
    }
772
773
    /**
774
     * Returns an array of fields like $fields[$field->fieldDefIdentifier][$field->languageCode].
775
     *
776
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException If field definition does not exist in the ContentType
777
     *                                                                          or value is set for non-translatable field in language
778
     *                                                                          other than main
779
     *
780
     * @param \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct $contentCreateStruct
781
     *
782
     * @return array
783
     */
784
    protected function mapFieldsForCreate(APIContentCreateStruct $contentCreateStruct)
785
    {
786
        $fields = [];
787
788
        foreach ($contentCreateStruct->fields as $field) {
789
            $fieldDefinition = $contentCreateStruct->contentType->getFieldDefinition($field->fieldDefIdentifier);
790
791
            if ($fieldDefinition === null) {
792
                throw new ContentValidationException(
793
                    "Field definition '%identifier%' does not exist in given ContentType",
794
                    ['%identifier%' => $field->fieldDefIdentifier]
795
                );
796
            }
797
798
            if ($field->languageCode === null) {
799
                $field = $this->cloneField(
800
                    $field,
801
                    ['languageCode' => $contentCreateStruct->mainLanguageCode]
802
                );
803
            }
804
805
            if (!$fieldDefinition->isTranslatable && ($field->languageCode != $contentCreateStruct->mainLanguageCode)) {
806
                throw new ContentValidationException(
807
                    "A value is set for non translatable field definition '%identifier%' with language '%languageCode%'",
808
                    ['%identifier%' => $field->fieldDefIdentifier, '%languageCode%' => $field->languageCode]
809
                );
810
            }
811
812
            $fields[$field->fieldDefIdentifier][$field->languageCode] = $field;
813
        }
814
815
        return $fields;
816
    }
817
818
    /**
819
     * Clones $field with overriding specific properties from given $overrides array.
820
     *
821
     * @param Field $field
822
     * @param array $overrides
823
     *
824
     * @return Field
825
     */
826
    private function cloneField(Field $field, array $overrides = [])
827
    {
828
        $fieldData = array_merge(
829
            [
830
                'id' => $field->id,
831
                'value' => $field->value,
832
                'languageCode' => $field->languageCode,
833
                'fieldDefIdentifier' => $field->fieldDefIdentifier,
834
                'fieldTypeIdentifier' => $field->fieldTypeIdentifier,
835
            ],
836
            $overrides
837
        );
838
839
        return new Field($fieldData);
840
    }
841
842
    /**
843
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException
844
     *
845
     * @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct[] $locationCreateStructs
846
     *
847
     * @return \eZ\Publish\SPI\Persistence\Content\Location\CreateStruct[]
848
     */
849
    protected function buildSPILocationCreateStructs(array $locationCreateStructs)
850
    {
851
        $spiLocationCreateStructs = [];
852
        $parentLocationIdSet = [];
853
        $mainLocation = true;
854
855
        foreach ($locationCreateStructs as $locationCreateStruct) {
856
            if (isset($parentLocationIdSet[$locationCreateStruct->parentLocationId])) {
857
                throw new InvalidArgumentException(
858
                    '$locationCreateStructs',
859
                    "Multiple LocationCreateStructs with the same parent Location '{$locationCreateStruct->parentLocationId}' are given"
860
                );
861
            }
862
863
            if (!array_key_exists($locationCreateStruct->sortField, Location::SORT_FIELD_MAP)) {
864
                $locationCreateStruct->sortField = Location::SORT_FIELD_NAME;
865
            }
866
867
            if (!array_key_exists($locationCreateStruct->sortOrder, Location::SORT_ORDER_MAP)) {
868
                $locationCreateStruct->sortOrder = Location::SORT_ORDER_ASC;
869
            }
870
871
            $parentLocationIdSet[$locationCreateStruct->parentLocationId] = true;
872
            $parentLocation = $this->repository->getLocationService()->loadLocation(
873
                $locationCreateStruct->parentLocationId
874
            );
875
876
            $spiLocationCreateStructs[] = $this->domainMapper->buildSPILocationCreateStruct(
877
                $locationCreateStruct,
878
                $parentLocation,
879
                $mainLocation,
880
                // For Content draft contentId and contentVersionNo are set in ContentHandler upon draft creation
881
                null,
882
                null
883
            );
884
885
            // First Location in the list will be created as main Location
886
            $mainLocation = false;
887
        }
888
889
        return $spiLocationCreateStructs;
890
    }
891
892
    /**
893
     * Updates the metadata.
894
     *
895
     * (see {@link ContentMetadataUpdateStruct}) of a content object - to update fields use updateContent
896
     *
897
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to update the content meta data
898
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the remoteId in $contentMetadataUpdateStruct is set but already exists
899
     *
900
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
901
     * @param \eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct $contentMetadataUpdateStruct
902
     *
903
     * @return \eZ\Publish\API\Repository\Values\Content\Content the content with the updated attributes
904
     */
905
    public function updateContentMetadata(ContentInfo $contentInfo, ContentMetadataUpdateStruct $contentMetadataUpdateStruct)
906
    {
907
        $propertyCount = 0;
908
        foreach ($contentMetadataUpdateStruct as $propertyName => $propertyValue) {
0 ignored issues
show
Bug introduced by
The expression $contentMetadataUpdateStruct of type object<eZ\Publish\API\Re...ntMetadataUpdateStruct> is not traversable.
Loading history...
909
            if (isset($contentMetadataUpdateStruct->$propertyName)) {
910
                $propertyCount += 1;
911
            }
912
        }
913
        if ($propertyCount === 0) {
914
            throw new InvalidArgumentException(
915
                '$contentMetadataUpdateStruct',
916
                'At least one property must be set'
917
            );
918
        }
919
920
        $loadedContentInfo = $this->loadContentInfo($contentInfo->id);
921
922
        if (!$this->repository->canUser('content', 'edit', $loadedContentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
923
            throw new UnauthorizedException('content', 'edit', ['contentId' => $loadedContentInfo->id]);
924
        }
925
926
        if (isset($contentMetadataUpdateStruct->remoteId)) {
927
            try {
928
                $existingContentInfo = $this->loadContentInfoByRemoteId($contentMetadataUpdateStruct->remoteId);
929
930
                if ($existingContentInfo->id !== $loadedContentInfo->id) {
931
                    throw new InvalidArgumentException(
932
                        '$contentMetadataUpdateStruct',
933
                        "Another content with remoteId '{$contentMetadataUpdateStruct->remoteId}' exists"
934
                    );
935
                }
936
            } catch (APINotFoundException $e) {
937
                // Do nothing
938
            }
939
        }
940
941
        $this->repository->beginTransaction();
942
        try {
943
            if ($propertyCount > 1 || !isset($contentMetadataUpdateStruct->mainLocationId)) {
944
                $this->persistenceHandler->contentHandler()->updateMetadata(
945
                    $loadedContentInfo->id,
946
                    new SPIMetadataUpdateStruct(
947
                        [
948
                            'ownerId' => $contentMetadataUpdateStruct->ownerId,
949
                            'publicationDate' => isset($contentMetadataUpdateStruct->publishedDate) ?
950
                                $contentMetadataUpdateStruct->publishedDate->getTimestamp() :
951
                                null,
952
                            'modificationDate' => isset($contentMetadataUpdateStruct->modificationDate) ?
953
                                $contentMetadataUpdateStruct->modificationDate->getTimestamp() :
954
                                null,
955
                            'mainLanguageId' => isset($contentMetadataUpdateStruct->mainLanguageCode) ?
956
                                $this->repository->getContentLanguageService()->loadLanguage(
957
                                    $contentMetadataUpdateStruct->mainLanguageCode
958
                                )->id :
959
                                null,
960
                            'alwaysAvailable' => $contentMetadataUpdateStruct->alwaysAvailable,
961
                            'remoteId' => $contentMetadataUpdateStruct->remoteId,
962
                            'name' => $contentMetadataUpdateStruct->name,
963
                        ]
964
                    )
965
                );
966
            }
967
968
            // Change main location
969
            if (isset($contentMetadataUpdateStruct->mainLocationId)
970
                && $loadedContentInfo->mainLocationId !== $contentMetadataUpdateStruct->mainLocationId) {
971
                $this->persistenceHandler->locationHandler()->changeMainLocation(
972
                    $loadedContentInfo->id,
973
                    $contentMetadataUpdateStruct->mainLocationId
974
                );
975
            }
976
977
            // Republish URL aliases to update always-available flag
978
            if (isset($contentMetadataUpdateStruct->alwaysAvailable)
979
                && $loadedContentInfo->alwaysAvailable !== $contentMetadataUpdateStruct->alwaysAvailable) {
980
                $content = $this->loadContent($loadedContentInfo->id);
981
                $this->publishUrlAliasesForContent($content, false);
982
            }
983
984
            $this->repository->commit();
985
        } catch (Exception $e) {
986
            $this->repository->rollback();
987
            throw $e;
988
        }
989
990
        return isset($content) ? $content : $this->loadContent($loadedContentInfo->id);
991
    }
992
993
    /**
994
     * Publishes URL aliases for all locations of a given content.
995
     *
996
     * @param \eZ\Publish\API\Repository\Values\Content\Content $content
997
     * @param bool $updatePathIdentificationString this parameter is legacy storage specific for updating
998
     *                      ezcontentobject_tree.path_identification_string, it is ignored by other storage engines
999
     */
1000
    protected function publishUrlAliasesForContent(APIContent $content, $updatePathIdentificationString = true)
1001
    {
1002
        $urlAliasNames = $this->nameSchemaService->resolveUrlAliasSchema($content);
1003
        $locations = $this->repository->getLocationService()->loadLocations(
1004
            $content->getVersionInfo()->getContentInfo()
1005
        );
1006
        $urlAliasHandler = $this->persistenceHandler->urlAliasHandler();
1007
        foreach ($locations as $location) {
1008
            foreach ($urlAliasNames as $languageCode => $name) {
1009
                $urlAliasHandler->publishUrlAliasForLocation(
1010
                    $location->id,
1011
                    $location->parentLocationId,
1012
                    $name,
1013
                    $languageCode,
1014
                    $content->contentInfo->alwaysAvailable,
1015
                    $updatePathIdentificationString ? $languageCode === $content->contentInfo->mainLanguageCode : false
0 ignored issues
show
Unused Code Bug introduced by
The strict comparison === seems to always evaluate to false as the types of $languageCode (integer) and $content->contentInfo->mainLanguageCode (string) can never be identical. Maybe you want to use a loose comparison == instead?
Loading history...
1016
                );
1017
            }
1018
            // archive URL aliases of Translations that got deleted
1019
            $urlAliasHandler->archiveUrlAliasesForDeletedTranslations(
1020
                $location->id,
1021
                $location->parentLocationId,
1022
                $content->versionInfo->languageCodes
1023
            );
1024
        }
1025
    }
1026
1027
    /**
1028
     * Deletes a content object including all its versions and locations including their subtrees.
1029
     *
1030
     * @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)
1031
     *
1032
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
1033
     *
1034
     * @return mixed[] Affected Location Id's
1035
     */
1036
    public function deleteContent(ContentInfo $contentInfo)
1037
    {
1038
        $contentInfo = $this->internalLoadContentInfo($contentInfo->id);
1039
1040
        if (!$this->repository->canUser('content', 'remove', $contentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1041
            throw new UnauthorizedException('content', 'remove', ['contentId' => $contentInfo->id]);
1042
        }
1043
1044
        $affectedLocations = [];
1045
        $this->repository->beginTransaction();
1046
        try {
1047
            // Load Locations first as deleting Content also deletes belonging Locations
1048
            $spiLocations = $this->persistenceHandler->locationHandler()->loadLocationsByContent($contentInfo->id);
1049
            $this->persistenceHandler->contentHandler()->deleteContent($contentInfo->id);
1050
            $urlAliasHandler = $this->persistenceHandler->urlAliasHandler();
1051
            foreach ($spiLocations as $spiLocation) {
1052
                $urlAliasHandler->locationDeleted($spiLocation->id);
1053
                $affectedLocations[] = $spiLocation->id;
1054
            }
1055
            $this->repository->commit();
1056
        } catch (Exception $e) {
1057
            $this->repository->rollback();
1058
            throw $e;
1059
        }
1060
1061
        return $affectedLocations;
1062
    }
1063
1064
    /**
1065
     * Creates a draft from a published or archived version.
1066
     *
1067
     * If no version is given, the current published version is used.
1068
     *
1069
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
1070
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
1071
     * @param \eZ\Publish\API\Repository\Values\User\User $creator if set given user is used to create the draft - otherwise the current-user is used
1072
     * @param \eZ\Publish\API\Repository\Values\Content\Language|null if not set the draft is created with the initialLanguage code of the source version or if not present with the main language.
1073
     *
1074
     * @return \eZ\Publish\API\Repository\Values\Content\Content - the newly created content draft
1075
     *
1076
     * @throws \eZ\Publish\API\Repository\Exceptions\ForbiddenException
1077
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if the current-user is not allowed to create the draft
1078
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the current-user is not allowed to create the draft
1079
     */
1080
    public function createContentDraft(
1081
        ContentInfo $contentInfo,
1082
        APIVersionInfo $versionInfo = null,
1083
        User $creator = null,
1084
        ?Language $language = null
1085
    ) {
1086
        $contentInfo = $this->loadContentInfo($contentInfo->id);
1087
1088
        if ($versionInfo !== null) {
1089
            // Check that given $contentInfo and $versionInfo belong to the same content
1090
            if ($versionInfo->getContentInfo()->id != $contentInfo->id) {
1091
                throw new InvalidArgumentException(
1092
                    '$versionInfo',
1093
                    'VersionInfo does not belong to the same content as given ContentInfo'
1094
                );
1095
            }
1096
1097
            $versionInfo = $this->loadVersionInfoById($contentInfo->id, $versionInfo->versionNo);
1098
1099
            switch ($versionInfo->status) {
1100
                case VersionInfo::STATUS_PUBLISHED:
1101
                case VersionInfo::STATUS_ARCHIVED:
1102
                    break;
1103
1104
                default:
1105
                    // @todo: throw an exception here, to be defined
1106
                    throw new BadStateException(
1107
                        '$versionInfo',
1108
                        'Draft can not be created from a draft version'
1109
                    );
1110
            }
1111
1112
            $versionNo = $versionInfo->versionNo;
1113
        } elseif ($contentInfo->published) {
1114
            $versionNo = $contentInfo->currentVersionNo;
1115
        } else {
1116
            // @todo: throw an exception here, to be defined
1117
            throw new BadStateException(
1118
                '$contentInfo',
1119
                'Content is not published, draft can be created only from published or archived version'
1120
            );
1121
        }
1122
1123
        if ($creator === null) {
1124
            $creator = $this->repository->getCurrentUserReference();
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Reposito...tCurrentUserReference() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::getCurrentUserReference() instead. Get current user reference.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1125
        }
1126
1127
        $fallbackLanguageCode = $versionInfo->initialLanguageCode ?? $contentInfo->mainLanguageCode;
1128
        $languageCode = $language->languageCode ?? $fallbackLanguageCode;
1129
1130
        if (!$this->repository->getPermissionResolver()->canUser(
1131
            'content',
1132
            'edit',
1133
            $contentInfo,
1134
            [
1135
                (new Target\Builder\VersionBuilder())
1136
                    ->changeStatusTo(APIVersionInfo::STATUS_DRAFT)
1137
                    ->build(),
1138
            ]
1139
        )) {
1140
            throw new UnauthorizedException(
1141
                'content',
1142
                'edit',
1143
                ['contentId' => $contentInfo->id]
1144
            );
1145
        }
1146
1147
        $this->repository->beginTransaction();
1148
        try {
1149
            $spiContent = $this->persistenceHandler->contentHandler()->createDraftFromVersion(
1150
                $contentInfo->id,
1151
                $versionNo,
1152
                $creator->getUserId(),
1153
                $languageCode
1154
            );
1155
            $this->repository->commit();
1156
        } catch (Exception $e) {
1157
            $this->repository->rollback();
1158
            throw $e;
1159
        }
1160
1161
        return $this->domainMapper->buildContentDomainObject(
1162
            $spiContent,
1163
            $this->repository->getContentTypeService()->loadContentType(
1164
                $spiContent->versionInfo->contentInfo->contentTypeId
1165
            )
1166
        );
1167
    }
1168
1169
    /**
1170
     * {@inheritdoc}
1171
     */
1172
    public function countContentDrafts(?User $user = null): int
1173
    {
1174
        if ($this->repository->hasAccess('content', 'versionread') === false) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::hasAccess() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::hasAccess() instead. Check if user has access to a given module / function. Low level function, use canUser instead if you have objects to check against.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1175
            return 0;
1176
        }
1177
1178
        return $this->persistenceHandler->contentHandler()->countDraftsForUser(
1179
            $this->resolveUser($user)->getUserId()
1180
        );
1181
    }
1182
1183
    /**
1184
     * Loads drafts for a user.
1185
     *
1186
     * If no user is given the drafts for the authenticated user are returned
1187
     *
1188
     * @param \eZ\Publish\API\Repository\Values\User\User|null $user
1189
     *
1190
     * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo[] Drafts owned by the given user
1191
     *
1192
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException
1193
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
1194
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException
1195
     */
1196
    public function loadContentDrafts(User $user = null)
1197
    {
1198
        // throw early if user has absolutely no access to versionread
1199
        if ($this->repository->hasAccess('content', 'versionread') === false) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::hasAccess() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::hasAccess() instead. Check if user has access to a given module / function. Low level function, use canUser instead if you have objects to check against.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1200
            throw new UnauthorizedException('content', 'versionread');
1201
        }
1202
1203
        $spiVersionInfoList = $this->persistenceHandler->contentHandler()->loadDraftsForUser(
1204
            $this->resolveUser($user)->getUserId()
1205
        );
1206
        $versionInfoList = [];
1207
        foreach ($spiVersionInfoList as $spiVersionInfo) {
1208
            $versionInfo = $this->domainMapper->buildVersionInfoDomainObject($spiVersionInfo);
1209
            // @todo: Change this to filter returned drafts by permissions instead of throwing
1210
            if (!$this->repository->canUser('content', 'versionread', $versionInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1211
                throw new UnauthorizedException('content', 'versionread', ['contentId' => $versionInfo->contentInfo->id]);
1212
            }
1213
1214
            $versionInfoList[] = $versionInfo;
1215
        }
1216
1217
        return $versionInfoList;
1218
    }
1219
1220
    /**
1221
     * {@inheritdoc}
1222
     */
1223
    public function loadContentDraftList(?User $user = null, int $offset = 0, int $limit = -1): ContentDraftList
1224
    {
1225
        $list = new ContentDraftList();
1226
        if ($this->repository->hasAccess('content', 'versionread') === false) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::hasAccess() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::hasAccess() instead. Check if user has access to a given module / function. Low level function, use canUser instead if you have objects to check against.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1227
            return $list;
1228
        }
1229
1230
        $list->totalCount = $this->persistenceHandler->contentHandler()->countDraftsForUser(
1231
            $this->resolveUser($user)->getUserId()
1232
        );
1233
        if ($list->totalCount > 0) {
1234
            $spiVersionInfoList = $this->persistenceHandler->contentHandler()->loadDraftListForUser(
1235
                $this->resolveUser($user)->getUserId(),
1236
                $offset,
1237
                $limit
1238
            );
1239
            foreach ($spiVersionInfoList as $spiVersionInfo) {
1240
                $versionInfo = $this->domainMapper->buildVersionInfoDomainObject($spiVersionInfo);
1241
                if ($this->repository->canUser('content', 'versionread', $versionInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1242
                    $list->items[] = new ContentDraftListItem($versionInfo);
1243
                } else {
1244
                    $list->items[] = new UnauthorizedContentDraftListItem(
1245
                        'content',
1246
                        'versionread',
1247
                        ['contentId' => $versionInfo->contentInfo->id]
1248
                    );
1249
                }
1250
            }
1251
        }
1252
1253
        return $list;
1254
    }
1255
1256
    /**
1257
     * Updates the fields of a draft.
1258
     *
1259
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
1260
     * @param \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct $contentUpdateStruct
1261
     *
1262
     * @return \eZ\Publish\API\Repository\Values\Content\Content the content draft with the updated fields
1263
     *
1264
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $contentCreateStruct is not valid,
1265
     *                                                                               or if a required field is missing / set to an empty value.
1266
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException If field definition does not exist in the ContentType,
1267
     *                                                                          or value is set for non-translatable field in language
1268
     *                                                                          other than main.
1269
     *
1270
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to update this version
1271
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
1272
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if a property on the struct is invalid.
1273
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
1274
     */
1275
    public function updateContent(APIVersionInfo $versionInfo, APIContentUpdateStruct $contentUpdateStruct)
1276
    {
1277
        $contentUpdateStruct = clone $contentUpdateStruct;
1278
1279
        /** @var $content \eZ\Publish\Core\Repository\Values\Content\Content */
1280
        $content = $this->loadContent(
1281
            $versionInfo->getContentInfo()->id,
1282
            null,
1283
            $versionInfo->versionNo
1284
        );
1285
        if (!$content->versionInfo->isDraft()) {
1286
            throw new BadStateException(
1287
                '$versionInfo',
1288
                'Version is not a draft and can not be updated'
1289
            );
1290
        }
1291
1292
        if (!$this->repository->getPermissionResolver()->canUser(
1293
            'content',
1294
            'edit',
1295
            $content,
1296
            [
1297
                (new Target\Builder\VersionBuilder())
1298
                    ->updateFieldsTo(
1299
                        $contentUpdateStruct->initialLanguageCode,
1300
                        $contentUpdateStruct->fields
1301
                    )
1302
                    ->build(),
1303
            ]
1304
        )) {
1305
            throw new UnauthorizedException('content', 'edit', ['contentId' => $content->id]);
1306
        }
1307
1308
        $mainLanguageCode = $content->contentInfo->mainLanguageCode;
1309
        if ($contentUpdateStruct->initialLanguageCode === null) {
1310
            $contentUpdateStruct->initialLanguageCode = $mainLanguageCode;
1311
        }
1312
1313
        $allLanguageCodes = $this->getLanguageCodesForUpdate($contentUpdateStruct, $content);
1314
        $contentLanguageHandler = $this->persistenceHandler->contentLanguageHandler();
1315
        foreach ($allLanguageCodes as $languageCode) {
1316
            $contentLanguageHandler->loadByLanguageCode($languageCode);
1317
        }
1318
1319
        $updatedLanguageCodes = $this->getUpdatedLanguageCodes($contentUpdateStruct);
1320
        $contentType = $this->repository->getContentTypeService()->loadContentType(
1321
            $content->contentInfo->contentTypeId
1322
        );
1323
        $fields = $this->mapFieldsForUpdate(
1324
            $contentUpdateStruct,
1325
            $contentType,
1326
            $mainLanguageCode
1327
        );
1328
1329
        $fieldValues = [];
1330
        $spiFields = [];
1331
        $allFieldErrors = [];
1332
        $inputRelations = [];
1333
        $locationIdToContentIdMapping = [];
1334
1335
        foreach ($contentType->getFieldDefinitions() as $fieldDefinition) {
1336
            /** @var $fieldType \eZ\Publish\SPI\FieldType\FieldType */
1337
            $fieldType = $this->fieldTypeRegistry->getFieldType(
1338
                $fieldDefinition->fieldTypeIdentifier
1339
            );
1340
1341
            foreach ($allLanguageCodes as $languageCode) {
1342
                $isCopied = $isEmpty = $isRetained = false;
1343
                $isLanguageNew = !in_array($languageCode, $content->versionInfo->languageCodes);
1344
                $isLanguageUpdated = in_array($languageCode, $updatedLanguageCodes);
1345
                $valueLanguageCode = $fieldDefinition->isTranslatable ? $languageCode : $mainLanguageCode;
1346
                $isFieldUpdated = isset($fields[$fieldDefinition->identifier][$valueLanguageCode]);
1347
                $isProcessed = isset($fieldValues[$fieldDefinition->identifier][$valueLanguageCode]);
1348
1349
                if (!$isFieldUpdated && !$isLanguageNew) {
1350
                    $isRetained = true;
1351
                    $fieldValue = $content->getField($fieldDefinition->identifier, $valueLanguageCode)->value;
1352
                } elseif (!$isFieldUpdated && $isLanguageNew && !$fieldDefinition->isTranslatable) {
1353
                    $isCopied = true;
1354
                    $fieldValue = $content->getField($fieldDefinition->identifier, $valueLanguageCode)->value;
1355
                } elseif ($isFieldUpdated) {
1356
                    $fieldValue = $fields[$fieldDefinition->identifier][$valueLanguageCode]->value;
1357
                } else {
1358
                    $fieldValue = $fieldDefinition->defaultValue;
1359
                }
1360
1361
                $fieldValue = $fieldType->acceptValue($fieldValue);
1362
1363
                if ($fieldType->isEmptyValue($fieldValue)) {
1364
                    $isEmpty = true;
1365
                    if ($isLanguageUpdated && $fieldDefinition->isRequired) {
1366
                        $allFieldErrors[$fieldDefinition->id][$languageCode] = new ValidationError(
1367
                            "Value for required field definition '%identifier%' with language '%languageCode%' is empty",
1368
                            null,
1369
                            ['%identifier%' => $fieldDefinition->identifier, '%languageCode%' => $languageCode],
1370
                            'empty'
1371
                        );
1372
                    }
1373
                } elseif ($isLanguageUpdated) {
1374
                    $fieldErrors = $fieldType->validate(
1375
                        $fieldDefinition,
1376
                        $fieldValue
1377
                    );
1378
                    if (!empty($fieldErrors)) {
1379
                        $allFieldErrors[$fieldDefinition->id][$languageCode] = $fieldErrors;
1380
                    }
1381
                }
1382
1383
                if (!empty($allFieldErrors)) {
1384
                    continue;
1385
                }
1386
1387
                $this->relationProcessor->appendFieldRelations(
1388
                    $inputRelations,
1389
                    $locationIdToContentIdMapping,
1390
                    $fieldType,
1391
                    $fieldValue,
0 ignored issues
show
Compatibility introduced by
$fieldValue of type object<eZ\Publish\SPI\FieldType\Value> is not a sub-type of object<eZ\Publish\Core\FieldType\Value>. It seems like you assume a concrete implementation of the interface eZ\Publish\SPI\FieldType\Value to be always present.

This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass.

Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type.

Loading history...
1392
                    $fieldDefinition->id
1393
                );
1394
                $fieldValues[$fieldDefinition->identifier][$languageCode] = $fieldValue;
1395
1396
                if ($isRetained || $isCopied || ($isLanguageNew && $isEmpty) || $isProcessed) {
1397
                    continue;
1398
                }
1399
1400
                $spiFields[] = new SPIField(
1401
                    [
1402
                        'id' => $isLanguageNew ?
1403
                            null :
1404
                            $content->getField($fieldDefinition->identifier, $languageCode)->id,
1405
                        'fieldDefinitionId' => $fieldDefinition->id,
1406
                        'type' => $fieldDefinition->fieldTypeIdentifier,
1407
                        'value' => $fieldType->toPersistenceValue($fieldValue),
1408
                        'languageCode' => $languageCode,
1409
                        'versionNo' => $versionInfo->versionNo,
1410
                    ]
1411
                );
1412
            }
1413
        }
1414
1415
        if (!empty($allFieldErrors)) {
1416
            throw new ContentFieldValidationException($allFieldErrors);
1417
        }
1418
1419
        $spiContentUpdateStruct = new SPIContentUpdateStruct(
1420
            [
1421
                'name' => $this->nameSchemaService->resolveNameSchema(
1422
                    $content,
1423
                    $fieldValues,
1424
                    $allLanguageCodes,
1425
                    $contentType
1426
                ),
1427
                'creatorId' => $contentUpdateStruct->creatorId ?: $this->repository->getCurrentUserReference()->getUserId(),
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Reposito...tCurrentUserReference() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::getCurrentUserReference() instead. Get current user reference.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1428
                'fields' => $spiFields,
1429
                'modificationDate' => time(),
1430
                'initialLanguageId' => $this->persistenceHandler->contentLanguageHandler()->loadByLanguageCode(
1431
                    $contentUpdateStruct->initialLanguageCode
1432
                )->id,
1433
            ]
1434
        );
1435
        $existingRelations = $this->loadRelations($versionInfo);
1436
1437
        $this->repository->beginTransaction();
1438
        try {
1439
            $spiContent = $this->persistenceHandler->contentHandler()->updateContent(
1440
                $versionInfo->getContentInfo()->id,
1441
                $versionInfo->versionNo,
1442
                $spiContentUpdateStruct
1443
            );
1444
            $this->relationProcessor->processFieldRelations(
1445
                $inputRelations,
1446
                $spiContent->versionInfo->contentInfo->id,
1447
                $spiContent->versionInfo->versionNo,
1448
                $contentType,
1449
                $existingRelations
1450
            );
1451
            $this->repository->commit();
1452
        } catch (Exception $e) {
1453
            $this->repository->rollback();
1454
            throw $e;
1455
        }
1456
1457
        return $this->domainMapper->buildContentDomainObject(
1458
            $spiContent,
1459
            $contentType
1460
        );
1461
    }
1462
1463
    /**
1464
     * Returns only updated language codes.
1465
     *
1466
     * @param \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct $contentUpdateStruct
1467
     *
1468
     * @return array
1469
     */
1470
    private function getUpdatedLanguageCodes(APIContentUpdateStruct $contentUpdateStruct)
1471
    {
1472
        $languageCodes = [
1473
            $contentUpdateStruct->initialLanguageCode => true,
1474
        ];
1475
1476
        foreach ($contentUpdateStruct->fields as $field) {
1477
            if ($field->languageCode === null || isset($languageCodes[$field->languageCode])) {
1478
                continue;
1479
            }
1480
1481
            $languageCodes[$field->languageCode] = true;
1482
        }
1483
1484
        return array_keys($languageCodes);
1485
    }
1486
1487
    /**
1488
     * Returns all language codes used in given $fields.
1489
     *
1490
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if no field value exists in initial language
1491
     *
1492
     * @param \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct $contentUpdateStruct
1493
     * @param \eZ\Publish\API\Repository\Values\Content\Content $content
1494
     *
1495
     * @return array
1496
     */
1497
    protected function getLanguageCodesForUpdate(APIContentUpdateStruct $contentUpdateStruct, APIContent $content)
1498
    {
1499
        $languageCodes = array_fill_keys($content->versionInfo->languageCodes, true);
1500
        $languageCodes[$contentUpdateStruct->initialLanguageCode] = true;
1501
1502
        $updatedLanguageCodes = $this->getUpdatedLanguageCodes($contentUpdateStruct);
1503
        foreach ($updatedLanguageCodes as $languageCode) {
1504
            $languageCodes[$languageCode] = true;
1505
        }
1506
1507
        return array_keys($languageCodes);
1508
    }
1509
1510
    /**
1511
     * Returns an array of fields like $fields[$field->fieldDefIdentifier][$field->languageCode].
1512
     *
1513
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException If field definition does not exist in the ContentType
1514
     *                                                                          or value is set for non-translatable field in language
1515
     *                                                                          other than main
1516
     *
1517
     * @param \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct $contentUpdateStruct
1518
     * @param \eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType
1519
     * @param string $mainLanguageCode
1520
     *
1521
     * @return array
1522
     */
1523
    protected function mapFieldsForUpdate(
1524
        APIContentUpdateStruct $contentUpdateStruct,
1525
        ContentType $contentType,
1526
        $mainLanguageCode
1527
    ) {
1528
        $fields = [];
1529
1530
        foreach ($contentUpdateStruct->fields as $field) {
1531
            $fieldDefinition = $contentType->getFieldDefinition($field->fieldDefIdentifier);
1532
1533
            if ($fieldDefinition === null) {
1534
                throw new ContentValidationException(
1535
                    "Field definition '%identifier%' does not exist in given ContentType",
1536
                    ['%identifier%' => $field->fieldDefIdentifier]
1537
                );
1538
            }
1539
1540
            if ($field->languageCode === null) {
1541
                if ($fieldDefinition->isTranslatable) {
1542
                    $languageCode = $contentUpdateStruct->initialLanguageCode;
1543
                } else {
1544
                    $languageCode = $mainLanguageCode;
1545
                }
1546
                $field = $this->cloneField($field, ['languageCode' => $languageCode]);
1547
            }
1548
1549
            if (!$fieldDefinition->isTranslatable && ($field->languageCode != $mainLanguageCode)) {
1550
                throw new ContentValidationException(
1551
                    "A value is set for non translatable field definition '%identifier%' with language '%languageCode%'",
1552
                    ['%identifier%' => $field->fieldDefIdentifier, '%languageCode%' => $field->languageCode]
1553
                );
1554
            }
1555
1556
            $fields[$field->fieldDefIdentifier][$field->languageCode] = $field;
1557
        }
1558
1559
        return $fields;
1560
    }
1561
1562
    /**
1563
     * Publishes a content version.
1564
     *
1565
     * Publishes a content version and deletes archive versions if they overflow max archive versions.
1566
     * Max archive versions are currently a configuration, but might be moved to be a param of ContentType in the future.
1567
     *
1568
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
1569
     * @param string[] $translations
1570
     *
1571
     * @return \eZ\Publish\API\Repository\Values\Content\Content
1572
     *
1573
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
1574
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException
1575
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
1576
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
1577
     */
1578
    public function publishVersion(APIVersionInfo $versionInfo, array $translations = Language::ALL)
1579
    {
1580
        $content = $this->internalLoadContent(
1581
            $versionInfo->contentInfo->id,
1582
            null,
1583
            $versionInfo->versionNo
1584
        );
1585
1586
        $fromContent = null;
0 ignored issues
show
Unused Code introduced by
$fromContent is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
1587
        if ($content->contentInfo->currentVersionNo !== $versionInfo->versionNo) {
1588
            $fromContent = $this->internalLoadContent(
1589
                $content->contentInfo->id,
1590
                null,
1591
                $content->contentInfo->currentVersionNo
1592
            );
1593
            // should not occur now, might occur in case of un-publish
1594
            if (!$fromContent->contentInfo->isPublished()) {
1595
                $fromContent = null;
0 ignored issues
show
Unused Code introduced by
$fromContent is not used, you could remove the assignment.

This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently.

$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}

Both the $myVar assignment in line 1 and the $higher assignment in line 2 are dead. The first because $myVar is never used and the second because $higher is always overwritten for every possible time line.

Loading history...
1596
            }
1597
        }
1598
1599
        if (!$this->repository->getPermissionResolver()->canUser(
1600
            'content',
1601
            'publish',
1602
            $content
1603
        )) {
1604
            throw new UnauthorizedException(
1605
                'content', 'publish', ['contentId' => $content->id]
1606
            );
1607
        }
1608
1609
        $this->repository->beginTransaction();
1610
        try {
1611
            $this->copyTranslationsFromPublishedVersion($content->versionInfo, $translations);
1612
            $content = $this->internalPublishVersion($content->getVersionInfo(), null);
1613
            $this->repository->commit();
1614
        } catch (Exception $e) {
1615
            $this->repository->rollback();
1616
            throw $e;
1617
        }
1618
1619
        return $content;
1620
    }
1621
1622
    /**
1623
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
1624
     * @param array $translations
1625
     *
1626
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException
1627
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException
1628
     * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException
1629
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException
1630
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException
1631
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException
1632
     */
1633
    protected function copyTranslationsFromPublishedVersion(APIVersionInfo $versionInfo, array $translations = []): void
1634
    {
1635
        $contendId = $versionInfo->contentInfo->id;
1636
1637
        $currentContent = $this->internalLoadContent($contendId);
1638
        $currentVersionInfo = $currentContent->versionInfo;
1639
1640
        // Copying occurs only if:
1641
        // - There is published Version
1642
        // - Published version is older than the currently published one unless specific translations are provided.
1643
        if (!$currentVersionInfo->isPublished() ||
1644
            ($versionInfo->versionNo >= $currentVersionInfo->versionNo && empty($translations))) {
1645
            return;
1646
        }
1647
1648
        if (empty($translations)) {
1649
            $languagesToCopy = array_diff(
1650
                $currentVersionInfo->languageCodes,
1651
                $versionInfo->languageCodes
1652
            );
1653
        } else {
1654
            $languagesToCopy = array_diff(
1655
                $currentVersionInfo->languageCodes,
1656
                $translations
1657
            );
1658
        }
1659
1660
        if (empty($languagesToCopy)) {
1661
            return;
1662
        }
1663
1664
        $contentType = $this->repository->getContentTypeService()->loadContentType(
1665
            $currentVersionInfo->contentInfo->contentTypeId
1666
        );
1667
1668
        // Find only translatable fields to update with selected languages
1669
        $updateStruct = $this->newContentUpdateStruct();
1670
        $updateStruct->initialLanguageCode = $versionInfo->initialLanguageCode;
1671
1672
        $contentToPublish = $this->internalLoadContent($contendId, null, $versionInfo->versionNo);
1673
        $fallback = [];
1674
1675
        foreach ($currentContent->getFields() as $field) {
1676
            $fieldDefinition = $contentType->getFieldDefinition($field->fieldDefIdentifier);
1677
1678
            if (!$fieldDefinition->isTranslatable || !\in_array($field->languageCode, $languagesToCopy)) {
1679
                continue;
1680
            }
1681
1682
            $fieldType = $this->fieldTypeRegistry->getFieldType(
1683
                $fieldDefinition->fieldTypeIdentifier
1684
            );
1685
1686
            $newValue = $contentToPublish->getFieldValue(
1687
                $fieldDefinition->identifier,
1688
                $field->languageCode
1689
            );
1690
1691
            $value = $field->value;
1692
            if ($fieldDefinition->isRequired && $fieldType->isEmptyValue($value)) {
1693
                if (!$fieldType->isEmptyValue($fieldDefinition->defaultValue)) {
1694
                    $value = $fieldDefinition->defaultValue;
1695
                } else {
1696
                    $value = $contentToPublish->getFieldValue($field->fieldDefIdentifier, $versionInfo->initialLanguageCode);
1697
                }
1698
                $fallback[] = [
1699
                    'fieldDefIdentifier' => $field->fieldDefIdentifier,
1700
                    'value' => $value,
1701
                    'languageCode' => $field->languageCode,
1702
                ];
1703
                continue;
1704
            }
1705
1706
            if ($newValue == $field->value) {
1707
                continue;
1708
            }
1709
1710
            $updateStruct->setField($field->fieldDefIdentifier, $value, $field->languageCode);
1711
        }
1712
1713
        // Nothing to copy, skip update
1714
        if (empty($updateStruct->fields)) {
1715
            return;
1716
        }
1717
1718
        // Do fallback only if content needs to be updated
1719
        foreach ($fallback as $fallbackStruct) {
1720
            $updateStruct->setField($fallbackStruct['fieldDefIdentifier'], $fallbackStruct['value'], $fallbackStruct['languageCode']);
1721
        }
1722
1723
        $this->updateContent($versionInfo, $updateStruct);
1724
    }
1725
1726
    /**
1727
     * Publishes a content version.
1728
     *
1729
     * Publishes a content version and deletes archive versions if they overflow max archive versions.
1730
     * Max archive versions are currently a configuration, but might be moved to be a param of ContentType in the future.
1731
     *
1732
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
1733
     *
1734
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
1735
     * @param int|null $publicationDate If null existing date is kept if there is one, otherwise current time is used.
1736
     *
1737
     * @return \eZ\Publish\API\Repository\Values\Content\Content
1738
     */
1739
    protected function internalPublishVersion(APIVersionInfo $versionInfo, $publicationDate = null)
1740
    {
1741
        if (!$versionInfo->isDraft()) {
1742
            throw new BadStateException('$versionInfo', 'Only versions in draft status can be published.');
1743
        }
1744
1745
        $currentTime = $this->getUnixTimestamp();
1746
        if ($publicationDate === null && $versionInfo->versionNo === 1) {
1747
            $publicationDate = $currentTime;
1748
        }
1749
1750
        $contentInfo = $versionInfo->getContentInfo();
1751
        $metadataUpdateStruct = new SPIMetadataUpdateStruct();
1752
        $metadataUpdateStruct->publicationDate = $publicationDate;
1753
        $metadataUpdateStruct->modificationDate = $currentTime;
1754
        $metadataUpdateStruct->isHidden = $contentInfo->isHidden;
1755
1756
        $contentId = $contentInfo->id;
1757
        $spiContent = $this->persistenceHandler->contentHandler()->publish(
1758
            $contentId,
1759
            $versionInfo->versionNo,
1760
            $metadataUpdateStruct
1761
        );
1762
1763
        $content = $this->domainMapper->buildContentDomainObject(
1764
            $spiContent,
1765
            $this->repository->getContentTypeService()->loadContentType(
1766
                $spiContent->versionInfo->contentInfo->contentTypeId
1767
            )
1768
        );
1769
1770
        $this->publishUrlAliasesForContent($content);
1771
1772
        // Delete version archive overflow if any, limit is 0-50 (however 0 will mean 1 if content is unpublished)
1773
        $archiveList = $this->persistenceHandler->contentHandler()->listVersions(
1774
            $contentId,
1775
            APIVersionInfo::STATUS_ARCHIVED,
1776
            100 // Limited to avoid publishing taking to long, besides SE limitations this is why limit is max 50
1777
        );
1778
1779
        $maxVersionArchiveCount = max(0, min(50, $this->settings['default_version_archive_limit']));
1780
        while (!empty($archiveList) && count($archiveList) > $maxVersionArchiveCount) {
1781
            /** @var \eZ\Publish\SPI\Persistence\Content\VersionInfo $archiveVersion */
1782
            $archiveVersion = array_shift($archiveList);
1783
            $this->persistenceHandler->contentHandler()->deleteVersion(
1784
                $contentId,
1785
                $archiveVersion->versionNo
1786
            );
1787
        }
1788
1789
        return $content;
1790
    }
1791
1792
    /**
1793
     * @return int
1794
     */
1795
    protected function getUnixTimestamp()
1796
    {
1797
        return time();
1798
    }
1799
1800
    /**
1801
     * Removes the given version.
1802
     *
1803
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is in
1804
     *         published state or is a last version of Content in non draft state
1805
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to remove this version
1806
     *
1807
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
1808
     */
1809
    public function deleteVersion(APIVersionInfo $versionInfo)
1810
    {
1811
        if ($versionInfo->isPublished()) {
1812
            throw new BadStateException(
1813
                '$versionInfo',
1814
                'Version is published and can not be removed'
1815
            );
1816
        }
1817
1818
        if (!$this->repository->canUser('content', 'versionremove', $versionInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1819
            throw new UnauthorizedException(
1820
                'content',
1821
                'versionremove',
1822
                ['contentId' => $versionInfo->contentInfo->id, 'versionNo' => $versionInfo->versionNo]
1823
            );
1824
        }
1825
1826
        $versionList = $this->persistenceHandler->contentHandler()->listVersions(
1827
            $versionInfo->contentInfo->id,
1828
            null,
1829
            2
1830
        );
1831
1832
        if (count($versionList) === 1 && !$versionInfo->isDraft()) {
1833
            throw new BadStateException(
1834
                '$versionInfo',
1835
                'Version is the last version of the Content and can not be removed'
1836
            );
1837
        }
1838
1839
        $this->repository->beginTransaction();
1840
        try {
1841
            $this->persistenceHandler->contentHandler()->deleteVersion(
1842
                $versionInfo->getContentInfo()->id,
1843
                $versionInfo->versionNo
1844
            );
1845
            $this->repository->commit();
1846
        } catch (Exception $e) {
1847
            $this->repository->rollback();
1848
            throw $e;
1849
        }
1850
    }
1851
1852
    /**
1853
     * Loads all versions for the given content.
1854
     *
1855
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to list versions
1856
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the given status is invalid
1857
     *
1858
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
1859
     * @param int|null $status
1860
     *
1861
     * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo[] Sorted by creation date
1862
     */
1863
    public function loadVersions(ContentInfo $contentInfo, ?int $status = null)
1864
    {
1865
        if (!$this->repository->canUser('content', 'versionread', $contentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1866
            throw new UnauthorizedException('content', 'versionread', ['contentId' => $contentInfo->id]);
1867
        }
1868
1869
        if ($status !== null && !in_array((int)$status, [VersionInfo::STATUS_DRAFT, VersionInfo::STATUS_PUBLISHED, VersionInfo::STATUS_ARCHIVED], true)) {
1870
            throw new InvalidArgumentException(
1871
                'status',
1872
                sprintf(
1873
                    'it can be one of %d (draft), %d (published), %d (archived), %d given',
1874
                    VersionInfo::STATUS_DRAFT, VersionInfo::STATUS_PUBLISHED, VersionInfo::STATUS_ARCHIVED, $status
1875
                ));
1876
        }
1877
1878
        $spiVersionInfoList = $this->persistenceHandler->contentHandler()->listVersions($contentInfo->id, $status);
1879
1880
        $versions = [];
1881
        foreach ($spiVersionInfoList as $spiVersionInfo) {
1882
            $versionInfo = $this->domainMapper->buildVersionInfoDomainObject($spiVersionInfo);
1883
            if (!$this->repository->canUser('content', 'versionread', $versionInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1884
                throw new UnauthorizedException('content', 'versionread', ['versionId' => $versionInfo->id]);
1885
            }
1886
1887
            $versions[] = $versionInfo;
1888
        }
1889
1890
        return $versions;
1891
    }
1892
1893
    /**
1894
     * Copies the content to a new location. If no version is given,
1895
     * all versions are copied, otherwise only the given version.
1896
     *
1897
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to copy the content to the given location
1898
     *
1899
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
1900
     * @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct $destinationLocationCreateStruct the target location where the content is copied to
1901
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
1902
     *
1903
     * @return \eZ\Publish\API\Repository\Values\Content\Content
1904
     */
1905
    public function copyContent(ContentInfo $contentInfo, LocationCreateStruct $destinationLocationCreateStruct, APIVersionInfo $versionInfo = null)
1906
    {
1907
        $destinationLocation = $this->repository->getLocationService()->loadLocation(
1908
            $destinationLocationCreateStruct->parentLocationId
1909
        );
1910
        if (!$this->repository->canUser('content', 'create', $contentInfo, [$destinationLocation])) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1911
            throw new UnauthorizedException(
1912
                'content',
1913
                'create',
1914
                [
1915
                    'parentLocationId' => $destinationLocationCreateStruct->parentLocationId,
1916
                    'sectionId' => $contentInfo->sectionId,
1917
                ]
1918
            );
1919
        }
1920
        if (!$this->repository->canUser('content', 'manage_locations', $contentInfo, [$destinationLocation])) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1921
            throw new UnauthorizedException('content', 'manage_locations', ['contentId' => $contentInfo->id]);
1922
        }
1923
1924
        $defaultObjectStates = $this->getDefaultObjectStates();
1925
1926
        $this->repository->beginTransaction();
1927
        try {
1928
            $spiContent = $this->persistenceHandler->contentHandler()->copy(
1929
                $contentInfo->id,
1930
                $versionInfo ? $versionInfo->versionNo : null,
1931
                $this->repository->getPermissionResolver()->getCurrentUserReference()->getUserId()
1932
            );
1933
1934
            $objectStateHandler = $this->persistenceHandler->objectStateHandler();
1935
            foreach ($defaultObjectStates as $objectStateGroupId => $objectState) {
1936
                $objectStateHandler->setContentState(
1937
                    $spiContent->versionInfo->contentInfo->id,
1938
                    $objectStateGroupId,
1939
                    $objectState->id
1940
                );
1941
            }
1942
1943
            $content = $this->internalPublishVersion(
1944
                $this->domainMapper->buildVersionInfoDomainObject($spiContent->versionInfo),
1945
                $spiContent->versionInfo->creationDate
1946
            );
1947
1948
            $this->repository->getLocationService()->createLocation(
1949
                $content->getVersionInfo()->getContentInfo(),
1950
                $destinationLocationCreateStruct
1951
            );
1952
            $this->repository->commit();
1953
        } catch (Exception $e) {
1954
            $this->repository->rollback();
1955
            throw $e;
1956
        }
1957
1958
        return $this->internalLoadContent($content->id);
1959
    }
1960
1961
    /**
1962
     * Loads all outgoing relations for the given version.
1963
     *
1964
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read this version
1965
     *
1966
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo
1967
     *
1968
     * @return \eZ\Publish\API\Repository\Values\Content\Relation[]
1969
     */
1970
    public function loadRelations(APIVersionInfo $versionInfo)
1971
    {
1972
        if ($versionInfo->isPublished()) {
1973
            $function = 'read';
1974
        } else {
1975
            $function = 'versionread';
1976
        }
1977
1978
        if (!$this->repository->canUser('content', $function, $versionInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1979
            throw new UnauthorizedException('content', $function);
1980
        }
1981
1982
        $contentInfo = $versionInfo->getContentInfo();
1983
        $spiRelations = $this->persistenceHandler->contentHandler()->loadRelations(
1984
            $contentInfo->id,
1985
            $versionInfo->versionNo
1986
        );
1987
1988
        /** @var $relations \eZ\Publish\API\Repository\Values\Content\Relation[] */
1989
        $relations = [];
1990
        foreach ($spiRelations as $spiRelation) {
1991
            $destinationContentInfo = $this->internalLoadContentInfo($spiRelation->destinationContentId);
1992
            if (!$this->repository->canUser('content', 'read', $destinationContentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
1993
                continue;
1994
            }
1995
1996
            $relations[] = $this->domainMapper->buildRelationDomainObject(
1997
                $spiRelation,
1998
                $contentInfo,
1999
                $destinationContentInfo
2000
            );
2001
        }
2002
2003
        return $relations;
2004
    }
2005
2006
    /**
2007
     * {@inheritdoc}
2008
     */
2009
    public function countReverseRelations(ContentInfo $contentInfo): int
2010
    {
2011
        if (!$this->repository->canUser('content', 'reverserelatedlist', $contentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
2012
            return 0;
2013
        }
2014
2015
        return $this->persistenceHandler->contentHandler()->countReverseRelations(
2016
            $contentInfo->id
2017
        );
2018
    }
2019
2020
    /**
2021
     * Loads all incoming relations for a content object.
2022
     *
2023
     * The relations come only from published versions of the source content objects
2024
     *
2025
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read this version
2026
     *
2027
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
2028
     *
2029
     * @return \eZ\Publish\API\Repository\Values\Content\Relation[]
2030
     */
2031
    public function loadReverseRelations(ContentInfo $contentInfo)
2032
    {
2033
        if (!$this->repository->canUser('content', 'reverserelatedlist', $contentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
2034
            throw new UnauthorizedException('content', 'reverserelatedlist', ['contentId' => $contentInfo->id]);
2035
        }
2036
2037
        $spiRelations = $this->persistenceHandler->contentHandler()->loadReverseRelations(
2038
            $contentInfo->id
2039
        );
2040
2041
        $returnArray = [];
2042
        foreach ($spiRelations as $spiRelation) {
2043
            $sourceContentInfo = $this->internalLoadContentInfo($spiRelation->sourceContentId);
2044
            if (!$this->repository->canUser('content', 'read', $sourceContentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
2045
                continue;
2046
            }
2047
2048
            $returnArray[] = $this->domainMapper->buildRelationDomainObject(
2049
                $spiRelation,
2050
                $sourceContentInfo,
2051
                $contentInfo
2052
            );
2053
        }
2054
2055
        return $returnArray;
2056
    }
2057
2058
    /**
2059
     * {@inheritdoc}
2060
     */
2061
    public function loadReverseRelationList(ContentInfo $contentInfo, int $offset = 0, int $limit = -1): RelationList
2062
    {
2063
        $list = new RelationList();
2064
        if (!$this->repository->getPermissionResolver()->canUser('content', 'reverserelatedlist', $contentInfo)) {
2065
            return $list;
2066
        }
2067
2068
        $list->totalCount = $this->persistenceHandler->contentHandler()->countReverseRelations(
2069
            $contentInfo->id
2070
        );
2071
        if ($list->totalCount > 0) {
2072
            $spiRelationList = $this->persistenceHandler->contentHandler()->loadReverseRelationList(
2073
                $contentInfo->id,
2074
                $offset,
2075
                $limit
2076
            );
2077
            foreach ($spiRelationList as $spiRelation) {
2078
                $sourceContentInfo = $this->internalLoadContentInfo($spiRelation->sourceContentId);
2079
                if ($this->repository->getPermissionResolver()->canUser('content', 'read', $sourceContentInfo)) {
2080
                    $relation = $this->domainMapper->buildRelationDomainObject(
2081
                        $spiRelation,
2082
                        $sourceContentInfo,
2083
                        $contentInfo
2084
                    );
2085
                    $list->items[] = new RelationListItem($relation);
2086
                } else {
2087
                    $list->items[] = new UnauthorizedRelationListItem(
2088
                        'content',
2089
                        'read',
2090
                        ['contentId' => $sourceContentInfo->id]
2091
                    );
2092
                }
2093
            }
2094
        }
2095
2096
        return $list;
2097
    }
2098
2099
    /**
2100
     * Adds a relation of type common.
2101
     *
2102
     * The source of the relation is the content and version
2103
     * referenced by $versionInfo.
2104
     *
2105
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to edit this version
2106
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
2107
     *
2108
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $sourceVersion
2109
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $destinationContent the destination of the relation
2110
     *
2111
     * @return \eZ\Publish\API\Repository\Values\Content\Relation the newly created relation
2112
     */
2113
    public function addRelation(APIVersionInfo $sourceVersion, ContentInfo $destinationContent)
2114
    {
2115
        $sourceVersion = $this->loadVersionInfoById(
2116
            $sourceVersion->contentInfo->id,
2117
            $sourceVersion->versionNo
2118
        );
2119
2120
        if (!$sourceVersion->isDraft()) {
2121
            throw new BadStateException(
2122
                '$sourceVersion',
2123
                'Relations of type common can only be added to versions of status draft'
2124
            );
2125
        }
2126
2127
        if (!$this->repository->canUser('content', 'edit', $sourceVersion)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
2128
            throw new UnauthorizedException('content', 'edit', ['contentId' => $sourceVersion->contentInfo->id]);
2129
        }
2130
2131
        $sourceContentInfo = $sourceVersion->getContentInfo();
2132
2133
        $this->repository->beginTransaction();
2134
        try {
2135
            $spiRelation = $this->persistenceHandler->contentHandler()->addRelation(
2136
                new SPIRelationCreateStruct(
2137
                    [
2138
                        'sourceContentId' => $sourceContentInfo->id,
2139
                        'sourceContentVersionNo' => $sourceVersion->versionNo,
2140
                        'sourceFieldDefinitionId' => null,
2141
                        'destinationContentId' => $destinationContent->id,
2142
                        'type' => APIRelation::COMMON,
2143
                    ]
2144
                )
2145
            );
2146
            $this->repository->commit();
2147
        } catch (Exception $e) {
2148
            $this->repository->rollback();
2149
            throw $e;
2150
        }
2151
2152
        return $this->domainMapper->buildRelationDomainObject($spiRelation, $sourceContentInfo, $destinationContent);
2153
    }
2154
2155
    /**
2156
     * Removes a relation of type COMMON from a draft.
2157
     *
2158
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed edit this version
2159
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft
2160
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if there is no relation of type COMMON for the given destination
2161
     *
2162
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $sourceVersion
2163
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $destinationContent
2164
     */
2165
    public function deleteRelation(APIVersionInfo $sourceVersion, ContentInfo $destinationContent)
2166
    {
2167
        $sourceVersion = $this->loadVersionInfoById(
2168
            $sourceVersion->contentInfo->id,
2169
            $sourceVersion->versionNo
2170
        );
2171
2172
        if (!$sourceVersion->isDraft()) {
2173
            throw new BadStateException(
2174
                '$sourceVersion',
2175
                'Relations of type common can only be removed from versions of status draft'
2176
            );
2177
        }
2178
2179
        if (!$this->repository->canUser('content', 'edit', $sourceVersion)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
2180
            throw new UnauthorizedException('content', 'edit', ['contentId' => $sourceVersion->contentInfo->id]);
2181
        }
2182
2183
        $spiRelations = $this->persistenceHandler->contentHandler()->loadRelations(
2184
            $sourceVersion->getContentInfo()->id,
2185
            $sourceVersion->versionNo,
2186
            APIRelation::COMMON
2187
        );
2188
2189
        if (empty($spiRelations)) {
2190
            throw new InvalidArgumentException(
2191
                '$sourceVersion',
2192
                'There are no relations of type COMMON for the given destination'
2193
            );
2194
        }
2195
2196
        // there should be only one relation of type COMMON for each destination,
2197
        // but in case there were ever more then one, we will remove them all
2198
        // @todo: alternatively, throw BadStateException?
2199
        $this->repository->beginTransaction();
2200
        try {
2201
            foreach ($spiRelations as $spiRelation) {
2202
                if ($spiRelation->destinationContentId == $destinationContent->id) {
2203
                    $this->persistenceHandler->contentHandler()->removeRelation(
2204
                        $spiRelation->id,
2205
                        APIRelation::COMMON
2206
                    );
2207
                }
2208
            }
2209
            $this->repository->commit();
2210
        } catch (Exception $e) {
2211
            $this->repository->rollback();
2212
            throw $e;
2213
        }
2214
    }
2215
2216
    /**
2217
     * {@inheritdoc}
2218
     */
2219
    public function removeTranslation(ContentInfo $contentInfo, $languageCode)
2220
    {
2221
        @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...
2222
            __METHOD__ . ' is deprecated, use deleteTranslation instead',
2223
            E_USER_DEPRECATED
2224
        );
2225
        $this->deleteTranslation($contentInfo, $languageCode);
2226
    }
2227
2228
    /**
2229
     * Delete Content item Translation from all Versions (including archived ones) of a Content Object.
2230
     *
2231
     * NOTE: this operation is risky and permanent, so user interface should provide a warning before performing it.
2232
     *
2233
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the specified Translation
2234
     *         is the Main Translation of a Content Item.
2235
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed
2236
     *         to delete the content (in one of the locations of the given Content Item).
2237
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if languageCode argument
2238
     *         is invalid for the given content.
2239
     *
2240
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
2241
     * @param string $languageCode
2242
     *
2243
     * @since 6.13
2244
     */
2245
    public function deleteTranslation(ContentInfo $contentInfo, $languageCode)
2246
    {
2247
        if ($contentInfo->mainLanguageCode === $languageCode) {
2248
            throw new BadStateException(
2249
                '$languageCode',
2250
                'Specified translation is the main translation of the Content Object'
2251
            );
2252
        }
2253
2254
        $translationWasFound = false;
2255
        $this->repository->beginTransaction();
2256
        try {
2257
            foreach ($this->loadVersions($contentInfo) as $versionInfo) {
2258
                if (!$this->repository->canUser('content', 'remove', $versionInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
2259
                    throw new UnauthorizedException(
2260
                        'content',
2261
                        'remove',
2262
                        ['contentId' => $contentInfo->id, 'versionNo' => $versionInfo->versionNo]
2263
                    );
2264
                }
2265
2266
                if (!in_array($languageCode, $versionInfo->languageCodes)) {
2267
                    continue;
2268
                }
2269
2270
                $translationWasFound = true;
2271
2272
                // If the translation is the version's only one, delete the version
2273
                if (count($versionInfo->languageCodes) < 2) {
2274
                    $this->persistenceHandler->contentHandler()->deleteVersion(
2275
                        $versionInfo->getContentInfo()->id,
2276
                        $versionInfo->versionNo
2277
                    );
2278
                }
2279
            }
2280
2281
            if (!$translationWasFound) {
2282
                throw new InvalidArgumentException(
2283
                    '$languageCode',
2284
                    sprintf(
2285
                        '%s does not exist in the Content item(id=%d)',
2286
                        $languageCode,
2287
                        $contentInfo->id
2288
                    )
2289
                );
2290
            }
2291
2292
            $this->persistenceHandler->contentHandler()->deleteTranslationFromContent(
2293
                $contentInfo->id,
2294
                $languageCode
2295
            );
2296
            $locationIds = array_map(
2297
                function (Location $location) {
2298
                    return $location->id;
2299
                },
2300
                $this->repository->getLocationService()->loadLocations($contentInfo)
2301
            );
2302
            $this->persistenceHandler->urlAliasHandler()->translationRemoved(
2303
                $locationIds,
2304
                $languageCode
2305
            );
2306
            $this->repository->commit();
2307
        } catch (InvalidArgumentException $e) {
2308
            $this->repository->rollback();
2309
            throw $e;
2310
        } catch (BadStateException $e) {
2311
            $this->repository->rollback();
2312
            throw $e;
2313
        } catch (UnauthorizedException $e) {
2314
            $this->repository->rollback();
2315
            throw $e;
2316
        } catch (Exception $e) {
2317
            $this->repository->rollback();
2318
            // cover generic unexpected exception to fulfill API promise on @throws
2319
            throw new BadStateException('$contentInfo', 'Translation removal failed', $e);
2320
        }
2321
    }
2322
2323
    /**
2324
     * Delete specified Translation from a Content Draft.
2325
     *
2326
     * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the specified Translation
2327
     *         is the only one the Content Draft has or it is the main Translation of a Content Object.
2328
     * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed
2329
     *         to edit the Content (in one of the locations of the given Content Object).
2330
     * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if languageCode argument
2331
     *         is invalid for the given Draft.
2332
     * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if specified Version was not found
2333
     *
2334
     * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo Content Version Draft
2335
     * @param string $languageCode Language code of the Translation to be removed
2336
     *
2337
     * @return \eZ\Publish\API\Repository\Values\Content\Content Content Draft w/o the specified Translation
2338
     *
2339
     * @since 6.12
2340
     */
2341
    public function deleteTranslationFromDraft(APIVersionInfo $versionInfo, $languageCode)
2342
    {
2343
        if (!$versionInfo->isDraft()) {
2344
            throw new BadStateException(
2345
                '$versionInfo',
2346
                'Version is not a draft, so Translations cannot be modified. Create a Draft before proceeding'
2347
            );
2348
        }
2349
2350
        if ($versionInfo->contentInfo->mainLanguageCode === $languageCode) {
2351
            throw new BadStateException(
2352
                '$languageCode',
2353
                'Specified Translation is the main Translation of the Content Object. Change it before proceeding.'
2354
            );
2355
        }
2356
2357
        if (!$this->repository->canUser('content', 'edit', $versionInfo->contentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
2358
            throw new UnauthorizedException(
2359
                'content', 'edit', ['contentId' => $versionInfo->contentInfo->id]
2360
            );
2361
        }
2362
2363
        if (!in_array($languageCode, $versionInfo->languageCodes)) {
2364
            throw new InvalidArgumentException(
2365
                '$languageCode',
2366
                sprintf(
2367
                    'The Version (ContentId=%d, VersionNo=%d) is not translated into %s',
2368
                    $versionInfo->contentInfo->id,
2369
                    $versionInfo->versionNo,
2370
                    $languageCode
2371
                )
2372
            );
2373
        }
2374
2375
        if (count($versionInfo->languageCodes) === 1) {
2376
            throw new BadStateException(
2377
                '$languageCode',
2378
                'Specified Translation is the only one Content Object Version has'
2379
            );
2380
        }
2381
2382
        $this->repository->beginTransaction();
2383
        try {
2384
            $spiContent = $this->persistenceHandler->contentHandler()->deleteTranslationFromDraft(
2385
                $versionInfo->contentInfo->id,
2386
                $versionInfo->versionNo,
2387
                $languageCode
2388
            );
2389
            $this->repository->commit();
2390
2391
            return $this->domainMapper->buildContentDomainObject(
2392
                $spiContent,
2393
                $this->repository->getContentTypeService()->loadContentType(
2394
                    $spiContent->versionInfo->contentInfo->contentTypeId
2395
                )
2396
            );
2397
        } catch (APINotFoundException $e) {
2398
            // avoid wrapping expected NotFoundException in BadStateException handled below
2399
            $this->repository->rollback();
2400
            throw $e;
2401
        } catch (Exception $e) {
2402
            $this->repository->rollback();
2403
            // cover generic unexpected exception to fulfill API promise on @throws
2404
            throw new BadStateException('$contentInfo', 'Translation removal failed', $e);
2405
        }
2406
    }
2407
2408
    /**
2409
     * Hides Content by making all the Locations appear hidden.
2410
     * It does not persist hidden state on Location object itself.
2411
     *
2412
     * Content hidden by this API can be revealed by revealContent API.
2413
     *
2414
     * @see revealContent
2415
     *
2416
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
2417
     */
2418
    public function hideContent(ContentInfo $contentInfo): void
2419
    {
2420
        if (!$this->repository->canUser('content', 'hide', $contentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
2421
            throw new UnauthorizedException('content', 'hide', ['contentId' => $contentInfo->id]);
2422
        }
2423
2424
        $this->repository->beginTransaction();
2425
        try {
2426
            $this->persistenceHandler->contentHandler()->updateMetadata(
2427
                $contentInfo->id,
2428
                new SPIMetadataUpdateStruct([
2429
                    'isHidden' => true,
2430
                ])
2431
            );
2432
            $locationHandler = $this->persistenceHandler->locationHandler();
2433
            $childLocations = $locationHandler->loadLocationsByContent($contentInfo->id);
2434
            foreach ($childLocations as $childLocation) {
2435
                $locationHandler->setInvisible($childLocation->id);
2436
            }
2437
            $this->repository->commit();
2438
        } catch (Exception $e) {
2439
            $this->repository->rollback();
2440
            throw $e;
2441
        }
2442
    }
2443
2444
    /**
2445
     * Reveals Content hidden by hideContent API.
2446
     * Locations which were hidden before hiding Content will remain hidden.
2447
     *
2448
     * @see hideContent
2449
     *
2450
     * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo
2451
     */
2452
    public function revealContent(ContentInfo $contentInfo): void
2453
    {
2454
        if (!$this->repository->canUser('content', 'hide', $contentInfo)) {
0 ignored issues
show
Deprecated Code introduced by
The method eZ\Publish\Core\Repository\Repository::canUser() has been deprecated with message: since 6.6, to be removed. Use PermissionResolver::canUser() instead. Check if user has access to a given action on a given value object. Indicates if the current user is allowed to perform an action given by the function on the given
objects.

This method has been deprecated. The supplier of the class has supplied an explanatory message.

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

Loading history...
2455
            throw new UnauthorizedException('content', 'hide', ['contentId' => $contentInfo->id]);
2456
        }
2457
2458
        $this->repository->beginTransaction();
2459
        try {
2460
            $this->persistenceHandler->contentHandler()->updateMetadata(
2461
                $contentInfo->id,
2462
                new SPIMetadataUpdateStruct([
2463
                    'isHidden' => false,
2464
                ])
2465
            );
2466
            $locationHandler = $this->persistenceHandler->locationHandler();
2467
            $childLocations = $locationHandler->loadLocationsByContent($contentInfo->id);
2468
            foreach ($childLocations as $childLocation) {
2469
                $locationHandler->setVisible($childLocation->id);
2470
            }
2471
            $this->repository->commit();
2472
        } catch (Exception $e) {
2473
            $this->repository->rollback();
2474
            throw $e;
2475
        }
2476
    }
2477
2478
    /**
2479
     * Instantiates a new content create struct object.
2480
     *
2481
     * alwaysAvailable is set to the ContentType's defaultAlwaysAvailable
2482
     *
2483
     * @param \eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType
2484
     * @param string $mainLanguageCode
2485
     *
2486
     * @return \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct
2487
     */
2488
    public function newContentCreateStruct(ContentType $contentType, $mainLanguageCode)
2489
    {
2490
        return new ContentCreateStruct(
2491
            [
2492
                'contentType' => $contentType,
2493
                'mainLanguageCode' => $mainLanguageCode,
2494
                'alwaysAvailable' => $contentType->defaultAlwaysAvailable,
2495
            ]
2496
        );
2497
    }
2498
2499
    /**
2500
     * Instantiates a new content meta data update struct.
2501
     *
2502
     * @return \eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct
2503
     */
2504
    public function newContentMetadataUpdateStruct()
2505
    {
2506
        return new ContentMetadataUpdateStruct();
2507
    }
2508
2509
    /**
2510
     * Instantiates a new content update struct.
2511
     *
2512
     * @return \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct
2513
     */
2514
    public function newContentUpdateStruct()
2515
    {
2516
        return new ContentUpdateStruct();
2517
    }
2518
2519
    /**
2520
     * @param \eZ\Publish\API\Repository\Values\User\User|null $user
2521
     *
2522
     * @return \eZ\Publish\API\Repository\Values\User\UserReference
2523
     */
2524
    private function resolveUser(?User $user): UserReference
2525
    {
2526
        if ($user === null) {
2527
            $user = $this->repository->getPermissionResolver()->getCurrentUserReference();
2528
        }
2529
2530
        return $user;
2531
    }
2532
}
2533