ezsystems /
ezpublish-kernel
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:
Complex classes like ContentService often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ContentService, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 51 | class ContentService implements ContentServiceInterface |
||
| 52 | { |
||
| 53 | /** |
||
| 54 | * @var \eZ\Publish\Core\Repository\Repository |
||
| 55 | */ |
||
| 56 | protected $repository; |
||
| 57 | |||
| 58 | /** |
||
| 59 | * @var \eZ\Publish\SPI\Persistence\Handler |
||
| 60 | */ |
||
| 61 | protected $persistenceHandler; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * @var array |
||
| 65 | */ |
||
| 66 | protected $settings; |
||
| 67 | |||
| 68 | /** |
||
| 69 | * @var \eZ\Publish\Core\Repository\Helper\DomainMapper |
||
| 70 | */ |
||
| 71 | protected $domainMapper; |
||
| 72 | |||
| 73 | /** |
||
| 74 | * @var \eZ\Publish\Core\Repository\Helper\RelationProcessor |
||
| 75 | */ |
||
| 76 | protected $relationProcessor; |
||
| 77 | |||
| 78 | /** |
||
| 79 | * @var \eZ\Publish\Core\Repository\Helper\NameSchemaService |
||
| 80 | */ |
||
| 81 | protected $nameSchemaService; |
||
| 82 | |||
| 83 | /** |
||
| 84 | * @var \eZ\Publish\Core\Repository\Helper\FieldTypeRegistry |
||
| 85 | */ |
||
| 86 | protected $fieldTypeRegistry; |
||
| 87 | |||
| 88 | /** |
||
| 89 | * Setups service with reference to repository object that created it & corresponding handler. |
||
| 90 | * |
||
| 91 | * @param \eZ\Publish\API\Repository\Repository $repository |
||
| 92 | * @param \eZ\Publish\SPI\Persistence\Handler $handler |
||
| 93 | * @param \eZ\Publish\Core\Repository\Helper\DomainMapper $domainMapper |
||
| 94 | * @param \eZ\Publish\Core\Repository\Helper\RelationProcessor $relationProcessor |
||
| 95 | * @param \eZ\Publish\Core\Repository\Helper\NameSchemaService $nameSchemaService |
||
| 96 | * @param \eZ\Publish\Core\Repository\Helper\FieldTypeRegistry $fieldTypeRegistry, |
||
|
|
|||
| 97 | * @param array $settings |
||
| 98 | */ |
||
| 99 | public function __construct( |
||
| 100 | RepositoryInterface $repository, |
||
| 101 | Handler $handler, |
||
| 102 | Helper\DomainMapper $domainMapper, |
||
| 103 | Helper\RelationProcessor $relationProcessor, |
||
| 104 | Helper\NameSchemaService $nameSchemaService, |
||
| 105 | Helper\FieldTypeRegistry $fieldTypeRegistry, |
||
| 106 | array $settings = array() |
||
| 107 | ) { |
||
| 108 | $this->repository = $repository; |
||
| 109 | $this->persistenceHandler = $handler; |
||
| 110 | $this->domainMapper = $domainMapper; |
||
| 111 | $this->relationProcessor = $relationProcessor; |
||
| 112 | $this->nameSchemaService = $nameSchemaService; |
||
| 113 | $this->fieldTypeRegistry = $fieldTypeRegistry; |
||
| 114 | // Union makes sure default settings are ignored if provided in argument |
||
| 115 | $this->settings = $settings + array( |
||
| 116 | // Version archive limit (0-50), only enforced on publish, not on un-publish. |
||
| 117 | 'default_version_archive_limit' => 5, |
||
| 118 | ); |
||
| 119 | } |
||
| 120 | |||
| 121 | /** |
||
| 122 | * Loads a content info object. |
||
| 123 | * |
||
| 124 | * To load fields use loadContent |
||
| 125 | * |
||
| 126 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the content |
||
| 127 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given id does not exist |
||
| 128 | * |
||
| 129 | * @param int $contentId |
||
| 130 | * |
||
| 131 | * @return \eZ\Publish\API\Repository\Values\Content\ContentInfo |
||
| 132 | */ |
||
| 133 | View Code Duplication | public function loadContentInfo($contentId) |
|
| 134 | { |
||
| 135 | $contentInfo = $this->internalLoadContentInfo($contentId); |
||
| 136 | if (!$this->repository->canUser('content', 'read', $contentInfo)) { |
||
| 137 | throw new UnauthorizedException('content', 'read', array('contentId' => $contentId)); |
||
| 138 | } |
||
| 139 | |||
| 140 | return $contentInfo; |
||
| 141 | } |
||
| 142 | |||
| 143 | /** |
||
| 144 | * {@inheritdoc} |
||
| 145 | */ |
||
| 146 | public function loadContentInfoList(array $contentIds): iterable |
||
| 147 | { |
||
| 148 | $contentInfoList = []; |
||
| 149 | $spiInfoList = $this->persistenceHandler->contentHandler()->loadContentInfoList($contentIds); |
||
| 150 | View Code Duplication | foreach ($spiInfoList as $id => $spiInfo) { |
|
| 151 | $contentInfo = $this->domainMapper->buildContentInfoDomainObject($spiInfo); |
||
| 152 | if ($this->repository->canUser('content', 'read', $contentInfo)) { |
||
| 153 | $contentInfoList[$id] = $contentInfo; |
||
| 154 | } |
||
| 155 | } |
||
| 156 | |||
| 157 | return $contentInfoList; |
||
| 158 | } |
||
| 159 | |||
| 160 | /** |
||
| 161 | * Loads a content info object. |
||
| 162 | * |
||
| 163 | * To load fields use loadContent |
||
| 164 | * |
||
| 165 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given id does not exist |
||
| 166 | * |
||
| 167 | * @param mixed $id |
||
| 168 | * @param bool $isRemoteId |
||
| 169 | * |
||
| 170 | * @return \eZ\Publish\API\Repository\Values\Content\ContentInfo |
||
| 171 | */ |
||
| 172 | public function internalLoadContentInfo($id, $isRemoteId = false) |
||
| 173 | { |
||
| 174 | try { |
||
| 175 | $method = $isRemoteId ? 'loadContentInfoByRemoteId' : 'loadContentInfo'; |
||
| 176 | |||
| 177 | return $this->domainMapper->buildContentInfoDomainObject( |
||
| 178 | $this->persistenceHandler->contentHandler()->$method($id) |
||
| 179 | ); |
||
| 180 | } catch (APINotFoundException $e) { |
||
| 181 | throw new NotFoundException( |
||
| 182 | 'Content', |
||
| 183 | $id, |
||
| 184 | $e |
||
| 185 | ); |
||
| 186 | } |
||
| 187 | } |
||
| 188 | |||
| 189 | /** |
||
| 190 | * Loads a content info object for the given remoteId. |
||
| 191 | * |
||
| 192 | * To load fields use loadContent |
||
| 193 | * |
||
| 194 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read the content |
||
| 195 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content with the given remote id does not exist |
||
| 196 | * |
||
| 197 | * @param string $remoteId |
||
| 198 | * |
||
| 199 | * @return \eZ\Publish\API\Repository\Values\Content\ContentInfo |
||
| 200 | */ |
||
| 201 | View Code Duplication | public function loadContentInfoByRemoteId($remoteId) |
|
| 202 | { |
||
| 203 | $contentInfo = $this->internalLoadContentInfo($remoteId, true); |
||
| 204 | |||
| 205 | if (!$this->repository->canUser('content', 'read', $contentInfo)) { |
||
| 206 | throw new UnauthorizedException('content', 'read', array('remoteId' => $remoteId)); |
||
| 207 | } |
||
| 208 | |||
| 209 | return $contentInfo; |
||
| 210 | } |
||
| 211 | |||
| 212 | /** |
||
| 213 | * Loads a version info of the given content object. |
||
| 214 | * |
||
| 215 | * If no version number is given, the method returns the current version |
||
| 216 | * |
||
| 217 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the version with the given number does not exist |
||
| 218 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version |
||
| 219 | * |
||
| 220 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
| 221 | * @param int $versionNo the version number. If not given the current version is returned. |
||
| 222 | * |
||
| 223 | * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo |
||
| 224 | */ |
||
| 225 | public function loadVersionInfo(ContentInfo $contentInfo, $versionNo = null) |
||
| 226 | { |
||
| 227 | return $this->loadVersionInfoById($contentInfo->id, $versionNo); |
||
| 228 | } |
||
| 229 | |||
| 230 | /** |
||
| 231 | * Loads a version info of the given content object id. |
||
| 232 | * |
||
| 233 | * If no version number is given, the method returns the current version |
||
| 234 | * |
||
| 235 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the version with the given number does not exist |
||
| 236 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to load this version |
||
| 237 | * |
||
| 238 | * @param mixed $contentId |
||
| 239 | * @param int $versionNo the version number. If not given the current version is returned. |
||
| 240 | * |
||
| 241 | * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo |
||
| 242 | */ |
||
| 243 | public function loadVersionInfoById($contentId, $versionNo = null) |
||
| 244 | { |
||
| 245 | // @todo SPI should also support null to avoid concurrency issues |
||
| 246 | if ($versionNo === null) { |
||
| 247 | $versionNo = $this->loadContentInfo($contentId)->currentVersionNo; |
||
| 248 | } |
||
| 249 | |||
| 250 | try { |
||
| 251 | $spiVersionInfo = $this->persistenceHandler->contentHandler()->loadVersionInfo( |
||
| 252 | $contentId, |
||
| 253 | $versionNo |
||
| 254 | ); |
||
| 255 | } catch (APINotFoundException $e) { |
||
| 256 | throw new NotFoundException( |
||
| 257 | 'VersionInfo', |
||
| 258 | array( |
||
| 259 | 'contentId' => $contentId, |
||
| 260 | 'versionNo' => $versionNo, |
||
| 261 | ), |
||
| 262 | $e |
||
| 263 | ); |
||
| 264 | } |
||
| 265 | |||
| 266 | $versionInfo = $this->domainMapper->buildVersionInfoDomainObject($spiVersionInfo); |
||
| 267 | |||
| 268 | if ($versionInfo->isPublished()) { |
||
| 269 | $function = 'read'; |
||
| 270 | } else { |
||
| 271 | $function = 'versionread'; |
||
| 272 | } |
||
| 273 | |||
| 274 | if (!$this->repository->canUser('content', $function, $versionInfo)) { |
||
| 275 | throw new UnauthorizedException('content', $function, array('contentId' => $contentId)); |
||
| 276 | } |
||
| 277 | |||
| 278 | return $versionInfo; |
||
| 279 | } |
||
| 280 | |||
| 281 | /** |
||
| 282 | * {@inheritdoc} |
||
| 283 | */ |
||
| 284 | public function loadContentByContentInfo(ContentInfo $contentInfo, array $languages = null, $versionNo = null, $useAlwaysAvailable = true) |
||
| 285 | { |
||
| 286 | // Change $useAlwaysAvailable to false to avoid contentInfo lookup if we know alwaysAvailable is disabled |
||
| 287 | if ($useAlwaysAvailable && !$contentInfo->alwaysAvailable) { |
||
| 288 | $useAlwaysAvailable = false; |
||
| 289 | } |
||
| 290 | |||
| 291 | return $this->loadContent( |
||
| 292 | $contentInfo->id, |
||
| 293 | $languages, |
||
| 294 | $versionNo,// On purpose pass as-is and not use $contentInfo, to make sure to return actual current version on null |
||
| 295 | $useAlwaysAvailable |
||
| 296 | ); |
||
| 297 | } |
||
| 298 | |||
| 299 | /** |
||
| 300 | * {@inheritdoc} |
||
| 301 | */ |
||
| 302 | public function loadContentByVersionInfo(APIVersionInfo $versionInfo, array $languages = null, $useAlwaysAvailable = true) |
||
| 303 | { |
||
| 304 | // Change $useAlwaysAvailable to false to avoid contentInfo lookup if we know alwaysAvailable is disabled |
||
| 305 | if ($useAlwaysAvailable && !$versionInfo->getContentInfo()->alwaysAvailable) { |
||
| 306 | $useAlwaysAvailable = false; |
||
| 307 | } |
||
| 308 | |||
| 309 | return $this->loadContent( |
||
| 310 | $versionInfo->getContentInfo()->id, |
||
| 311 | $languages, |
||
| 312 | $versionInfo->versionNo, |
||
| 313 | $useAlwaysAvailable |
||
| 314 | ); |
||
| 315 | } |
||
| 316 | |||
| 317 | /** |
||
| 318 | * {@inheritdoc} |
||
| 319 | */ |
||
| 320 | View Code Duplication | public function loadContent($contentId, array $languages = null, $versionNo = null, $useAlwaysAvailable = true) |
|
| 321 | { |
||
| 322 | $content = $this->internalLoadContent($contentId, $languages, $versionNo, false, $useAlwaysAvailable); |
||
| 323 | |||
| 324 | if (!$this->repository->canUser('content', 'read', $content)) { |
||
| 325 | throw new UnauthorizedException('content', 'read', array('contentId' => $contentId)); |
||
| 326 | } |
||
| 327 | if ( |
||
| 328 | !$content->getVersionInfo()->isPublished() |
||
| 329 | && !$this->repository->canUser('content', 'versionread', $content) |
||
| 330 | ) { |
||
| 331 | throw new UnauthorizedException('content', 'versionread', array('contentId' => $contentId, 'versionNo' => $versionNo)); |
||
| 332 | } |
||
| 333 | |||
| 334 | return $content; |
||
| 335 | } |
||
| 336 | |||
| 337 | /** |
||
| 338 | * Loads content in a version of the given content object. |
||
| 339 | * |
||
| 340 | * If no version number is given, the method returns the current version |
||
| 341 | * |
||
| 342 | * @internal |
||
| 343 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if the content or version with the given id and languages does not exist |
||
| 344 | * |
||
| 345 | * @param mixed $id |
||
| 346 | * @param array|null $languages A language priority, filters returned fields and is used as prioritized language code on |
||
| 347 | * returned value object. If not given all languages are returned. |
||
| 348 | * @param int|null $versionNo the version number. If not given the current version is returned |
||
| 349 | * @param bool $isRemoteId |
||
| 350 | * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true |
||
| 351 | * |
||
| 352 | * @return \eZ\Publish\API\Repository\Values\Content\Content |
||
| 353 | */ |
||
| 354 | public function internalLoadContent($id, array $languages = null, $versionNo = null, $isRemoteId = false, $useAlwaysAvailable = true) |
||
| 355 | { |
||
| 356 | try { |
||
| 357 | // Get Content ID if lookup by remote ID |
||
| 358 | if ($isRemoteId) { |
||
| 359 | $spiContentInfo = $this->persistenceHandler->contentHandler()->loadContentInfoByRemoteId($id); |
||
| 360 | $id = $spiContentInfo->id; |
||
| 361 | // Set $isRemoteId to false as the next loads will be for content id now that we have it (for exception use now) |
||
| 362 | $isRemoteId = false; |
||
| 363 | } |
||
| 364 | |||
| 365 | $loadLanguages = $languages; |
||
| 366 | $alwaysAvailableLanguageCode = null; |
||
| 367 | // Set main language on $languages filter if not empty (all) and $useAlwaysAvailable being true |
||
| 368 | // @todo Move use always available logic to SPI load methods, like done in location handler in 7.x |
||
| 369 | if (!empty($loadLanguages) && $useAlwaysAvailable) { |
||
| 370 | if (!isset($spiContentInfo)) { |
||
| 371 | $spiContentInfo = $this->persistenceHandler->contentHandler()->loadContentInfo($id); |
||
| 372 | } |
||
| 373 | |||
| 374 | if ($spiContentInfo->alwaysAvailable) { |
||
| 375 | $loadLanguages[] = $alwaysAvailableLanguageCode = $spiContentInfo->mainLanguageCode; |
||
| 376 | $loadLanguages = array_unique($loadLanguages); |
||
| 377 | } |
||
| 378 | } |
||
| 379 | |||
| 380 | $spiContent = $this->persistenceHandler->contentHandler()->load( |
||
| 381 | $id, |
||
| 382 | $versionNo, |
||
| 383 | $loadLanguages |
||
| 384 | ); |
||
| 385 | } catch (APINotFoundException $e) { |
||
| 386 | throw new NotFoundException( |
||
| 387 | 'Content', |
||
| 388 | array( |
||
| 389 | $isRemoteId ? 'remoteId' : 'id' => $id, |
||
| 390 | 'languages' => $languages, |
||
| 391 | 'versionNo' => $versionNo, |
||
| 392 | ), |
||
| 393 | $e |
||
| 394 | ); |
||
| 395 | } |
||
| 396 | |||
| 397 | return $this->domainMapper->buildContentDomainObject( |
||
| 398 | $spiContent, |
||
| 399 | $this->repository->getContentTypeService()->loadContentType( |
||
| 400 | $spiContent->versionInfo->contentInfo->contentTypeId |
||
| 401 | ), |
||
| 402 | $languages ?? [], |
||
| 403 | $alwaysAvailableLanguageCode |
||
| 404 | ); |
||
| 405 | } |
||
| 406 | |||
| 407 | /** |
||
| 408 | * Loads content in a version for the content object reference by the given remote id. |
||
| 409 | * |
||
| 410 | * If no version is given, the method returns the current version |
||
| 411 | * |
||
| 412 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException - if the content or version with the given remote id does not exist |
||
| 413 | * @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 |
||
| 414 | * |
||
| 415 | * @param string $remoteId |
||
| 416 | * @param array $languages A language filter for fields. If not given all languages are returned |
||
| 417 | * @param int $versionNo the version number. If not given the current version is returned |
||
| 418 | * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true |
||
| 419 | * |
||
| 420 | * @return \eZ\Publish\API\Repository\Values\Content\Content |
||
| 421 | */ |
||
| 422 | View Code Duplication | public function loadContentByRemoteId($remoteId, array $languages = null, $versionNo = null, $useAlwaysAvailable = true) |
|
| 423 | { |
||
| 424 | $content = $this->internalLoadContent($remoteId, $languages, $versionNo, true, $useAlwaysAvailable); |
||
| 425 | |||
| 426 | if (!$this->repository->canUser('content', 'read', $content)) { |
||
| 427 | throw new UnauthorizedException('content', 'read', array('remoteId' => $remoteId)); |
||
| 428 | } |
||
| 429 | |||
| 430 | if ( |
||
| 431 | !$content->getVersionInfo()->isPublished() |
||
| 432 | && !$this->repository->canUser('content', 'versionread', $content) |
||
| 433 | ) { |
||
| 434 | throw new UnauthorizedException('content', 'versionread', array('remoteId' => $remoteId, 'versionNo' => $versionNo)); |
||
| 435 | } |
||
| 436 | |||
| 437 | return $content; |
||
| 438 | } |
||
| 439 | |||
| 440 | /** |
||
| 441 | * Bulk-load Content items by the list of ContentInfo Value Objects. |
||
| 442 | * |
||
| 443 | * Note: it does not throw exceptions on load, just ignores erroneous Content item. |
||
| 444 | * Moreover, since the method works on pre-loaded ContentInfo list, it is assumed that user is |
||
| 445 | * allowed to access every Content on the list. |
||
| 446 | * |
||
| 447 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo[] $contentInfoList |
||
| 448 | * @param string[] $languages A language priority, filters returned fields and is used as prioritized language code on |
||
| 449 | * returned value object. If not given all languages are returned. |
||
| 450 | * @param bool $useAlwaysAvailable Add Main language to \$languages if true (default) and if alwaysAvailable is true, |
||
| 451 | * unless all languages have been asked for. |
||
| 452 | * |
||
| 453 | * @return \eZ\Publish\API\Repository\Values\Content\Content[] list of Content items with Content Ids as keys |
||
| 454 | */ |
||
| 455 | public function loadContentListByContentInfo( |
||
| 456 | array $contentInfoList, |
||
| 457 | array $languages = [], |
||
| 458 | $useAlwaysAvailable = true |
||
| 459 | ) { |
||
| 460 | $loadAllLanguages = $languages === Language::ALL; |
||
| 461 | $contentIds = []; |
||
| 462 | $contentTypeIds = []; |
||
| 463 | $translations = $languages; |
||
| 464 | foreach ($contentInfoList as $contentInfo) { |
||
| 465 | $contentIds[] = $contentInfo->id; |
||
| 466 | $contentTypeIds[] = $contentInfo->contentTypeId; |
||
| 467 | // Unless we are told to load all languages, we add main language to translations so they are loaded too |
||
| 468 | // Might in some case load more languages then intended, but prioritised handling will pick right one |
||
| 469 | if (!$loadAllLanguages && $useAlwaysAvailable && $contentInfo->alwaysAvailable) { |
||
| 470 | $translations[] = $contentInfo->mainLanguageCode; |
||
| 471 | } |
||
| 472 | } |
||
| 473 | |||
| 474 | $contentList = []; |
||
| 475 | $translations = array_unique($translations); |
||
| 476 | $spiContentList = $this->persistenceHandler->contentHandler()->loadContentList( |
||
| 477 | $contentIds, |
||
| 478 | $translations |
||
| 479 | ); |
||
| 480 | $contentTypeList = $this->repository->getContentTypeService()->loadContentTypeList( |
||
| 481 | array_unique($contentTypeIds), |
||
| 482 | $languages |
||
| 483 | ); |
||
| 484 | foreach ($spiContentList as $contentId => $spiContent) { |
||
| 485 | $contentInfo = $spiContent->versionInfo->contentInfo; |
||
| 486 | $contentList[$contentId] = $this->domainMapper->buildContentDomainObject( |
||
| 487 | $spiContent, |
||
| 488 | $contentTypeList[$contentInfo->contentTypeId], |
||
| 489 | $languages, |
||
| 490 | $contentInfo->alwaysAvailable ? $contentInfo->mainLanguageCode : null |
||
| 491 | ); |
||
| 492 | } |
||
| 493 | |||
| 494 | return $contentList; |
||
| 495 | } |
||
| 496 | |||
| 497 | /** |
||
| 498 | * Creates a new content draft assigned to the authenticated user. |
||
| 499 | * |
||
| 500 | * If a different userId is given in $contentCreateStruct it is assigned to the given user |
||
| 501 | * but this required special rights for the authenticated user |
||
| 502 | * (this is useful for content staging where the transfer process does not |
||
| 503 | * have to authenticate with the user which created the content object in the source server). |
||
| 504 | * The user has to publish the draft if it should be visible. |
||
| 505 | * In 4.x at least one location has to be provided in the location creation array. |
||
| 506 | * |
||
| 507 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to create the content in the given location |
||
| 508 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the provided remoteId exists in the system, required properties on |
||
| 509 | * struct are missing or invalid, or if multiple locations are under the |
||
| 510 | * same parent. |
||
| 511 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $contentCreateStruct is not valid, |
||
| 512 | * or if a required field is missing / set to an empty value. |
||
| 513 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException If field definition does not exist in the ContentType, |
||
| 514 | * or value is set for non-translatable field in language |
||
| 515 | * other than main. |
||
| 516 | * |
||
| 517 | * @param \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct $contentCreateStruct |
||
| 518 | * @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct[] $locationCreateStructs For each location parent under which a location should be created for the content |
||
| 519 | * |
||
| 520 | * @return \eZ\Publish\API\Repository\Values\Content\Content - the newly created content draft |
||
| 521 | */ |
||
| 522 | public function createContent(APIContentCreateStruct $contentCreateStruct, array $locationCreateStructs = array()) |
||
| 523 | { |
||
| 524 | if ($contentCreateStruct->mainLanguageCode === null) { |
||
| 525 | throw new InvalidArgumentException('$contentCreateStruct', "'mainLanguageCode' property must be set"); |
||
| 526 | } |
||
| 527 | |||
| 528 | if ($contentCreateStruct->contentType === null) { |
||
| 529 | throw new InvalidArgumentException('$contentCreateStruct', "'contentType' property must be set"); |
||
| 530 | } |
||
| 531 | |||
| 532 | $contentCreateStruct = clone $contentCreateStruct; |
||
| 533 | |||
| 534 | if ($contentCreateStruct->ownerId === null) { |
||
| 535 | $contentCreateStruct->ownerId = $this->repository->getCurrentUserReference()->getUserId(); |
||
| 536 | } |
||
| 537 | |||
| 538 | if ($contentCreateStruct->alwaysAvailable === null) { |
||
| 539 | $contentCreateStruct->alwaysAvailable = $contentCreateStruct->contentType->defaultAlwaysAvailable ?: false; |
||
| 540 | } |
||
| 541 | |||
| 542 | $contentCreateStruct->contentType = $this->repository->getContentTypeService()->loadContentType( |
||
| 543 | $contentCreateStruct->contentType->id |
||
| 544 | ); |
||
| 545 | |||
| 546 | if (empty($contentCreateStruct->sectionId)) { |
||
| 547 | if (isset($locationCreateStructs[0])) { |
||
| 548 | $location = $this->repository->getLocationService()->loadLocation( |
||
| 549 | $locationCreateStructs[0]->parentLocationId |
||
| 550 | ); |
||
| 551 | $contentCreateStruct->sectionId = $location->contentInfo->sectionId; |
||
| 552 | } else { |
||
| 553 | $contentCreateStruct->sectionId = 1; |
||
| 554 | } |
||
| 555 | } |
||
| 556 | |||
| 557 | if (!$this->repository->canUser('content', 'create', $contentCreateStruct, $locationCreateStructs)) { |
||
| 558 | throw new UnauthorizedException( |
||
| 559 | 'content', |
||
| 560 | 'create', |
||
| 561 | array( |
||
| 562 | 'parentLocationId' => isset($locationCreateStructs[0]) ? |
||
| 563 | $locationCreateStructs[0]->parentLocationId : |
||
| 564 | null, |
||
| 565 | 'sectionId' => $contentCreateStruct->sectionId, |
||
| 566 | ) |
||
| 567 | ); |
||
| 568 | } |
||
| 569 | |||
| 570 | if (!empty($contentCreateStruct->remoteId)) { |
||
| 571 | try { |
||
| 572 | $this->loadContentByRemoteId($contentCreateStruct->remoteId); |
||
| 573 | |||
| 574 | throw new InvalidArgumentException( |
||
| 575 | '$contentCreateStruct', |
||
| 576 | "Another content with remoteId '{$contentCreateStruct->remoteId}' exists" |
||
| 577 | ); |
||
| 578 | } catch (APINotFoundException $e) { |
||
| 579 | // Do nothing |
||
| 580 | } |
||
| 581 | } else { |
||
| 582 | $contentCreateStruct->remoteId = $this->domainMapper->getUniqueHash($contentCreateStruct); |
||
| 583 | } |
||
| 584 | |||
| 585 | $spiLocationCreateStructs = $this->buildSPILocationCreateStructs($locationCreateStructs); |
||
| 586 | |||
| 587 | $languageCodes = $this->getLanguageCodesForCreate($contentCreateStruct); |
||
| 588 | $fields = $this->mapFieldsForCreate($contentCreateStruct); |
||
| 589 | |||
| 590 | $fieldValues = array(); |
||
| 591 | $spiFields = array(); |
||
| 592 | $allFieldErrors = array(); |
||
| 593 | $inputRelations = array(); |
||
| 594 | $locationIdToContentIdMapping = array(); |
||
| 595 | |||
| 596 | foreach ($contentCreateStruct->contentType->getFieldDefinitions() as $fieldDefinition) { |
||
| 597 | /** @var $fieldType \eZ\Publish\Core\FieldType\FieldType */ |
||
| 598 | $fieldType = $this->fieldTypeRegistry->getFieldType( |
||
| 599 | $fieldDefinition->fieldTypeIdentifier |
||
| 600 | ); |
||
| 601 | |||
| 602 | foreach ($languageCodes as $languageCode) { |
||
| 603 | $isEmptyValue = false; |
||
| 604 | $valueLanguageCode = $fieldDefinition->isTranslatable ? $languageCode : $contentCreateStruct->mainLanguageCode; |
||
| 605 | $isLanguageMain = $languageCode === $contentCreateStruct->mainLanguageCode; |
||
| 606 | if (isset($fields[$fieldDefinition->identifier][$valueLanguageCode])) { |
||
| 607 | $fieldValue = $fields[$fieldDefinition->identifier][$valueLanguageCode]->value; |
||
| 608 | } else { |
||
| 609 | $fieldValue = $fieldDefinition->defaultValue; |
||
| 610 | } |
||
| 611 | |||
| 612 | $fieldValue = $fieldType->acceptValue($fieldValue); |
||
| 613 | |||
| 614 | View Code Duplication | if ($fieldType->isEmptyValue($fieldValue)) { |
|
| 615 | $isEmptyValue = true; |
||
| 616 | if ($fieldDefinition->isRequired) { |
||
| 617 | $allFieldErrors[$fieldDefinition->id][$languageCode] = new ValidationError( |
||
| 618 | "Value for required field definition '%identifier%' with language '%languageCode%' is empty", |
||
| 619 | null, |
||
| 620 | ['%identifier%' => $fieldDefinition->identifier, '%languageCode%' => $languageCode], |
||
| 621 | 'empty' |
||
| 622 | ); |
||
| 623 | } |
||
| 624 | } else { |
||
| 625 | $fieldErrors = $fieldType->validate( |
||
| 626 | $fieldDefinition, |
||
| 627 | $fieldValue |
||
| 628 | ); |
||
| 629 | if (!empty($fieldErrors)) { |
||
| 630 | $allFieldErrors[$fieldDefinition->id][$languageCode] = $fieldErrors; |
||
| 631 | } |
||
| 632 | } |
||
| 633 | |||
| 634 | if (!empty($allFieldErrors)) { |
||
| 635 | continue; |
||
| 636 | } |
||
| 637 | |||
| 638 | $this->relationProcessor->appendFieldRelations( |
||
| 639 | $inputRelations, |
||
| 640 | $locationIdToContentIdMapping, |
||
| 641 | $fieldType, |
||
| 642 | $fieldValue, |
||
| 643 | $fieldDefinition->id |
||
| 644 | ); |
||
| 645 | $fieldValues[$fieldDefinition->identifier][$languageCode] = $fieldValue; |
||
| 646 | |||
| 647 | // Only non-empty value for: translatable field or in main language |
||
| 648 | if ( |
||
| 649 | (!$isEmptyValue && $fieldDefinition->isTranslatable) || |
||
| 650 | (!$isEmptyValue && $isLanguageMain) |
||
| 651 | ) { |
||
| 652 | $spiFields[] = new SPIField( |
||
| 653 | array( |
||
| 654 | 'id' => null, |
||
| 655 | 'fieldDefinitionId' => $fieldDefinition->id, |
||
| 656 | 'type' => $fieldDefinition->fieldTypeIdentifier, |
||
| 657 | 'value' => $fieldType->toPersistenceValue($fieldValue), |
||
| 658 | 'languageCode' => $languageCode, |
||
| 659 | 'versionNo' => null, |
||
| 660 | ) |
||
| 661 | ); |
||
| 662 | } |
||
| 663 | } |
||
| 664 | } |
||
| 665 | |||
| 666 | if (!empty($allFieldErrors)) { |
||
| 667 | throw new ContentFieldValidationException($allFieldErrors); |
||
| 668 | } |
||
| 669 | |||
| 670 | $spiContentCreateStruct = new SPIContentCreateStruct( |
||
| 671 | array( |
||
| 672 | 'name' => $this->nameSchemaService->resolve( |
||
| 673 | $contentCreateStruct->contentType->nameSchema, |
||
| 674 | $contentCreateStruct->contentType, |
||
| 675 | $fieldValues, |
||
| 676 | $languageCodes |
||
| 677 | ), |
||
| 678 | 'typeId' => $contentCreateStruct->contentType->id, |
||
| 679 | 'sectionId' => $contentCreateStruct->sectionId, |
||
| 680 | 'ownerId' => $contentCreateStruct->ownerId, |
||
| 681 | 'locations' => $spiLocationCreateStructs, |
||
| 682 | 'fields' => $spiFields, |
||
| 683 | 'alwaysAvailable' => $contentCreateStruct->alwaysAvailable, |
||
| 684 | 'remoteId' => $contentCreateStruct->remoteId, |
||
| 685 | 'modified' => isset($contentCreateStruct->modificationDate) ? $contentCreateStruct->modificationDate->getTimestamp() : time(), |
||
| 686 | 'initialLanguageId' => $this->persistenceHandler->contentLanguageHandler()->loadByLanguageCode( |
||
| 687 | $contentCreateStruct->mainLanguageCode |
||
| 688 | )->id, |
||
| 689 | ) |
||
| 690 | ); |
||
| 691 | |||
| 692 | $defaultObjectStates = $this->getDefaultObjectStates(); |
||
| 693 | |||
| 694 | $this->repository->beginTransaction(); |
||
| 695 | try { |
||
| 696 | $spiContent = $this->persistenceHandler->contentHandler()->create($spiContentCreateStruct); |
||
| 697 | $this->relationProcessor->processFieldRelations( |
||
| 698 | $inputRelations, |
||
| 699 | $spiContent->versionInfo->contentInfo->id, |
||
| 700 | $spiContent->versionInfo->versionNo, |
||
| 701 | $contentCreateStruct->contentType |
||
| 702 | ); |
||
| 703 | |||
| 704 | $objectStateHandler = $this->persistenceHandler->objectStateHandler(); |
||
| 705 | foreach ($defaultObjectStates as $objectStateGroupId => $objectState) { |
||
| 706 | $objectStateHandler->setContentState( |
||
| 707 | $spiContent->versionInfo->contentInfo->id, |
||
| 708 | $objectStateGroupId, |
||
| 709 | $objectState->id |
||
| 710 | ); |
||
| 711 | } |
||
| 712 | |||
| 713 | $this->repository->commit(); |
||
| 714 | } catch (Exception $e) { |
||
| 715 | $this->repository->rollback(); |
||
| 716 | throw $e; |
||
| 717 | } |
||
| 718 | |||
| 719 | return $this->domainMapper->buildContentDomainObject( |
||
| 720 | $spiContent, |
||
| 721 | $contentCreateStruct->contentType |
||
| 722 | ); |
||
| 723 | } |
||
| 724 | |||
| 725 | /** |
||
| 726 | * Returns an array of default content states with content state group id as key. |
||
| 727 | * |
||
| 728 | * @return \eZ\Publish\SPI\Persistence\Content\ObjectState[] |
||
| 729 | */ |
||
| 730 | protected function getDefaultObjectStates() |
||
| 731 | { |
||
| 732 | $defaultObjectStatesMap = array(); |
||
| 733 | $objectStateHandler = $this->persistenceHandler->objectStateHandler(); |
||
| 734 | |||
| 735 | foreach ($objectStateHandler->loadAllGroups() as $objectStateGroup) { |
||
| 736 | foreach ($objectStateHandler->loadObjectStates($objectStateGroup->id) as $objectState) { |
||
| 737 | // Only register the first object state which is the default one. |
||
| 738 | $defaultObjectStatesMap[$objectStateGroup->id] = $objectState; |
||
| 739 | break; |
||
| 740 | } |
||
| 741 | } |
||
| 742 | |||
| 743 | return $defaultObjectStatesMap; |
||
| 744 | } |
||
| 745 | |||
| 746 | /** |
||
| 747 | * Returns all language codes used in given $fields. |
||
| 748 | * |
||
| 749 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if no field value is set in main language |
||
| 750 | * |
||
| 751 | * @param \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct $contentCreateStruct |
||
| 752 | * |
||
| 753 | * @return string[] |
||
| 754 | */ |
||
| 755 | protected function getLanguageCodesForCreate(APIContentCreateStruct $contentCreateStruct) |
||
| 756 | { |
||
| 757 | $languageCodes = array(); |
||
| 758 | |||
| 759 | foreach ($contentCreateStruct->fields as $field) { |
||
| 760 | if ($field->languageCode === null || isset($languageCodes[$field->languageCode])) { |
||
| 761 | continue; |
||
| 762 | } |
||
| 763 | |||
| 764 | $this->persistenceHandler->contentLanguageHandler()->loadByLanguageCode( |
||
| 765 | $field->languageCode |
||
| 766 | ); |
||
| 767 | $languageCodes[$field->languageCode] = true; |
||
| 768 | } |
||
| 769 | |||
| 770 | if (!isset($languageCodes[$contentCreateStruct->mainLanguageCode])) { |
||
| 771 | $this->persistenceHandler->contentLanguageHandler()->loadByLanguageCode( |
||
| 772 | $contentCreateStruct->mainLanguageCode |
||
| 773 | ); |
||
| 774 | $languageCodes[$contentCreateStruct->mainLanguageCode] = true; |
||
| 775 | } |
||
| 776 | |||
| 777 | return array_keys($languageCodes); |
||
| 778 | } |
||
| 779 | |||
| 780 | /** |
||
| 781 | * Returns an array of fields like $fields[$field->fieldDefIdentifier][$field->languageCode]. |
||
| 782 | * |
||
| 783 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException If field definition does not exist in the ContentType |
||
| 784 | * or value is set for non-translatable field in language |
||
| 785 | * other than main |
||
| 786 | * |
||
| 787 | * @param \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct $contentCreateStruct |
||
| 788 | * |
||
| 789 | * @return array |
||
| 790 | */ |
||
| 791 | protected function mapFieldsForCreate(APIContentCreateStruct $contentCreateStruct) |
||
| 792 | { |
||
| 793 | $fields = array(); |
||
| 794 | |||
| 795 | foreach ($contentCreateStruct->fields as $field) { |
||
| 796 | $fieldDefinition = $contentCreateStruct->contentType->getFieldDefinition($field->fieldDefIdentifier); |
||
| 797 | |||
| 798 | if ($fieldDefinition === null) { |
||
| 799 | throw new ContentValidationException( |
||
| 800 | "Field definition '%identifier%' does not exist in given ContentType", |
||
| 801 | ['%identifier%' => $field->fieldDefIdentifier] |
||
| 802 | ); |
||
| 803 | } |
||
| 804 | |||
| 805 | if ($field->languageCode === null) { |
||
| 806 | $field = $this->cloneField( |
||
| 807 | $field, |
||
| 808 | array('languageCode' => $contentCreateStruct->mainLanguageCode) |
||
| 809 | ); |
||
| 810 | } |
||
| 811 | |||
| 812 | View Code Duplication | if (!$fieldDefinition->isTranslatable && ($field->languageCode != $contentCreateStruct->mainLanguageCode)) { |
|
| 813 | throw new ContentValidationException( |
||
| 814 | "A value is set for non translatable field definition '%identifier%' with language '%languageCode%'", |
||
| 815 | ['%identifier%' => $field->fieldDefIdentifier, '%languageCode%' => $field->languageCode] |
||
| 816 | ); |
||
| 817 | } |
||
| 818 | |||
| 819 | $fields[$field->fieldDefIdentifier][$field->languageCode] = $field; |
||
| 820 | } |
||
| 821 | |||
| 822 | return $fields; |
||
| 823 | } |
||
| 824 | |||
| 825 | /** |
||
| 826 | * Clones $field with overriding specific properties from given $overrides array. |
||
| 827 | * |
||
| 828 | * @param Field $field |
||
| 829 | * @param array $overrides |
||
| 830 | * |
||
| 831 | * @return Field |
||
| 832 | */ |
||
| 833 | private function cloneField(Field $field, array $overrides = []) |
||
| 834 | { |
||
| 835 | $fieldData = array_merge( |
||
| 836 | [ |
||
| 837 | 'id' => $field->id, |
||
| 838 | 'value' => $field->value, |
||
| 839 | 'languageCode' => $field->languageCode, |
||
| 840 | 'fieldDefIdentifier' => $field->fieldDefIdentifier, |
||
| 841 | 'fieldTypeIdentifier' => $field->fieldTypeIdentifier, |
||
| 842 | ], |
||
| 843 | $overrides |
||
| 844 | ); |
||
| 845 | |||
| 846 | return new Field($fieldData); |
||
| 847 | } |
||
| 848 | |||
| 849 | /** |
||
| 850 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException |
||
| 851 | * |
||
| 852 | * @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct[] $locationCreateStructs |
||
| 853 | * |
||
| 854 | * @return \eZ\Publish\SPI\Persistence\Content\Location\CreateStruct[] |
||
| 855 | */ |
||
| 856 | protected function buildSPILocationCreateStructs(array $locationCreateStructs) |
||
| 857 | { |
||
| 858 | $spiLocationCreateStructs = array(); |
||
| 859 | $parentLocationIdSet = array(); |
||
| 860 | $mainLocation = true; |
||
| 861 | |||
| 862 | foreach ($locationCreateStructs as $locationCreateStruct) { |
||
| 863 | if (isset($parentLocationIdSet[$locationCreateStruct->parentLocationId])) { |
||
| 864 | throw new InvalidArgumentException( |
||
| 865 | '$locationCreateStructs', |
||
| 866 | "Multiple LocationCreateStructs with the same parent Location '{$locationCreateStruct->parentLocationId}' are given" |
||
| 867 | ); |
||
| 868 | } |
||
| 869 | |||
| 870 | if (!array_key_exists($locationCreateStruct->sortField, Location::SORT_FIELD_MAP)) { |
||
| 871 | $locationCreateStruct->sortField = Location::SORT_FIELD_NAME; |
||
| 872 | } |
||
| 873 | |||
| 874 | if (!array_key_exists($locationCreateStruct->sortOrder, Location::SORT_ORDER_MAP)) { |
||
| 875 | $locationCreateStruct->sortOrder = Location::SORT_ORDER_ASC; |
||
| 876 | } |
||
| 877 | |||
| 878 | $parentLocationIdSet[$locationCreateStruct->parentLocationId] = true; |
||
| 879 | $parentLocation = $this->repository->getLocationService()->loadLocation( |
||
| 880 | $locationCreateStruct->parentLocationId |
||
| 881 | ); |
||
| 882 | |||
| 883 | $spiLocationCreateStructs[] = $this->domainMapper->buildSPILocationCreateStruct( |
||
| 884 | $locationCreateStruct, |
||
| 885 | $parentLocation, |
||
| 886 | $mainLocation, |
||
| 887 | // For Content draft contentId and contentVersionNo are set in ContentHandler upon draft creation |
||
| 888 | null, |
||
| 889 | null |
||
| 890 | ); |
||
| 891 | |||
| 892 | // First Location in the list will be created as main Location |
||
| 893 | $mainLocation = false; |
||
| 894 | } |
||
| 895 | |||
| 896 | return $spiLocationCreateStructs; |
||
| 897 | } |
||
| 898 | |||
| 899 | /** |
||
| 900 | * Updates the metadata. |
||
| 901 | * |
||
| 902 | * (see {@link ContentMetadataUpdateStruct}) of a content object - to update fields use updateContent |
||
| 903 | * |
||
| 904 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to update the content meta data |
||
| 905 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if the remoteId in $contentMetadataUpdateStruct is set but already exists |
||
| 906 | * |
||
| 907 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
| 908 | * @param \eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct $contentMetadataUpdateStruct |
||
| 909 | * |
||
| 910 | * @return \eZ\Publish\API\Repository\Values\Content\Content the content with the updated attributes |
||
| 911 | */ |
||
| 912 | public function updateContentMetadata(ContentInfo $contentInfo, ContentMetadataUpdateStruct $contentMetadataUpdateStruct) |
||
| 913 | { |
||
| 914 | $propertyCount = 0; |
||
| 915 | foreach ($contentMetadataUpdateStruct as $propertyName => $propertyValue) { |
||
| 916 | if (isset($contentMetadataUpdateStruct->$propertyName)) { |
||
| 917 | $propertyCount += 1; |
||
| 918 | } |
||
| 919 | } |
||
| 920 | if ($propertyCount === 0) { |
||
| 921 | throw new InvalidArgumentException( |
||
| 922 | '$contentMetadataUpdateStruct', |
||
| 923 | 'At least one property must be set' |
||
| 924 | ); |
||
| 925 | } |
||
| 926 | |||
| 927 | $loadedContentInfo = $this->loadContentInfo($contentInfo->id); |
||
| 928 | |||
| 929 | if (!$this->repository->canUser('content', 'edit', $loadedContentInfo)) { |
||
| 930 | throw new UnauthorizedException('content', 'edit', array('contentId' => $loadedContentInfo->id)); |
||
| 931 | } |
||
| 932 | |||
| 933 | if (isset($contentMetadataUpdateStruct->remoteId)) { |
||
| 934 | try { |
||
| 935 | $existingContentInfo = $this->loadContentInfoByRemoteId($contentMetadataUpdateStruct->remoteId); |
||
| 936 | |||
| 937 | if ($existingContentInfo->id !== $loadedContentInfo->id) { |
||
| 938 | throw new InvalidArgumentException( |
||
| 939 | '$contentMetadataUpdateStruct', |
||
| 940 | "Another content with remoteId '{$contentMetadataUpdateStruct->remoteId}' exists" |
||
| 941 | ); |
||
| 942 | } |
||
| 943 | } catch (APINotFoundException $e) { |
||
| 944 | // Do nothing |
||
| 945 | } |
||
| 946 | } |
||
| 947 | |||
| 948 | $this->repository->beginTransaction(); |
||
| 949 | try { |
||
| 950 | if ($propertyCount > 1 || !isset($contentMetadataUpdateStruct->mainLocationId)) { |
||
| 951 | $this->persistenceHandler->contentHandler()->updateMetadata( |
||
| 952 | $loadedContentInfo->id, |
||
| 953 | new SPIMetadataUpdateStruct( |
||
| 954 | array( |
||
| 955 | 'ownerId' => $contentMetadataUpdateStruct->ownerId, |
||
| 956 | 'publicationDate' => isset($contentMetadataUpdateStruct->publishedDate) ? |
||
| 957 | $contentMetadataUpdateStruct->publishedDate->getTimestamp() : |
||
| 958 | null, |
||
| 959 | 'modificationDate' => isset($contentMetadataUpdateStruct->modificationDate) ? |
||
| 960 | $contentMetadataUpdateStruct->modificationDate->getTimestamp() : |
||
| 961 | null, |
||
| 962 | 'mainLanguageId' => isset($contentMetadataUpdateStruct->mainLanguageCode) ? |
||
| 963 | $this->repository->getContentLanguageService()->loadLanguage( |
||
| 964 | $contentMetadataUpdateStruct->mainLanguageCode |
||
| 965 | )->id : |
||
| 966 | null, |
||
| 967 | 'alwaysAvailable' => $contentMetadataUpdateStruct->alwaysAvailable, |
||
| 968 | 'remoteId' => $contentMetadataUpdateStruct->remoteId, |
||
| 969 | 'name' => $contentMetadataUpdateStruct->name, |
||
| 970 | ) |
||
| 971 | ) |
||
| 972 | ); |
||
| 973 | } |
||
| 974 | |||
| 975 | // Change main location |
||
| 976 | if (isset($contentMetadataUpdateStruct->mainLocationId) |
||
| 977 | && $loadedContentInfo->mainLocationId !== $contentMetadataUpdateStruct->mainLocationId) { |
||
| 978 | $this->persistenceHandler->locationHandler()->changeMainLocation( |
||
| 979 | $loadedContentInfo->id, |
||
| 980 | $contentMetadataUpdateStruct->mainLocationId |
||
| 981 | ); |
||
| 982 | } |
||
| 983 | |||
| 984 | // Republish URL aliases to update always-available flag |
||
| 985 | if (isset($contentMetadataUpdateStruct->alwaysAvailable) |
||
| 986 | && $loadedContentInfo->alwaysAvailable !== $contentMetadataUpdateStruct->alwaysAvailable) { |
||
| 987 | $content = $this->loadContent($loadedContentInfo->id); |
||
| 988 | $this->publishUrlAliasesForContent($content, false); |
||
| 989 | } |
||
| 990 | |||
| 991 | $this->repository->commit(); |
||
| 992 | } catch (Exception $e) { |
||
| 993 | $this->repository->rollback(); |
||
| 994 | throw $e; |
||
| 995 | } |
||
| 996 | |||
| 997 | return isset($content) ? $content : $this->loadContent($loadedContentInfo->id); |
||
| 998 | } |
||
| 999 | |||
| 1000 | /** |
||
| 1001 | * Publishes URL aliases for all locations of a given content. |
||
| 1002 | * |
||
| 1003 | * @param \eZ\Publish\API\Repository\Values\Content\Content $content |
||
| 1004 | * @param bool $updatePathIdentificationString this parameter is legacy storage specific for updating |
||
| 1005 | * ezcontentobject_tree.path_identification_string, it is ignored by other storage engines |
||
| 1006 | */ |
||
| 1007 | protected function publishUrlAliasesForContent(APIContent $content, $updatePathIdentificationString = true) |
||
| 1033 | |||
| 1034 | /** |
||
| 1035 | * Deletes a content object including all its versions and locations including their subtrees. |
||
| 1036 | * |
||
| 1037 | * @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) |
||
| 1038 | * |
||
| 1039 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
| 1040 | * |
||
| 1041 | * @return mixed[] Affected Location Id's |
||
| 1042 | */ |
||
| 1043 | public function deleteContent(ContentInfo $contentInfo) |
||
| 1070 | |||
| 1071 | /** |
||
| 1072 | * Creates a draft from a published or archived version. |
||
| 1073 | * |
||
| 1074 | * If no version is given, the current published version is used. |
||
| 1075 | * 4.x: The draft is created with the initialLanguage code of the source version or if not present with the main language. |
||
| 1076 | * It can be changed on updating the version. |
||
| 1077 | * |
||
| 1078 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
| 1079 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
| 1080 | * @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 |
||
| 1081 | * |
||
| 1082 | * @return \eZ\Publish\API\Repository\Values\Content\Content - the newly created content draft |
||
| 1083 | * |
||
| 1084 | * @throws \eZ\Publish\API\Repository\Exceptions\ForbiddenException |
||
| 1085 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if the current-user is not allowed to create the draft |
||
| 1086 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the current-user is not allowed to create the draft |
||
| 1087 | */ |
||
| 1088 | public function createContentDraft(ContentInfo $contentInfo, APIVersionInfo $versionInfo = null, User $creator = null) |
||
| 1089 | { |
||
| 1090 | $contentInfo = $this->loadContentInfo($contentInfo->id); |
||
| 1168 | |||
| 1169 | /** |
||
| 1170 | * Loads drafts for a user. |
||
| 1171 | * |
||
| 1172 | * If no user is given the drafts for the authenticated user a returned |
||
| 1173 | * |
||
| 1174 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the current-user is not allowed to load the draft list |
||
| 1175 | * |
||
| 1176 | * @param \eZ\Publish\API\Repository\Values\User\UserReference $user |
||
| 1177 | * |
||
| 1178 | * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo the drafts ({@link VersionInfo}) owned by the given user |
||
| 1179 | */ |
||
| 1180 | public function loadContentDrafts(User $user = null) |
||
| 1205 | |||
| 1206 | /** |
||
| 1207 | * Updates the fields of a draft. |
||
| 1208 | * |
||
| 1209 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
| 1210 | * @param \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct $contentUpdateStruct |
||
| 1211 | * |
||
| 1212 | * @return \eZ\Publish\API\Repository\Values\Content\Content the content draft with the updated fields |
||
| 1213 | * |
||
| 1214 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentFieldValidationException if a field in the $contentCreateStruct is not valid, |
||
| 1215 | * or if a required field is missing / set to an empty value. |
||
| 1216 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException If field definition does not exist in the ContentType, |
||
| 1217 | * or value is set for non-translatable field in language |
||
| 1218 | * other than main. |
||
| 1219 | * |
||
| 1220 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to update this version |
||
| 1221 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft |
||
| 1222 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if a property on the struct is invalid. |
||
| 1223 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException |
||
| 1224 | */ |
||
| 1225 | public function updateContent(APIVersionInfo $versionInfo, APIContentUpdateStruct $contentUpdateStruct) |
||
| 1412 | |||
| 1413 | /** |
||
| 1414 | * Returns only updated language codes. |
||
| 1415 | * |
||
| 1416 | * @param \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct $contentUpdateStruct |
||
| 1417 | * |
||
| 1418 | * @return array |
||
| 1419 | */ |
||
| 1420 | View Code Duplication | private function getUpdatedLanguageCodes(APIContentUpdateStruct $contentUpdateStruct) |
|
| 1436 | |||
| 1437 | /** |
||
| 1438 | * Returns all language codes used in given $fields. |
||
| 1439 | * |
||
| 1440 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException if no field value exists in initial language |
||
| 1441 | * |
||
| 1442 | * @param \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct $contentUpdateStruct |
||
| 1443 | * @param \eZ\Publish\API\Repository\Values\Content\Content $content |
||
| 1444 | * |
||
| 1445 | * @return array |
||
| 1446 | */ |
||
| 1447 | protected function getLanguageCodesForUpdate(APIContentUpdateStruct $contentUpdateStruct, APIContent $content) |
||
| 1459 | |||
| 1460 | /** |
||
| 1461 | * Returns an array of fields like $fields[$field->fieldDefIdentifier][$field->languageCode]. |
||
| 1462 | * |
||
| 1463 | * @throws \eZ\Publish\API\Repository\Exceptions\ContentValidationException If field definition does not exist in the ContentType |
||
| 1464 | * or value is set for non-translatable field in language |
||
| 1465 | * other than main |
||
| 1466 | * |
||
| 1467 | * @param \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct $contentUpdateStruct |
||
| 1468 | * @param \eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType |
||
| 1469 | * @param string $mainLanguageCode |
||
| 1470 | * |
||
| 1471 | * @return array |
||
| 1472 | */ |
||
| 1473 | protected function mapFieldsForUpdate( |
||
| 1511 | |||
| 1512 | /** |
||
| 1513 | * Publishes a content version. |
||
| 1514 | * |
||
| 1515 | * Publishes a content version and deletes archive versions if they overflow max archive versions. |
||
| 1516 | * Max archive versions are currently a configuration, but might be moved to be a param of ContentType in the future. |
||
| 1517 | * |
||
| 1518 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
| 1519 | * |
||
| 1520 | * @return \eZ\Publish\API\Repository\Values\Content\Content |
||
| 1521 | * |
||
| 1522 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft |
||
| 1523 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException |
||
| 1524 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException |
||
| 1525 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException |
||
| 1526 | */ |
||
| 1527 | public function publishVersion(APIVersionInfo $versionInfo) |
||
| 1569 | |||
| 1570 | /** |
||
| 1571 | * Publishes a content version. |
||
| 1572 | * |
||
| 1573 | * Publishes a content version and deletes archive versions if they overflow max archive versions. |
||
| 1574 | * Max archive versions are currently a configuration, but might be moved to be a param of ContentType in the future. |
||
| 1575 | * |
||
| 1576 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft |
||
| 1577 | * |
||
| 1578 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
| 1579 | * @param int|null $publicationDate If null existing date is kept if there is one, otherwise current time is used. |
||
| 1580 | * |
||
| 1581 | * @return \eZ\Publish\API\Repository\Values\Content\Content |
||
| 1582 | */ |
||
| 1583 | protected function internalPublishVersion(APIVersionInfo $versionInfo, $publicationDate = null) |
||
| 1633 | |||
| 1634 | /** |
||
| 1635 | * @return int |
||
| 1636 | */ |
||
| 1637 | protected function getUnixTimestamp() |
||
| 1641 | |||
| 1642 | /** |
||
| 1643 | * Removes the given version. |
||
| 1644 | * |
||
| 1645 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is in |
||
| 1646 | * published state or is a last version of Content in non draft state |
||
| 1647 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to remove this version |
||
| 1648 | * |
||
| 1649 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
| 1650 | */ |
||
| 1651 | public function deleteVersion(APIVersionInfo $versionInfo) |
||
| 1693 | |||
| 1694 | /** |
||
| 1695 | * Loads all versions for the given content. |
||
| 1696 | * |
||
| 1697 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to list versions |
||
| 1698 | * |
||
| 1699 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
| 1700 | * |
||
| 1701 | * @return \eZ\Publish\API\Repository\Values\Content\VersionInfo[] Sorted by creation date |
||
| 1702 | */ |
||
| 1703 | public function loadVersions(ContentInfo $contentInfo) |
||
| 1723 | |||
| 1724 | /** |
||
| 1725 | * Copies the content to a new location. If no version is given, |
||
| 1726 | * all versions are copied, otherwise only the given version. |
||
| 1727 | * |
||
| 1728 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to copy the content to the given location |
||
| 1729 | * |
||
| 1730 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
| 1731 | * @param \eZ\Publish\API\Repository\Values\Content\LocationCreateStruct $destinationLocationCreateStruct the target location where the content is copied to |
||
| 1732 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
| 1733 | * |
||
| 1734 | * @return \eZ\Publish\API\Repository\Values\Content\Content |
||
| 1735 | */ |
||
| 1736 | public function copyContent(ContentInfo $contentInfo, LocationCreateStruct $destinationLocationCreateStruct, APIVersionInfo $versionInfo = null) |
||
| 1788 | |||
| 1789 | /** |
||
| 1790 | * Loads all outgoing relations for the given version. |
||
| 1791 | * |
||
| 1792 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read this version |
||
| 1793 | * |
||
| 1794 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo |
||
| 1795 | * |
||
| 1796 | * @return \eZ\Publish\API\Repository\Values\Content\Relation[] |
||
| 1797 | */ |
||
| 1798 | public function loadRelations(APIVersionInfo $versionInfo) |
||
| 1833 | |||
| 1834 | /** |
||
| 1835 | * Loads all incoming relations for a content object. |
||
| 1836 | * |
||
| 1837 | * The relations come only from published versions of the source content objects |
||
| 1838 | * |
||
| 1839 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to read this version |
||
| 1840 | * |
||
| 1841 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
| 1842 | * |
||
| 1843 | * @return \eZ\Publish\API\Repository\Values\Content\Relation[] |
||
| 1844 | */ |
||
| 1845 | public function loadReverseRelations(ContentInfo $contentInfo) |
||
| 1871 | |||
| 1872 | /** |
||
| 1873 | * Adds a relation of type common. |
||
| 1874 | * |
||
| 1875 | * The source of the relation is the content and version |
||
| 1876 | * referenced by $versionInfo. |
||
| 1877 | * |
||
| 1878 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed to edit this version |
||
| 1879 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft |
||
| 1880 | * |
||
| 1881 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $sourceVersion |
||
| 1882 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $destinationContent the destination of the relation |
||
| 1883 | * |
||
| 1884 | * @return \eZ\Publish\API\Repository\Values\Content\Relation the newly created relation |
||
| 1885 | */ |
||
| 1886 | public function addRelation(APIVersionInfo $sourceVersion, ContentInfo $destinationContent) |
||
| 1927 | |||
| 1928 | /** |
||
| 1929 | * Removes a relation of type COMMON from a draft. |
||
| 1930 | * |
||
| 1931 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed edit this version |
||
| 1932 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the version is not a draft |
||
| 1933 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if there is no relation of type COMMON for the given destination |
||
| 1934 | * |
||
| 1935 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $sourceVersion |
||
| 1936 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $destinationContent |
||
| 1937 | */ |
||
| 1938 | public function deleteRelation(APIVersionInfo $sourceVersion, ContentInfo $destinationContent) |
||
| 1988 | |||
| 1989 | /** |
||
| 1990 | * {@inheritdoc} |
||
| 1991 | */ |
||
| 1992 | public function removeTranslation(ContentInfo $contentInfo, $languageCode) |
||
| 2000 | |||
| 2001 | /** |
||
| 2002 | * Delete Content item Translation from all Versions (including archived ones) of a Content Object. |
||
| 2003 | * |
||
| 2004 | * NOTE: this operation is risky and permanent, so user interface should provide a warning before performing it. |
||
| 2005 | * |
||
| 2006 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the specified Translation |
||
| 2007 | * is the Main Translation of a Content Item. |
||
| 2008 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed |
||
| 2009 | * to delete the content (in one of the locations of the given Content Item). |
||
| 2010 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if languageCode argument |
||
| 2011 | * is invalid for the given content. |
||
| 2012 | * |
||
| 2013 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
| 2014 | * @param string $languageCode |
||
| 2015 | * |
||
| 2016 | * @since 6.13 |
||
| 2017 | */ |
||
| 2018 | public function deleteTranslation(ContentInfo $contentInfo, $languageCode) |
||
| 2095 | |||
| 2096 | /** |
||
| 2097 | * Delete specified Translation from a Content Draft. |
||
| 2098 | * |
||
| 2099 | * @throws \eZ\Publish\API\Repository\Exceptions\BadStateException if the specified Translation |
||
| 2100 | * is the only one the Content Draft has or it is the main Translation of a Content Object. |
||
| 2101 | * @throws \eZ\Publish\API\Repository\Exceptions\UnauthorizedException if the user is not allowed |
||
| 2102 | * to edit the Content (in one of the locations of the given Content Object). |
||
| 2103 | * @throws \eZ\Publish\API\Repository\Exceptions\InvalidArgumentException if languageCode argument |
||
| 2104 | * is invalid for the given Draft. |
||
| 2105 | * @throws \eZ\Publish\API\Repository\Exceptions\NotFoundException if specified Version was not found |
||
| 2106 | * |
||
| 2107 | * @param \eZ\Publish\API\Repository\Values\Content\VersionInfo $versionInfo Content Version Draft |
||
| 2108 | * @param string $languageCode Language code of the Translation to be removed |
||
| 2109 | * |
||
| 2110 | * @return \eZ\Publish\API\Repository\Values\Content\Content Content Draft w/o the specified Translation |
||
| 2111 | * |
||
| 2112 | * @since 6.12 |
||
| 2113 | */ |
||
| 2114 | public function deleteTranslationFromDraft(APIVersionInfo $versionInfo, $languageCode) |
||
| 2180 | |||
| 2181 | /** |
||
| 2182 | * Hides Content by making all the Locations appear hidden. |
||
| 2183 | * It does not persist hidden state on Location object itself. |
||
| 2184 | * |
||
| 2185 | * Content hidden by this API can be revealed by revealContent API. |
||
| 2186 | * |
||
| 2187 | * @see revealContent |
||
| 2188 | * |
||
| 2189 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
| 2190 | */ |
||
| 2191 | View Code Duplication | public function hideContent(ContentInfo $contentInfo): void |
|
| 2216 | |||
| 2217 | /** |
||
| 2218 | * Reveals Content hidden by hideContent API. |
||
| 2219 | * Locations which were hidden before hiding Content will remain hidden. |
||
| 2220 | * |
||
| 2221 | * @see hideContent |
||
| 2222 | * |
||
| 2223 | * @param \eZ\Publish\API\Repository\Values\Content\ContentInfo $contentInfo |
||
| 2224 | */ |
||
| 2225 | View Code Duplication | public function revealContent(ContentInfo $contentInfo): void |
|
| 2250 | |||
| 2251 | /** |
||
| 2252 | * Instantiates a new content create struct object. |
||
| 2253 | * |
||
| 2254 | * alwaysAvailable is set to the ContentType's defaultAlwaysAvailable |
||
| 2255 | * |
||
| 2256 | * @param \eZ\Publish\API\Repository\Values\ContentType\ContentType $contentType |
||
| 2257 | * @param string $mainLanguageCode |
||
| 2258 | * |
||
| 2259 | * @return \eZ\Publish\API\Repository\Values\Content\ContentCreateStruct |
||
| 2260 | */ |
||
| 2261 | public function newContentCreateStruct(ContentType $contentType, $mainLanguageCode) |
||
| 2271 | |||
| 2272 | /** |
||
| 2273 | * Instantiates a new content meta data update struct. |
||
| 2274 | * |
||
| 2275 | * @return \eZ\Publish\API\Repository\Values\Content\ContentMetadataUpdateStruct |
||
| 2276 | */ |
||
| 2277 | public function newContentMetadataUpdateStruct() |
||
| 2281 | |||
| 2282 | /** |
||
| 2283 | * Instantiates a new content update struct. |
||
| 2284 | * |
||
| 2285 | * @return \eZ\Publish\API\Repository\Values\Content\ContentUpdateStruct |
||
| 2286 | */ |
||
| 2287 | public function newContentUpdateStruct() |
||
| 2291 | } |
||
| 2292 |
Loading history...
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
$irelandis not defined by the methodfinale(...).The most likely cause is that the parameter was changed, but the annotation was not.