ContentService.php
:
- 484
+ 427
-
Adds a relation of type common.
+Adds a common relation.
| - | -- - + |
+ The source content's version in relation with the destination. + + |
|
the destination of the relation +The destination of the relation. ParametersReturn valuesthe newly created relation +The newly created relation.
Tags
@@ -36611,7 +36615,7 @@ if the user is not allowed to edit this version +if the user is not allowed to edit this version.
if the version is not a draft +if the version is not a draft.
|
-
|
the target location where the content is copied to +The target location where the content is copied to. Parameters$versionInfo |
- VersionInfo + VersionInfo|null |
null
@@ -36737,7 +36748,7 @@
if the user is not allowed to copy the content to the given location +if the user is not allowed to copy the content to the given location.
|
-
|
@@ -39469,7 +39495,7 @@
Count total number of items returned by {@see ContentService::find()} method.
+Gets the total number of fetchable Content items.
| @@ -36777,6 +36788,10 @@ |
| - array<string|int, string> + array<int, string> | null |
a list of language codes to be added as additional constraints. + A list of language codes to be added as additional constraints. If skipped, by default, unless SiteAccessAware layer has been disabled, languages set for a SiteAccess in a current context will be used. @@ -36835,7 +36850,7 @@
|
The user to load drafts for, if defined, otherwise drafts for current-user +The user to load drafts for, if defined, otherwise drafts for current user. ParametersReturn valuesint The number of drafts (VersionInfo) owned by the given user +The number of drafts (VersionInfo) owned by the given user.
|
an array of LocationCreateStruct for each location parent under which a location should be created for the content + An array of LocationCreateStruct for each location parent under which a location should be created for the content. While optional, it's highly recommended to use Locations for content as a lot of features in the system is usually tied to the tree structure (including default Role policies). ParametersReturn values
The newly created content draft.
if the user is not allowed to create the content in the given location +if the user is not allowed to create the content in the given location.
if a field in the $contentCreateStruct is not valid +if a field in the $contentCreateStruct is not valid.
if a required field is missing or is set to an empty value +if a required field is missing or is set to an empty value.
|
Used as creator of the draft if given - otherwise uses current-user +Used as creator of the draft if given; otherwise uses current user. Parameters | null | -- - + |
+ If not set the draft is created with the initialLanguage code of the source version or if not present with the main language. + + |
@@ -37357,9 +37374,7 @@
-
|
@@ -37444,9 +37459,9 @@
array<string|int, int>
+array<int, int>
Affected Location Id's (List of Locations of the Content that was deleted)
+Affected Location IDs (List of Location IDs of the Content that was deleted).
if the user is not allowed to delete the content (in one of the locations of the given content object)
+if the user is not allowed to delete the content (in one of the locations of the given content object).
Removes a relation of type COMMON from a draft.
+Removes a common relation from a draft.
if the user is not allowed edit this version
+if the user is not allowed edit this version.
if the version is not a draft
+if the version is not a draft.
if there is no relation of type COMMON for the given destination
+if there is no relation of type Relation::COMMON for the given destination.
if languageCode argument +
if $languageCode argument is invalid for the given content.
When using together with ContentService::publishVersion() method, make sure to not provide deleted translation +
When using together with ContentService::publishVersion() method, make sure to not provide deleted translation in translations array, as it is going to be copied again from published version.
Content Version Draft
+Content Version Draft.
Language code of the Translation to be removed
+Language code of the Translation to be removed.
Content Draft w/o the specified Translation
+Content Draft without the specified Translation.
if specified Version was not found
+if specified Version was not found.
if the version is in -published state or is a last version of Content in non draft state
+published state or is a last version of Content in non-draft state.if the user is not allowed to remove this version
+if the user is not allowed to remove this version.
Fetch Content items from the Repository filtered by the given conditions.
+Fetches Content items from the Repository filtered by the given conditions.
|
-
|
@@ -38014,14 +38036,14 @@ - array<string|int, string> + array<int, string> | null |
a list of language codes to be added as additional constraints. + A list of language codes to be added as additional constraints. If skipped, by default, unless SiteAccessAware layer has been disabled, languages set for a SiteAccess in a current context will be used. @@ -38042,7 +38064,7 @@
|
-
|
@@ -38169,7 +38191,7 @@ - mixed + int |
-
@@ -38183,7 +38205,7 @@ Parameters$languages |
- array<string|int, string> + array<int, string> |
null
@@ -38209,7 +38231,7 @@ Parameters |
the version number. If not given the current version is returned +The version number. If not given the current version is returned. Parameters |
Add Main language to $languages if true (default) and if alwaysAvailable is true +Add Main language to $languages if true (default) and if ContentInfo::$alwaysAvailable is true.
if the content or version with the given id and languages does not exist +if the content or version with the given id and languages doesn't exist.
If the user has no access to read content and in case of un-published content: read versions +if the user lacks: +
|
-
|
@@ -38335,7 +38363,7 @@ - array<string|int, mixed> + array<int, string> |
null
@@ -38361,7 +38389,7 @@ Parameters |
the version number. If not given the current version is returned from $contentInfo +The version number. If not given the current version is returned from $contentInfo. Parameters |
Add Main language to $languages if true (default) and if alwaysAvailable is true +Add Main language to $languages if true (default) and if ContentInfo::$alwaysAvailable is true.
if version with the given number doesn't exist.
if the user is not allowed to load this version +if the user is not allowed to load this version.
|
Add Main language to $languages if true (default) and if alwaysAvailable is true +Add Main language to $languages if true (default) and if ContentInfo::$alwaysAvailable is true.
if the content or version with the given remote id doesn't exist.
If the user has no access to read content and in case of un-published content: read versions +if the user lacks: +
|
Add Main language to $languages if true (default) and if alwaysAvailable is true +Add Main language to $languages if true (default) and if ContentInfo::$alwaysAvailable is true.
if the user is not allowed to load this version +if the user is not allowed to load this version.
|
The user to load drafts for, if defined, otherwise drafts for current-user +The user to load drafts for, if defined; otherwise drafts for current user.
|
-
|
@@ -38829,7 +38859,7 @@ - User + User|null | null |
The user to load drafts for, if defined, otherwise drafts for current-user +The user to load drafts for. If ParametersReturn valuesarray<string|int, VersionInfo> the drafts (VersionInfo) owned by the given user +The drafts owned by the given user.
if the current-user is not allowed to load the draft list +if the current user is not allowed to load the draft list
|
-
|
@@ -39132,7 +39158,7 @@ - array<string|int, int> + array<int, int> |
-
@@ -39163,9 +39189,9 @@ Parameters |
If no user is given the drafts for the authenticated user are returned
+If no user is given the drafts for the authenticated user are returned.
if the user is not allowed to read the content
+if the user is not allowed to read the content.
if the content with the given id doesn't exist.
if the user is not allowed to read the content
+if the user is not allowed to read the content.
if the content with the given remote id doesn't exist.
array<string|int, ContentInfo>
+array<int, ContentInfo>
list of ContentInfo with Content Ids as keys
+List of ContentInfo with content ids as keys
public loadContentListByContentInfo(array<string|int, ContentInfo> $contentInfoList[, array<string|int, string> $languages = [] ][, bool $useAlwaysAvailable = true ]) : array<string|int, Content>public loadContentListByContentInfo(array<int, ContentInfo> $contentInfoList[, array<int, string> $languages = [] ][, bool $useAlwaysAvailable = true ]) : array<int, Content>Note: it does not throw exceptions on load, just ignores erroneous Content item. +
Note: it doesn't throw exceptions on load, just ignores erroneous Content item. Moreover, since the method works on pre-loaded ContentInfo list, it is assumed that user is allowed to access every Content on the list.
@@ -39226,7 +39252,7 @@Add Main language to $languages if true (default) and if alwaysAvailable is true, +
Add Main language to $languages if true (default) and if ContentInfo::$alwaysAvailable is true, unless all languages have been asked for.
array<string|int, Content>
+array<int, Content>
list of Content items with Content Ids as keys
+List of Content items with Content Ids as keys
array<string|int, Relation>
+array<int, Relation>
if the user is not allowed to read this version
+if the user is not allowed to read this version.
The "ContentService::loadRelations()" method is deprecated, will be removed in 5.0.
+It will be removed in 5.0. Use ContentService::loadRelationList() instead.
The relations come only from published versions of the source content objects. -If the user is not allowed to read specific version then UnauthorizedRelationListItem is returned -UnauthorizedRelationListItem
+If the user is not allowed to read specific version then UnauthorizedRelationListItem is returned
public loadReverseRelations(ContentInfo $contentInfo) : array<string|int, Relation>public loadReverseRelations(ContentInfo $contentInfo) : array<int, Relation>array<string|int, Relation>
+array<int, Relation>
if the user is not allowed to read this version
+if the user is not allowed to read this version.
If no version number is given, the method returns the current version
+If no version number is given, the method returns the current version.
if the version with the given number doesn't exist.
if the user is not allowed to load this version
+if the user is not allowed to load this version.
If no version number is given, the method returns the current version
+If no version number is given, the method returns the current version.
if the version with the given number doesn't exist.
if the user is not allowed to load this version
+if the user is not allowed to load this version.
public loadVersionInfoListByContentInfo(array<string|int, ContentInfo> $contentInfoList) : array<int, VersionInfo>public loadVersionInfoListByContentInfo(array<int, ContentInfo> $contentInfoList) : array<int, VersionInfo>public loadVersions(ContentInfo $contentInfo[, int|null $status = null ]) : array<string|int, VersionInfo>public loadVersions(ContentInfo $contentInfo[, int|null $status = null ]) : array<int, VersionInfo>array<string|int, VersionInfo>
+array<int, VersionInfo>
an array of VersionInfo sorted by creation date
+An array of VersionInfo sorted by creation date.
if the user is not allowed to list versions
+if the user is not allowed to list versions.
if the given status is invalid
+if the given status is invalid.
alwaysAvailable is set to the ContentType's defaultAlwaysAvailable
+ContentCreateStruct::$alwaysAvailable is set to the ContentType::$defaultAlwaysAvailable.
public publishVersion(VersionInfo $versionInfo[, array<string|int, string> $translations = Language::ALL ]) : Contentpublic publishVersion(VersionInfo $versionInfo[, array<int, string> $translations = Language::ALL ]) : ContentList of language codes of translations which will be included in a published version. -By default all translations from the current version will be published. -If the list is provided but does not cover all currently published translations, +By default, all translations from the current version will be published. +If the list is provided but doesn't cover all currently published translations, the missing ones will be copied from the currently published version, overriding those in the current version.
@@ -40387,7 +40408,7 @@if the user is not allowed to publish this version
+if the user is not allowed to publish this version.
if the version is not a draft
+if the version is not a draft.
public updateContent(VersionInfo $versionInfo, ContentUpdateStruct $contentUpdateStruct[, array<string|int, string>|null $fieldIdentifiersToValidate = null ]) : Contentpublic updateContent(VersionInfo $versionInfo, ContentUpdateStruct $contentUpdateStruct[, array<int, string>|null $fieldIdentifiersToValidate = null ]) : Contentthe content draft with the updated fields
+The content draft with the updated fields.
if the user is not allowed to update this version
+if the user is not allowed to update this version.
if the version is not a draft
+if the version is not a draft.
if a field in the $contentUpdateStruct is not valid
+if a field in the $contentUpdateStruct is not valid.
if a required field is set to an empty value
+if a required field is set to an empty value.
if a field value is not accepted by the field type
+if a field value is not accepted by the field type.
See ContentMetadataUpdateStruct of a content object - to update fields use updateContent
+To update fields, use ContentService::updateContent().
the content with the updated attributes
+The content with the updated attributes.
if the user is not allowed to update the content meta data
+if the user is not allowed to update the content metadata.
if the remoteId in $contentMetadataUpdateStruct is set but already exists
+if the remoteId in $contentMetadataUpdateStruct is set but already exists.
public validate(ValueObject $object, array<string|int, mixed> $context[, array<string|int, string>|null $fieldIdentifiersToValidate = null ]) : array<string|int, mixed>public validate(ValueObject $object, array<string|int, mixed> $context[, array<int, string>|null $fieldIdentifiersToValidate = null ]) : array<string|int, mixed>List of field identifiers for partial validation or null +
List of field identifiers for partial validation, or null for case of full validation. Empty identifiers array is equal to no validation.
- Adds a relation of type common.
+Adds a common relation.
| - | -- - + |
+ The source content's version in relation with the destination. + + |
|||||||||||||||||||||||
|
the destination of the relation +The destination of the relation. ParametersReturn valuesthe newly created relation +The newly created relation. Parameters |
the target location where the content is copied to +The target location where the content is copied to.
|
|
a list of language codes to be added as additional constraints. + A list of language codes to be added as additional constraints. If skipped, by default, unless SiteAccessAware layer has been disabled, languages set for a SiteAccess in a current context will be used. @@ -36890,7 +36898,7 @@
|
The user to load drafts for, if defined, otherwise drafts for current-user +The user to load drafts for, if defined, otherwise drafts for current user. ParametersReturn valuesint The number of drafts (VersionInfo) owned by the given user +The number of drafts (VersionInfo) owned by the given user. ParametersReturn valuesint The number of reverse relations (Relation) +The number of reverse relations (Relation).
If a different userId is given in $contentCreateStruct it is assigned to the given user but this required special rights for the authenticated user -(this is useful for content staging where the transfer process does not +(this is useful for content staging where the transfer process doesn't have to authenticate with the user which created the content object in the source server). The user has to publish the draft if it should be visible. @@ -37144,7 +37152,7 @@Parameters |
an array of LocationCreateStruct for each location parent under which a location should be created for the content + An array of LocationCreateStruct for each location parent under which a location should be created for the content. While optional, it's highly recommended to use Locations for content as a lot of features in the system is usually tied to the tree structure (including default Role policies). ParametersReturn values
The newly created content draft. Parameters |
Used as creator of the draft if given - otherwise uses current-user +Used as creator of the draft if given; otherwise uses current user. Parameters | null | -- - + |
+ If not set the draft is created with the initialLanguage code of the source version or if not present with the main language. + + |
@@ -37298,9 +37308,7 @@
-
|
@@ -37367,9 +37375,9 @@
If no user is given the number of drafts for the authenticated user are returned
+If no user is given the number of drafts for the authenticated user are returned.
array<string|int, int>
+array<int, int>
Affected Location Id's (List of Locations of the Content that was deleted)
+Affected Location IDs (List of Location IDs of the Content that was deleted).
- Removes a relation of type COMMON from a draft.
+Removes a common relation from a draft.
|
Content Version Draft +Content Version Draft. Parameters |
Language code of the Translation to be removed +Language code of the Translation to be removed. ParametersReturn valuesContent Draft w/o the specified Translation +Content Draft without the specified Translation.
|
|
a list of language codes to be added as additional constraints. + A list of language codes to be added as additional constraints. If skipped, by default, unless SiteAccessAware layer has been disabled, languages set for a SiteAccess in a current context will be used. @@ -37807,8 +37815,8 @@
|
the version number. If not given the current version is returned +The version number. If not given the current version is returned. Parameters |
Add Main language to $languages if true (default) and if alwaysAvailable is true +Add Main language to $languages if true (default) and if ContentInfo::$alwaysAvailable is true. Parameters |
the version number. If not given the current version is returned from $contentInfo +The version number. If not given the current version is returned from $contentInfo. Parameters |
Add Main language to $languages if true (default) and if alwaysAvailable is true +Add Main language to $languages if true (default) and if ContentInfo::$alwaysAvailable is true. Parameters |
Add Main language to $languages if true (default) and if alwaysAvailable is true +Add Main language to $languages if true (default) and if ContentInfo::$alwaysAvailable is true. Parameters |
Add Main language to $languages if true (default) and if alwaysAvailable is true +Add Main language to $languages if true (default) and if ContentInfo::$alwaysAvailable is true.
|
The user to load drafts for, if defined, otherwise drafts for current-user +The user to load drafts for, if defined; otherwise drafts for current user.
|
The user to load drafts for, if defined, otherwise drafts for current-user +The user to load drafts for. If ParametersReturn valuesarray<string|int, VersionInfo> the drafts (VersionInfo) owned by the given user +The drafts owned by the given user. |
-
|
@@ -38657,7 +38665,7 @@
It does not persist hidden state on Location object itself.
-Content hidden by this API can be revealed by revealContent API.
+It doesn't persist hidden state on Location object itself.
+Content hidden by this API can be revealed by ContentService::revealContent() API.
If no user is given the drafts for the authenticated user are returned
+If no user is given the drafts for the authenticated user are returned.
If no user is given the drafts for the authenticated user are returned
+If no user is given the drafts for the authenticated user are returned.
array<string|int, ContentInfo>
+array<int, ContentInfo>
list of ContentInfo with Content Ids as keys
+List of ContentInfo with content ids as keys
public loadContentListByContentInfo(array<string|int, mixed> $contentInfoList[, array<string|int, mixed> $languages = [] ][, bool $useAlwaysAvailable = true ]) : array<string|int, Content>public loadContentListByContentInfo(array<string|int, mixed> $contentInfoList[, array<string|int, mixed> $languages = [] ][, bool $useAlwaysAvailable = true ]) : array<int, Content>Note: it does not throw exceptions on load, just ignores erroneous Content item. +
Note: it doesn't throw exceptions on load, just ignores erroneous Content item. Moreover, since the method works on pre-loaded ContentInfo list, it is assumed that user is allowed to access every Content on the list.
@@ -38791,7 +38799,7 @@Add Main language to $languages if true (default) and if alwaysAvailable is true, +
Add Main language to $languages if true (default) and if ContentInfo::$alwaysAvailable is true, unless all languages have been asked for.
array<string|int, Content>
+array<int, Content>
list of Content items with Content Ids as keys
+List of Content items with Content Ids as keys
public loadRelations(VersionInfo $versionInfo) : array<string|int, Relation>public loadRelations(VersionInfo $versionInfo) : array<int, Relation>array<string|int, Relation>
+array<int, Relation>
The relations come only from published versions of the source content objects. -If the user is not allowed to read specific version then UnauthorizedRelationListItem is returned -UnauthorizedRelationListItem
+If the user is not allowed to read specific version then UnauthorizedRelationListItem is returnedpublic loadReverseRelations(ContentInfo $contentInfo) : array<string|int, Relation>public loadReverseRelations(ContentInfo $contentInfo) : array<int, Relation>array<string|int, Relation>
+array<int, Relation>
If no version number is given, the method returns the current version
+If no version number is given, the method returns the current version.
If no version number is given, the method returns the current version
+If no version number is given, the method returns the current version.
public loadVersions(ContentInfo $contentInfo[, int|null $status = null ]) : array<string|int, VersionInfo>public loadVersions(ContentInfo $contentInfo[, int|null $status = null ]) : array<int, VersionInfo>array<string|int, VersionInfo>
+array<int, VersionInfo>
an array of VersionInfo sorted by creation date
+An array of VersionInfo sorted by creation date.
alwaysAvailable is set to the ContentType's defaultAlwaysAvailable
+ContentCreateStruct::$alwaysAvailable is set to the ContentType::$defaultAlwaysAvailable.
List of language codes of translations which will be included in a published version. -By default all translations from the current version will be published. -If the list is provided but does not cover all currently published translations, +By default, all translations from the current version will be published. +If the list is provided but doesn't cover all currently published translations, the missing ones will be copied from the currently published version, overriding those in the current version.
@@ -39869,7 +39876,7 @@the content draft with the updated fields
+The content draft with the updated fields.
See ContentMetadataUpdateStruct of a content object - to update fields use updateContent
+To update fields, use ContentService::updateContent().
the content with the updated attributes
+The content with the updated attributes.
List of field identifiers for partial validation or null +
List of field identifiers for partial validation, or null for case of full validation. Empty identifiers array is equal to no validation.
Please use ContentService::loadContentDraftList() instead to avoid risking loading too much data.
The "ContentService::loadRelations()" method is deprecated, will be removed in 5.0.
+It will be removed in 5.0. Use ContentService::loadRelationList() instead.