ContentTypeServiceDecorator

ContentTypeServiceDecorator.php : 26 Copy path

Abstract

Implements ContentTypeService

Properties¶

$innerService ¶

ContentTypeServiceDecorator.php : 28 Copy path

protected ContentTypeService $innerService

Methods¶

__construct() ¶

ContentTypeServiceDecorator.php : 30 Copy path

public __construct(ContentTypeService $innerService)

Parameters

Name	Type	Default value	Description
$innerService	ContentTypeService	-	-

addFieldDefinition() ¶

ContentTypeServiceDecorator.php : 161 Copy path

Adds a new field definition to an existing content type.

public addFieldDefinition(ContentTypeDraft $contentTypeDraft, FieldDefinitionCreateStruct $fieldDefinitionCreateStruct) : void

The content type must be in state DRAFT.

Parameters

Name	Type	Default value	Description
$contentTypeDraft	ContentTypeDraft	-	-
$fieldDefinitionCreateStruct	FieldDefinitionCreateStruct	-	-

assignContentTypeGroup() ¶

ContentTypeServiceDecorator.php : 147 Copy path

Assigns a content type to a content type group.

public assignContentTypeGroup(ContentType $contentType, ContentTypeGroup $contentTypeGroup) : void

Parameters

Name	Type	Default value	Description
$contentType	ContentType	-	-
$contentTypeGroup	ContentTypeGroup	-	-

copyContentType() ¶

ContentTypeServiceDecorator.php : 140 Copy path

Copy Type incl fields and groupIds to a new Type object.

public copyContentType(ContentType $contentType[, User|null $creator = null ]) : ContentType

New Type will have $creator as creator / modifier, created / modified should be updated with current time, updated remoteId and identifier should be appended with '_' + unique string.

Parameters

Name	Type	Default value	Description
$contentType	ContentType	-	-
$creator	User\|null	null	If null the current-user is used instead

Return values

ContentType

createContentType() ¶

ContentTypeServiceDecorator.php : 71 Copy path

Create a content type object.

public createContentType(ContentTypeCreateStruct $contentTypeCreateStruct, array<string|int, mixed> $contentTypeGroups) : ContentTypeDraft

The content type is created in the state STATUS_DRAFT.

Parameters

Name	Type	Default value	Description
$contentTypeCreateStruct	ContentTypeCreateStruct	-	-
$contentTypeGroups	array<string\|int, mixed>	-	Required array of ContentTypeGroup to link type with (must contain one)

Return values

ContentTypeDraft

createContentTypeDraft() ¶

ContentTypeServiceDecorator.php : 123 Copy path

Creates a draft from an existing content type.

public createContentTypeDraft(ContentType $contentType) : ContentTypeDraft

This is a complete copy of the content type which has the state STATUS_DRAFT.

Parameters

Name	Type	Default value	Description
$contentType	ContentType	-	-

Return values

ContentTypeDraft

createContentTypeGroup() ¶

ContentTypeServiceDecorator.php : 35 Copy path

Create a content type group object.

public createContentTypeGroup(ContentTypeGroupCreateStruct $contentTypeGroupCreateStruct) : ContentTypeGroup

Parameters

Name	Type	Default value	Description
$contentTypeGroupCreateStruct	ContentTypeGroupCreateStruct	-	-

Return values

ContentTypeGroup

deleteContentType() ¶

ContentTypeServiceDecorator.php : 135 Copy path

Delete a content type object.

public deleteContentType(ContentType $contentType) : void

Deletes a content type if it has no instances. If content type in state STATUS_DRAFT is given, only the draft content type will be deleted. Otherwise, if content type in state STATUS_DEFINED is given, all content type data will be deleted.

Parameters

Name	Type	Default value	Description
$contentType	ContentType	-	-

deleteContentTypeGroup() ¶

ContentTypeServiceDecorator.php : 66 Copy path

Delete a content type group.

public deleteContentTypeGroup(ContentTypeGroup $contentTypeGroup) : void

This method only deletes an content type group which has content types without any content instances

Parameters

Name	Type	Default value	Description
$contentTypeGroup	ContentTypeGroup	-	-

deleteUserDrafts() ¶

ContentTypeServiceDecorator.php : 232 Copy path

Delete all content type drafs created or modified by the user.

public deleteUserDrafts(int $userId) : void

Parameters

Name	Type	Default value	Description
$userId	int	-	-

findContentTypes() ¶

ContentTypeServiceDecorator.php : 111 Copy path

public findContentTypes([ContentTypeQuery|null $query = null ][, array<string|int, mixed> $prioritizedLanguages = [] ]) : SearchResult

Parameters

Name	Type	Default value	Description
$query	ContentTypeQuery\|null	null	-
$prioritizedLanguages	array<string\|int, mixed>	[]	Used as prioritized language code on translated properties of returned object.

Return values

SearchResult

isContentTypeUsed() ¶

ContentTypeServiceDecorator.php : 220 Copy path

Returns true if the given content type $contentType has content instances.

public isContentTypeUsed(ContentType $contentType) : bool

Parameters

Name	Type	Default value	Description
$contentType	ContentType	-	-

Return values

bool

loadContentType() ¶

ContentTypeServiceDecorator.php : 78 Copy path

Get a content type object by id.

public loadContentType(int $contentTypeId[, array<string|int, mixed> $prioritizedLanguages = [] ]) : ContentType

Parameters

Name	Type	Default value	Description
$contentTypeId	int	-	-
$prioritizedLanguages	array<string\|int, mixed>	[]	Used as prioritized language code on translated properties of returned object.

Return values

ContentType

loadContentTypeByIdentifier() ¶

ContentTypeServiceDecorator.php : 85 Copy path

Get a content type object by identifier.

public loadContentTypeByIdentifier(string $identifier[, array<string|int, mixed> $prioritizedLanguages = [] ]) : ContentType

Parameters

Name	Type	Default value	Description
$identifier	string	-	-
$prioritizedLanguages	array<string\|int, mixed>	[]	Used as prioritized language code on translated properties of returned object.

Return values

ContentType

loadContentTypeByRemoteId() ¶

ContentTypeServiceDecorator.php : 92 Copy path

Get a content type object by id.

public loadContentTypeByRemoteId(string $remoteId[, array<string|int, mixed> $prioritizedLanguages = [] ]) : ContentType

Parameters

Name	Type	Default value	Description
$remoteId	string	-	-
$prioritizedLanguages	array<string\|int, mixed>	[]	Used as prioritized language code on translated properties of returned object.

Return values

ContentType

loadContentTypeDraft() ¶

ContentTypeServiceDecorator.php : 99 Copy path

Get a content type object draft by id.

public loadContentTypeDraft(int $contentTypeId[, bool $ignoreOwnership = false ]) : ContentTypeDraft

Parameters

Name	Type	Default value	Description
$contentTypeId	int	-	-
$ignoreOwnership	bool	false	if true, method will return draft even if the owner is different than currently logged in user

Return values

ContentTypeDraft

loadContentTypeGroup() ¶

ContentTypeServiceDecorator.php : 40 Copy path

Get a content type group object by id.

public loadContentTypeGroup(int $contentTypeGroupId[, array<string|int, mixed> $prioritizedLanguages = [] ]) : ContentTypeGroup

Parameters

Name	Type	Default value	Description
$contentTypeGroupId	int	-	-
$prioritizedLanguages	array<string\|int, mixed>	[]	Used as prioritized language code on translated properties of returned object.

Return values

ContentTypeGroup

loadContentTypeGroupByIdentifier() ¶

ContentTypeServiceDecorator.php : 47 Copy path

Get a content type group object by identifier.

public loadContentTypeGroupByIdentifier(string $contentTypeGroupIdentifier[, array<string|int, mixed> $prioritizedLanguages = [] ]) : ContentTypeGroup

Parameters

Name	Type	Default value	Description
$contentTypeGroupIdentifier	string	-	-
$prioritizedLanguages	array<string\|int, mixed>	[]	Used as prioritized language code on translated properties of returned object.

Return values

ContentTypeGroup

loadContentTypeGroups() ¶

ContentTypeServiceDecorator.php : 54 Copy path

Get all content type groups.

public loadContentTypeGroups([array<string|int, mixed> $prioritizedLanguages = [] ]) : array<string|int, ContentTypeGroup>

Parameters

Name	Type	Default value	Description
$prioritizedLanguages	array<string\|int, mixed>	[]	Used as prioritized language code on translated properties of returned object.

Return values

array<string|int, ContentTypeGroup>

loadContentTypeList() ¶

ContentTypeServiceDecorator.php : 104 Copy path

Bulk-load content type objects by ids.

public loadContentTypeList(array<string|int, mixed> $contentTypeIds[, array<string|int, mixed> $prioritizedLanguages = [] ]) : array<string|int, ContentType>|iterable<string|int, mixed>

Note: it does not throw exceptions on load, just ignores erroneous items.

Parameters

Name	Type	Default value	Description
$contentTypeIds	array<string\|int, mixed>	-	-
$prioritizedLanguages	array<string\|int, mixed>	[]	Used as prioritized language code on translated properties of returned object.

Return values

array<string|int, ContentType>|iterable<string|int, mixed>

loadContentTypes() ¶

ContentTypeServiceDecorator.php : 116 Copy path

Get content type objects which belong to the given content type group.

public loadContentTypes(ContentTypeGroup $contentTypeGroup[, array<string|int, mixed> $prioritizedLanguages = [] ]) : array<string|int, ContentType>

Parameters

Name	Type	Default value	Description
$contentTypeGroup	ContentTypeGroup	-	-
$prioritizedLanguages	array<string\|int, mixed>	[]	Used as prioritized language code on translated properties of returned object.

Return values

array<string|int, ContentType>

an array of ContentType which have status DEFINED

newContentTypeCreateStruct() ¶

ContentTypeServiceDecorator.php : 193 Copy path

Instantiates a new content type create class.

public newContentTypeCreateStruct(string $identifier) : ContentTypeCreateStruct

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

ContentTypeCreateStruct

newContentTypeGroupCreateStruct() ¶

ContentTypeServiceDecorator.php : 188 Copy path

Instantiates a new content type group create class.

public newContentTypeGroupCreateStruct(string $identifier) : ContentTypeGroupCreateStruct

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

ContentTypeGroupCreateStruct

newContentTypeGroupUpdateStruct() ¶

ContentTypeServiceDecorator.php : 203 Copy path

Instantiates a new content type update struct.

public newContentTypeGroupUpdateStruct() : ContentTypeGroupUpdateStruct

Return values

ContentTypeGroupUpdateStruct

newContentTypeUpdateStruct() ¶

ContentTypeServiceDecorator.php : 198 Copy path

Instantiates a new content type update struct.

public newContentTypeUpdateStruct() : ContentTypeUpdateStruct

Return values

ContentTypeUpdateStruct

newFieldDefinitionCreateStruct() ¶

ContentTypeServiceDecorator.php : 208 Copy path

Instantiates a field definition create struct.

public newFieldDefinitionCreateStruct(string $identifier, string $fieldTypeIdentifier) : FieldDefinitionCreateStruct

Parameters

Name	Type	Default value	Description
$identifier	string	-	the required identifier for the field definition
$fieldTypeIdentifier	string	-	the required field type identifier

Return values

FieldDefinitionCreateStruct

newFieldDefinitionUpdateStruct() ¶

ContentTypeServiceDecorator.php : 215 Copy path

Instantiates a field definition update class.

public newFieldDefinitionUpdateStruct() : FieldDefinitionUpdateStruct

Return values

FieldDefinitionUpdateStruct

publishContentTypeDraft() ¶

ContentTypeServiceDecorator.php : 183 Copy path

Publish the content type and update content objects.

public publishContentTypeDraft(ContentTypeDraft $contentTypeDraft) : void

This method updates content objects, depending on the changed field definitions.

Parameters

Name	Type	Default value	Description
$contentTypeDraft	ContentTypeDraft	-	-

removeContentTypeTranslation() ¶

ContentTypeServiceDecorator.php : 225 Copy path

public removeContentTypeTranslation(ContentTypeDraft $contentTypeDraft, string $languageCode) : ContentTypeDraft

Parameters

Name	Type	Default value	Description
$contentTypeDraft	ContentTypeDraft	-	-
$languageCode	string	-	-

Return values

ContentTypeDraft

removeFieldDefinition() ¶

ContentTypeServiceDecorator.php : 168 Copy path

Remove a field definition from an existing Type.

public removeFieldDefinition(ContentTypeDraft $contentTypeDraft, FieldDefinition $fieldDefinition) : void

Parameters

Name	Type	Default value	Description
$contentTypeDraft	ContentTypeDraft	-	-
$fieldDefinition	FieldDefinition	-	-

unassignContentTypeGroup() ¶

ContentTypeServiceDecorator.php : 154 Copy path

Unassign a content type from a group.

public unassignContentTypeGroup(ContentType $contentType, ContentTypeGroup $contentTypeGroup) : void

Parameters

Name	Type	Default value	Description
$contentType	ContentType	-	-
$contentTypeGroup	ContentTypeGroup	-	-

updateContentTypeDraft() ¶

ContentTypeServiceDecorator.php : 128 Copy path

Update a content type object.

public updateContentTypeDraft(ContentTypeDraft $contentTypeDraft, ContentTypeUpdateStruct $contentTypeUpdateStruct) : void

Does not update fields (fieldDefinitions), use ContentTypeService::updateFieldDefinition() to update them.

Parameters

Name	Type	Default value	Description
$contentTypeDraft	ContentTypeDraft	-	-
$contentTypeUpdateStruct	ContentTypeUpdateStruct	-	-

updateContentTypeGroup() ¶

ContentTypeServiceDecorator.php : 59 Copy path

Update a content type group object.

public updateContentTypeGroup(ContentTypeGroup $contentTypeGroup, ContentTypeGroupUpdateStruct $contentTypeGroupUpdateStruct) : void

Parameters

Name	Type	Default value	Description
$contentTypeGroup	ContentTypeGroup	-	the content type group to be updated
$contentTypeGroupUpdateStruct	ContentTypeGroupUpdateStruct	-	-

updateFieldDefinition() ¶

ContentTypeServiceDecorator.php : 175 Copy path

Update a field definition.

public updateFieldDefinition(ContentTypeDraft $contentTypeDraft, FieldDefinition $fieldDefinition, FieldDefinitionUpdateStruct $fieldDefinitionUpdateStruct) : void

Parameters

Name	Type	Default value	Description
$contentTypeDraft	ContentTypeDraft	-	the content type draft
$fieldDefinition	FieldDefinition	-	the field definition which should be updated
$fieldDefinitionUpdateStruct	FieldDefinitionUpdateStruct	-	-