Handler

Handler.php : 12 Copy path

Interface

The Object State Handler interface provides managing of object states and groups.

Methods¶

create() ¶

Handler.php : 92 Copy path

Creates a new object state in the given group.

public create(mixed $groupId, InputStruct $input) : ObjectState

The new state gets the last priority. Note: in current kernel: If it is the first state all content objects will set to this state.

Parameters

Name	Type	Default value	Description
$groupId	mixed	-	-
$input	InputStruct	-	-

Return values

ObjectState

createGroup() ¶

Handler.php : 21 Copy path

Creates a new object state group.

public createGroup(InputStruct $input) : Group

Parameters

Name	Type	Default value	Description
$input	InputStruct	-	-

Return values

Group

delete() ¶

Handler.php : 141 Copy path

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

public delete(mixed $stateId) : mixed

Parameters

Name	Type	Default value	Description
$stateId	mixed	-	-

deleteGroup() ¶

Handler.php : 79 Copy path

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

public deleteGroup(mixed $groupId) : mixed

Parameters

Name	Type	Default value	Description
$groupId	mixed	-	-

getContentCount() ¶

Handler.php : 173 Copy path

Returns the number of objects which are in this state.

public getContentCount(mixed $stateId) : int

Parameters

Name	Type	Default value	Description
$stateId	mixed	-	-

Return values

int

getContentState() ¶

Handler.php : 164 Copy path

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

public getContentState(mixed $contentId, mixed $stateGroupId) : ObjectState

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

Parameters

Name	Type	Default value	Description
$contentId	mixed	-	-
$stateGroupId	mixed	-	-

Return values

ObjectState

load() ¶

Handler.php : 103 Copy path

Loads an object state.

public load(mixed $stateId) : ObjectState

Parameters

Name	Type	Default value	Description
$stateId	mixed	-	-

Return values

ObjectState

Tags

loadAllGroups() ¶

Handler.php : 53 Copy path

Loads all object state groups.

public loadAllGroups([int $offset = 0 ][, int $limit = -1 ]) : array<string|int, Group>

Parameters

Name	Type	Default value	Description
$offset	int	0	-
$limit	int	-1	-

Return values

array<string|int, Group>

loadByIdentifier() ¶

Handler.php : 115 Copy path

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

public loadByIdentifier(string $identifier, mixed $groupId) : ObjectState

Parameters

Name	Type	Default value	Description
$identifier	string	-	-
$groupId	mixed	-	-

Return values

ObjectState

Tags

loadGroup() ¶

Handler.php : 32 Copy path

Loads a object state group.

public loadGroup(mixed $groupId) : Group

Parameters

Name	Type	Default value	Description
$groupId	mixed	-	-

Return values

Group

Tags

loadGroupByIdentifier() ¶

Handler.php : 43 Copy path

Loads a object state group by identifier.

public loadGroupByIdentifier(string $identifier) : Group

Parameters

Name	Type	Default value	Description
$identifier	string	-	-

Return values

Group

Tags

loadObjectStates() ¶

Handler.php : 62 Copy path

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

public loadObjectStates(mixed $groupId) : array<string|int, ObjectState>

Parameters

Name	Type	Default value	Description
$groupId	mixed	-	-

Return values

array<string|int, ObjectState>

setContentState() ¶

Handler.php : 152 Copy path

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

    
                        public setContentState(mixed $contentId, mixed $groupId, mixed $stateId) : bool

Parameters

Name	Type	Default value	Description
$contentId	mixed	-	-
$groupId	mixed	-	-
$stateId	mixed	-	-

Return values

bool

setPriority() ¶

Handler.php : 133 Copy path

Changes the priority of the state.

public setPriority(mixed $stateId, int $priority) : mixed

Parameters

Name	Type	Default value	Description
$stateId	mixed	-	-
$priority	int	-	-

update() ¶

Handler.php : 125 Copy path

Updates an object state.

public update(mixed $stateId, InputStruct $input) : ObjectState

Parameters

Name	Type	Default value	Description
$stateId	mixed	-	-
$input	InputStruct	-	-

Return values

ObjectState

updateGroup() ¶

Handler.php : 72 Copy path

Updates an object state group.

public updateGroup(mixed $groupId, InputStruct $input) : Group

Parameters

Name	Type	Default value	Description
$groupId	mixed	-	-
$input	InputStruct	-	-

Return values

Group