ObjectStateServiceDecorator

ObjectStateServiceDecorator.php : 20 Copy path

Abstract

Implements ObjectStateService

Properties¶

$innerService ¶

ObjectStateServiceDecorator.php : 23 Copy path

protected ObjectStateService $innerService

Methods¶

__construct() ¶

ObjectStateServiceDecorator.php : 25 Copy path

public __construct(ObjectStateService $innerService)

Parameters

Name	Type	Default value	Description
$innerService	ObjectStateService	-	-

createObjectState() ¶

ObjectStateServiceDecorator.php : 76 Copy path

Creates a new object state in the given group.

public createObjectState(ObjectStateGroup $objectStateGroup, ObjectStateCreateStruct $objectStateCreateStruct) : ObjectState

Note: in current kernel: If it is the first state all content objects will set to this state.

Parameters

Name	Type	Default value	Description
$objectStateGroup	ObjectStateGroup	-	-
$objectStateCreateStruct	ObjectStateCreateStruct	-	-

Return values

ObjectState

createObjectStateGroup() ¶

ObjectStateServiceDecorator.php : 30 Copy path

Creates a new object state group.

public createObjectStateGroup(ObjectStateGroupCreateStruct $objectStateGroupCreateStruct) : ObjectStateGroup

Parameters

Name	Type	Default value	Description
$objectStateGroupCreateStruct	ObjectStateGroupCreateStruct	-	-

Return values

ObjectStateGroup

deleteObjectState() ¶

ObjectStateServiceDecorator.php : 116 Copy path

Deletes a object state. The state of the content objects is reset to the first object state in the group.

public deleteObjectState(ObjectState $objectState) : void

Parameters

Name	Type	Default value	Description
$objectState	ObjectState	-	-

deleteObjectStateGroup() ¶

ObjectStateServiceDecorator.php : 71 Copy path

Deletes a object state group including all states and links to content.

public deleteObjectStateGroup(ObjectStateGroup $objectStateGroup) : void

Parameters

Name	Type	Default value	Description
$objectStateGroup	ObjectStateGroup	-	-

getContentCount() ¶

ObjectStateServiceDecorator.php : 136 Copy path

Returns the number of objects which are in this state.

public getContentCount(ObjectState $objectState) : int

Parameters

Name	Type	Default value	Description
$objectState	ObjectState	-	-

Return values

int

getContentState() ¶

ObjectStateServiceDecorator.php : 129 Copy path

Gets the object-state of object identified by $contentId.

public getContentState(ContentInfo $contentInfo, ObjectStateGroup $objectStateGroup) : ObjectState

The $state is the id of the state within one group.

Parameters

Name	Type	Default value	Description
$contentInfo	ContentInfo	-	-
$objectStateGroup	ObjectStateGroup	-	-

Return values

ObjectState

loadObjectState() ¶

ObjectStateServiceDecorator.php : 83 Copy path

Loads an object state.

public loadObjectState(int $stateId[, array<string|int, mixed> $prioritizedLanguages = [] ]) : ObjectState

Parameters

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

Return values

ObjectState

loadObjectStateByIdentifier() ¶

ObjectStateServiceDecorator.php : 90 Copy path

Loads an object state by identifier and group it belongs to.

public loadObjectStateByIdentifier(ObjectStateGroup $objectStateGroup, string $objectStateIdentifier[, array<string|int, mixed> $prioritizedLanguages = [] ]) : ObjectState

Parameters

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

Return values

ObjectState

loadObjectStateGroup() ¶

ObjectStateServiceDecorator.php : 35 Copy path

Loads a object state group.

public loadObjectStateGroup(int $objectStateGroupId[, array<string|int, mixed> $prioritizedLanguages = [] ]) : ObjectStateGroup

Parameters

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

Return values

ObjectStateGroup

loadObjectStateGroupByIdentifier() ¶

ObjectStateServiceDecorator.php : 42 Copy path

Loads a object state group by identifier.

public loadObjectStateGroupByIdentifier(string $objectStateGroupIdentifier[, array<string|int, mixed> $prioritizedLanguages = [] ]) : ObjectStateGroup

Parameters

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

Return values

ObjectStateGroup

loadObjectStateGroups() ¶

ObjectStateServiceDecorator.php : 49 Copy path

Loads all object state groups.

public loadObjectStateGroups([int $offset = 0 ][, int $limit = -1 ][, array<string|int, mixed> $prioritizedLanguages = [] ]) : array<string|int, ObjectStateGroup>

Parameters

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

Return values

array<string|int, ObjectStateGroup>

loadObjectStates() ¶

ObjectStateServiceDecorator.php : 57 Copy path

This method returns the ordered list of object states of a group.

public loadObjectStates(ObjectStateGroup $objectStateGroup[, array<string|int, mixed> $prioritizedLanguages = [] ]) : array<string|int, ObjectState>

Parameters

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

Return values

array<string|int, ObjectState>

newObjectStateCreateStruct() ¶

ObjectStateServiceDecorator.php : 151 Copy path

Instantiates a new Object State Create Struct and sets $identifier in it.

public newObjectStateCreateStruct(string $identifier) : ObjectStateCreateStruct

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

ObjectStateCreateStruct

newObjectStateGroupCreateStruct() ¶

ObjectStateServiceDecorator.php : 141 Copy path

Instantiates a new Object State Group Create Struct and sets $identified in it.

public newObjectStateGroupCreateStruct(string $identifier) : ObjectStateGroupCreateStruct

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

ObjectStateGroupCreateStruct

newObjectStateGroupUpdateStruct() ¶

ObjectStateServiceDecorator.php : 146 Copy path

Instantiates a new Object State Group Update Struct.

public newObjectStateGroupUpdateStruct() : ObjectStateGroupUpdateStruct

Return values

ObjectStateGroupUpdateStruct

newObjectStateUpdateStruct() ¶

ObjectStateServiceDecorator.php : 156 Copy path

Instantiates a new Object State Update Struct.

public newObjectStateUpdateStruct() : ObjectStateUpdateStruct

Return values

ObjectStateUpdateStruct

setContentState() ¶

ObjectStateServiceDecorator.php : 121 Copy path

Sets the object-state of a state group to $state for the given content.

public setContentState(ContentInfo $contentInfo, ObjectStateGroup $objectStateGroup, ObjectState $objectState) : void

Parameters

Name	Type	Default value	Description
$contentInfo	ContentInfo	-	-
$objectStateGroup	ObjectStateGroup	-	-
$objectState	ObjectState	-	-

setPriorityOfObjectState() ¶

ObjectStateServiceDecorator.php : 109 Copy path

Changes the priority of the state.

public setPriorityOfObjectState(ObjectState $objectState, int $priority) : void

Parameters

Name	Type	Default value	Description
$objectState	ObjectState	-	-
$priority	int	-	-

updateObjectState() ¶

ObjectStateServiceDecorator.php : 102 Copy path

Updates an object state.

public updateObjectState(ObjectState $objectState, ObjectStateUpdateStruct $objectStateUpdateStruct) : ObjectState

Parameters

Name	Type	Default value	Description
$objectState	ObjectState	-	-
$objectStateUpdateStruct	ObjectStateUpdateStruct	-	-

Return values

ObjectState

updateObjectStateGroup() ¶

ObjectStateServiceDecorator.php : 64 Copy path

Updates an object state group.

public updateObjectStateGroup(ObjectStateGroup $objectStateGroup, ObjectStateGroupUpdateStruct $objectStateGroupUpdateStruct) : ObjectStateGroup

Parameters

Name	Type	Default value	Description
$objectStateGroup	ObjectStateGroup	-	-
$objectStateGroupUpdateStruct	ObjectStateGroupUpdateStruct	-	-

Return values

ObjectStateGroup