Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
1 | <?php |
||
40 | class ContentService implements ContentServiceInterface |
||
41 | { |
||
42 | /** |
||
43 | * Aggregated service. |
||
44 | * |
||
45 | * @var \eZ\Publish\API\Repository\ContentService |
||
46 | */ |
||
47 | protected $service; |
||
48 | |||
49 | /** |
||
50 | * SignalDispatcher. |
||
51 | * |
||
52 | * @var \eZ\Publish\Core\SignalSlot\SignalDispatcher |
||
53 | */ |
||
54 | protected $signalDispatcher; |
||
55 | |||
56 | /** |
||
57 | * Constructor. |
||
58 | * |
||
59 | * Construct service object from aggregated service and signal |
||
60 | * dispatcher |
||
61 | * |
||
62 | * @param \eZ\Publish\API\Repository\ContentService $service |
||
63 | * @param \eZ\Publish\Core\SignalSlot\SignalDispatcher $signalDispatcher |
||
64 | */ |
||
65 | public function __construct(ContentServiceInterface $service, SignalDispatcher $signalDispatcher) |
||
70 | |||
71 | /** |
||
72 | * Loads a content info object. |
||
73 | * |
||
74 | * To load fields use loadContent |
||
75 | * |
||
76 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the content |
||
77 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given id does not exist |
||
78 | * |
||
79 | * @param int $contentId |
||
80 | * |
||
81 | * @return \eZ\Publish\API\Repository\Values\Content\ContentInfo |
||
82 | */ |
||
83 | public function loadContentInfo($contentId) |
||
87 | |||
88 | /** |
||
89 | * {@inheritdoc} |
||
90 | */ |
||
91 | public function loadContentInfoList(array $contentIds): iterable |
||
92 | { |
||
93 | return $this->service->loadContentInfoList($contentIds); |
||
94 | } |
||
95 | |||
96 | /** |
||
97 | * Loads a content info object for the given remoteId. |
||
98 | * |
||
99 | * To load fields use loadContent |
||
100 | * |
||
101 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the content |
||
102 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given remote id does not exist |
||
103 | * |
||
104 | * @param string $remoteId |
||
105 | * |
||
106 | * @return \eZ\Publish\API\Repository\Values\Content\ContentInfo |
||
107 | */ |
||
108 | public function loadContentInfoByRemoteId($remoteId) |
||
112 | |||
113 | /** |
||
114 | * Loads a version info of the given content object. |
||
115 | * |
||
116 | * If no version number is given, the method returns the current version |
||
117 | * |
||
118 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the version with the given number does not exist |
||
119 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version |
||
120 | * |
||
121 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
122 | * @param int $versionNo the version number. If not given the current version is returned. |
||
123 | * |
||
124 | * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo |
||
125 | */ |
||
126 | public function loadVersionInfo(ContentInfo $contentInfo, $versionNo = null) |
||
130 | |||
131 | /** |
||
132 | * Loads a version info of the given content object id. |
||
133 | * |
||
134 | * If no version number is given, the method returns the current version |
||
135 | * |
||
136 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the version with the given number does not exist |
||
137 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version |
||
138 | * |
||
139 | * @param mixed $contentId |
||
140 | * @param int $versionNo the version number. If not given the current version is returned. |
||
141 | * |
||
142 | * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo |
||
143 | */ |
||
144 | public function loadVersionInfoById($contentId, $versionNo = null) |
||
148 | |||
149 | /** |
||
150 | * Loads content in a version for the given content info object. |
||
151 | * |
||
152 | * If no version number is given, the method returns the current version |
||
153 | * |
||
154 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if version with the given number does not exist |
||
155 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version |
||
156 | * |
||
157 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
158 | * @param array $languages A language filter for fields. If not given all languages are returned |
||
159 | * @param int $versionNo the version number. If not given the current version is returned |
||
160 | * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true |
||
161 | * |
||
162 | * @return \eZ\Publish\API\Repository\Values\Content\Content |
||
163 | */ |
||
164 | public function loadContentByContentInfo(ContentInfo $contentInfo, array $languages = null, $versionNo = null, $useAlwaysAvailable = true) |
||
168 | |||
169 | /** |
||
170 | * Loads content in the version given by version info. |
||
171 | * |
||
172 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version |
||
173 | * |
||
174 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
175 | * @param array $languages A language filter for fields. If not given all languages are returned |
||
176 | * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true |
||
177 | * |
||
178 | * @return \eZ\Publish\API\Repository\Values\Content\Content |
||
179 | */ |
||
180 | public function loadContentByVersionInfo(VersionInfo $versionInfo, array $languages = null, $useAlwaysAvailable = true) |
||
184 | |||
185 | /** |
||
186 | * Loads content in a version of the given content object. |
||
187 | * |
||
188 | * If no version number is given, the method returns the current version |
||
189 | * |
||
190 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if the content or version with the given id and languages does not exist |
||
191 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version |
||
192 | * |
||
193 | * @param int $contentId |
||
194 | * @param array $languages A language filter for fields. If not given all languages are returned |
||
195 | * @param int $versionNo the version number. If not given the current version is returned |
||
196 | * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true |
||
197 | * |
||
198 | * @return \eZ\Publish\API\Repository\Values\Content\Content |
||
199 | */ |
||
200 | public function loadContent($contentId, array $languages = null, $versionNo = null, $useAlwaysAvailable = true) |
||
204 | |||
205 | /** |
||
206 | * Loads content in a version for the content object reference by the given remote id. |
||
207 | * |
||
208 | * If no version is given, the method returns the current version |
||
209 | * |
||
210 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content or version with the given remote id does not exist |
||
211 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version |
||
212 | * |
||
213 | * @param string $remoteId |
||
214 | * @param array $languages A language filter for fields. If not given all languages are returned |
||
215 | * @param int $versionNo the version number. If not given the current version is returned |
||
216 | * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true |
||
217 | * |
||
218 | * @return \eZ\Publish\API\Repository\Values\Content\Content |
||
219 | */ |
||
220 | public function loadContentByRemoteId($remoteId, array $languages = null, $versionNo = null, $useAlwaysAvailable = true) |
||
224 | |||
225 | /** |
||
226 | * Creates a new content draft assigned to the authenticated user. |
||
227 | * |
||
228 | * If a different userId is given in $contentCreateStruct it is assigned to the given user |
||
229 | * but this required special rights for the authenticated user |
||
230 | * (this is useful for content staging where the transfer process does not |
||
231 | * have to authenticate with the user which created the content object in the source server). |
||
232 | * The user has to publish the draft if it should be visible. |
||
233 | * In 4.x at least one location has to be provided in the location creation array. |
||
234 | * |
||
235 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to create the content in the given location |
||
236 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if there is a provided remoteId which exists in the system |
||
237 | * or there is no location provided (4.x) or multiple locations |
||
238 | * are under the same parent or if the a field value is not accepted by the field type |
||
239 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $contentCreateStruct is not valid |
||
240 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is missing or is set to an empty value |
||
241 | * |
||
242 | * @param \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct $contentCreateStruct |
||
243 | * @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct[] $locationCreateStructs For each location parent under which a location should be created for the content |
||
244 | * |
||
245 | * @return \eZ\Publish\API\Repository\Values\Content\Content - the newly created content draft |
||
246 | */ |
||
247 | public function createContent(ContentCreateStruct $contentCreateStruct, array $locationCreateStructs = array()) |
||
261 | |||
262 | /** |
||
263 | * Updates the metadata. |
||
264 | * |
||
265 | * (see {@link ContentMetadataUpdateStruct}) of a content object - to update fields use updateContent |
||
266 | * |
||
267 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to update the content meta data |
||
268 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the remoteId in $contentMetadataUpdateStruct is set but already exists |
||
269 | * |
||
270 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
271 | * @param \eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct $contentMetadataUpdateStruct |
||
272 | * |
||
273 | * @return \eZ\Publish\API\Repository\Values\Content\Content the content with the updated attributes |
||
274 | */ |
||
275 | public function updateContentMetadata(ContentInfo $contentInfo, ContentMetadataUpdateStruct $contentMetadataUpdateStruct) |
||
288 | |||
289 | /** |
||
290 | * Deletes a content object including all its versions and locations including their subtrees. |
||
291 | * |
||
292 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to delete the content (in one of the locations of the given content object) |
||
293 | * |
||
294 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
295 | * |
||
296 | * @return mixed[] Affected Location Id's |
||
297 | */ |
||
298 | public function deleteContent(ContentInfo $contentInfo) |
||
312 | |||
313 | /** |
||
314 | * Creates a draft from a published or archived version. |
||
315 | * |
||
316 | * If no version is given, the current published version is used. |
||
317 | * 4.x: The draft is created with the initialLanguage code of the source version or if not present with the main language. |
||
318 | * It can be changed on updating the version. |
||
319 | * |
||
320 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to create the draft |
||
321 | * |
||
322 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
323 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
324 | * @param \eZ\Publish\API\Repository\Values\User\User $user if set given user is used to create the draft - otherwise the current user is used |
||
325 | * |
||
326 | * @return \eZ\Publish\API\Repository\Values\Content\Content - the newly created content draft |
||
327 | */ |
||
328 | public function createContentDraft(ContentInfo $contentInfo, VersionInfo $versionInfo = null, User $user = null) |
||
344 | |||
345 | /** |
||
346 | * Loads drafts for a user. |
||
347 | * |
||
348 | * If no user is given the drafts for the authenticated user a returned |
||
349 | * |
||
350 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load the draft list |
||
351 | * |
||
352 | * @param \eZ\Publish\API\Repository\Values\User\User $user |
||
353 | * |
||
354 | * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo[] the drafts ({@link VersionInfo}) owned by the given user |
||
355 | */ |
||
356 | public function loadContentDrafts(User $user = null) |
||
360 | |||
361 | /** |
||
362 | * Translate a version. |
||
363 | * |
||
364 | * updates the destination version given in $translationInfo with the provided translated fields in $translationValues |
||
365 | * |
||
366 | * @example Examples/translation_5x.php |
||
367 | * |
||
368 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to update this version |
||
369 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the given destination version is not a draft |
||
370 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is set to an empty value |
||
371 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $translationValues is not valid |
||
372 | * |
||
373 | * @param \eZ\Publish\API\Repository\Values\Content\TranslationInfo $translationInfo |
||
374 | * @param \eZ\Publish\API\Repository\Values\Content\TranslationValues $translationValues |
||
375 | * @param \eZ\Publish\API\Repository\Values\User\User $user If set, this user is taken as modifier of the version |
||
376 | * |
||
377 | * @return \eZ\Publish\API\Repository\Values\Content\Content the content draft with the translated fields |
||
378 | * |
||
379 | * @since 5.0 |
||
380 | */ |
||
381 | public function translateVersion(TranslationInfo $translationInfo, TranslationValues $translationValues, User $user = null) |
||
396 | |||
397 | /** |
||
398 | * Updates the fields of a draft. |
||
399 | * |
||
400 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to update this version |
||
401 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft |
||
402 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $contentUpdateStruct is not valid |
||
403 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if a required field is set to an empty value |
||
404 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if a field value is not accepted by the field type |
||
405 | * |
||
406 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
407 | * @param \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct $contentUpdateStruct |
||
408 | * |
||
409 | * @return \eZ\Publish\API\Repository\Values\Content\Content the content draft with the updated fields |
||
410 | */ |
||
411 | View Code Duplication | public function updateContent(VersionInfo $versionInfo, ContentUpdateStruct $contentUpdateStruct) |
|
425 | |||
426 | /** |
||
427 | * Publishes a content version. |
||
428 | * |
||
429 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to publish this version |
||
430 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft |
||
431 | * |
||
432 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
433 | * |
||
434 | * @return \eZ\Publish\API\Repository\Values\Content\Content |
||
435 | */ |
||
436 | View Code Duplication | public function publishVersion(VersionInfo $versionInfo) |
|
450 | |||
451 | /** |
||
452 | * Removes the given version. |
||
453 | * |
||
454 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is in |
||
455 | * published state or is the last version of the Content |
||
456 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to remove this version |
||
457 | * |
||
458 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
459 | */ |
||
460 | View Code Duplication | public function deleteVersion(VersionInfo $versionInfo) |
|
474 | |||
475 | /** |
||
476 | * Loads all versions for the given content. |
||
477 | * |
||
478 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to list versions |
||
479 | * |
||
480 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
481 | * |
||
482 | * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo[] Sorted by creation date |
||
483 | */ |
||
484 | public function loadVersions(ContentInfo $contentInfo) |
||
488 | |||
489 | /** |
||
490 | * Copies the content to a new location. If no version is given, |
||
491 | * all versions are copied, otherwise only the given version. |
||
492 | * |
||
493 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to copy the content to the given location |
||
494 | * |
||
495 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
496 | * @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct $destinationLocationCreateStruct the target location where the content is copied to |
||
497 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
498 | * |
||
499 | * @return \eZ\Publish\API\Repository\Values\Content\Content |
||
500 | */ |
||
501 | public function copyContent(ContentInfo $contentInfo, LocationCreateStruct $destinationLocationCreateStruct, VersionInfo $versionInfo = null) |
||
518 | |||
519 | /** |
||
520 | * Loads all outgoing relations for the given version. |
||
521 | * |
||
522 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read this version |
||
523 | * |
||
524 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
525 | * |
||
526 | * @return \eZ\Publish\API\Repository\Values\Content\Relation[] |
||
527 | */ |
||
528 | public function loadRelations(VersionInfo $versionInfo) |
||
532 | |||
533 | /** |
||
534 | * Loads all incoming relations for a content object. |
||
535 | * |
||
536 | * The relations come only from published versions of the source content objects |
||
537 | * |
||
538 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read this version |
||
539 | * |
||
540 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
541 | * |
||
542 | * @return \eZ\Publish\API\Repository\Values\Content\Relation[] |
||
543 | */ |
||
544 | public function loadReverseRelations(ContentInfo $contentInfo) |
||
548 | |||
549 | /** |
||
550 | * Adds a relation of type common. |
||
551 | * |
||
552 | * The source of the relation is the content and version |
||
553 | * referenced by $versionInfo. |
||
554 | * |
||
555 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to edit this version |
||
556 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft |
||
557 | * |
||
558 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $sourceVersion |
||
559 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $destinationContent the destination of the relation |
||
560 | * |
||
561 | * @return \eZ\Publish\API\Repository\Values\Content\Relation the newly created relation |
||
562 | */ |
||
563 | View Code Duplication | public function addRelation(VersionInfo $sourceVersion, ContentInfo $destinationContent) |
|
578 | |||
579 | /** |
||
580 | * Removes a relation of type COMMON from a draft. |
||
581 | * |
||
582 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed edit this version |
||
583 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft |
||
584 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if there is no relation of type COMMON for the given destination |
||
585 | * |
||
586 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $sourceVersion |
||
587 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $destinationContent |
||
588 | */ |
||
589 | View Code Duplication | public function deleteRelation(VersionInfo $sourceVersion, ContentInfo $destinationContent) |
|
604 | |||
605 | /** |
||
606 | * Adds translation information to the content object. |
||
607 | * |
||
608 | * @example Examples/translation_5x.php |
||
609 | * |
||
610 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed add a translation info |
||
611 | * |
||
612 | * @param \eZ\Publish\API\Repository\Values\Content\TranslationInfo $translationInfo |
||
613 | * |
||
614 | * @since 5.0 |
||
615 | */ |
||
616 | public function addTranslationInfo(TranslationInfo $translationInfo) |
||
625 | |||
626 | /** |
||
627 | * lists the translations done on this content object. |
||
628 | * |
||
629 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed read translation infos |
||
630 | * |
||
631 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
632 | * @param array $filter |
||
633 | * |
||
634 | * @todo TBD - filter by source version, destination version and languages |
||
635 | * |
||
636 | * @return \eZ\Publish\API\Repository\Values\Content\TranslationInfo[] |
||
637 | * |
||
638 | * @since 5.0 |
||
639 | */ |
||
640 | public function loadTranslationInfos(ContentInfo $contentInfo, array $filter = array()) |
||
644 | |||
645 | /** |
||
646 | * {@inheritdoc} |
||
647 | */ |
||
648 | public function removeTranslation(ContentInfo $contentInfo, $languageCode) |
||
656 | |||
657 | /** |
||
658 | * Delete Content item Translation from all Versions (including archived ones) of a Content Object. |
||
659 | * |
||
660 | * NOTE: this operation is risky and permanent, so user interface should provide a warning before performing it. |
||
661 | * |
||
662 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the specified Translation |
||
663 | * is the Main Translation of a Content Item. |
||
664 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed |
||
665 | * to delete the content (in one of the locations of the given Content Item). |
||
666 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if languageCode argument |
||
667 | * is invalid for the given content. |
||
668 | * |
||
669 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
670 | * @param string $languageCode |
||
671 | * |
||
672 | * @since 6.13 |
||
673 | */ |
||
674 | public function deleteTranslation(ContentInfo $contentInfo, $languageCode) |
||
684 | |||
685 | /** |
||
686 | * Delete specified Translation from a Content Draft. |
||
687 | * |
||
688 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the specified Translation |
||
689 | * is the only one the Content Draft has or it is the main Translation of a Content Object. |
||
690 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed |
||
691 | * to edit the Content (in one of the locations of the given Content Object). |
||
692 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if languageCode argument |
||
693 | * is invalid for the given Draft. |
||
694 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if specified Version was not found |
||
695 | * |
||
696 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo Content Version Draft |
||
697 | * @param string $languageCode Language code of the Translation to be removed |
||
698 | * |
||
699 | * @return \eZ\Publish\API\Repository\Values\Content\Content Content Draft w/o the specified Translation |
||
700 | * |
||
701 | * @since 6.12 |
||
702 | */ |
||
703 | public function deleteTranslationFromDraft(VersionInfo $versionInfo, $languageCode) |
||
707 | |||
708 | /** |
||
709 | * Bulk-load Content items by the list of ContentInfo Value Objects. |
||
710 | * |
||
711 | * Note: it does not throw exceptions on load, just ignores erroneous Content item. |
||
712 | * Moreover, since the method works on pre-loaded ContentInfo list, it is assumed that user is |
||
713 | * allowed to access every Content on the list. |
||
714 | * |
||
715 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo[] $contentInfoList |
||
716 | * @param string[] $languages A language priority, filters returned fields and is used as prioritized language code on |
||
717 | * returned value object. If not given all languages are returned. |
||
718 | * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true, |
||
719 | * unless all languages have been asked for. |
||
720 | * |
||
721 | * @return \eZ\Publish\API\Repository\Values\Content\Content[] list of Content items with Content Ids as keys |
||
722 | */ |
||
723 | public function loadContentListByContentInfo( |
||
734 | |||
735 | /** |
||
736 | * Instantiates a new content create struct object. |
||
737 | * |
||
738 | * alwaysAvailable is set to the ContentType's defaultAlwaysAvailable |
||
739 | * |
||
740 | * @param \eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType |
||
741 | * @param string $mainLanguageCode |
||
742 | * |
||
743 | * @return \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct |
||
744 | */ |
||
745 | public function newContentCreateStruct(ContentType $contentType, $mainLanguageCode) |
||
749 | |||
750 | /** |
||
751 | * Instantiates a new content meta data update struct. |
||
752 | * |
||
753 | * @return \eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct |
||
754 | */ |
||
755 | public function newContentMetadataUpdateStruct() |
||
759 | |||
760 | /** |
||
761 | * Instantiates a new content update struct. |
||
762 | * |
||
763 | * @return \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct |
||
764 | */ |
||
765 | public function newContentUpdateStruct() |
||
769 | } |
||
770 |
Let’s take a look at an example:
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break.
Available Fixes
Change the type-hint for the parameter:
Add an additional type-check:
Add the method to the interface: