Copied!

Handler

Handler.php : 13
Interface

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

Methods

publiccreate()

Handler.php : 93

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

publiccreateGroup()

Handler.php : 22

Creates a new object state group.

public createGroup(InputStruct $input) : Group

Parameters

Name Type Default value Description
$input InputStruct - -

Return values

Group

publicdelete()

Handler.php : 142

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 - -

publicdeleteGroup()

Handler.php : 80

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 - -

publicgetContentCount()

Handler.php : 174

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

publicgetContentState()

Handler.php : 165

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

publicload()

Handler.php : 104

Loads an object state.

public load(mixed $stateId) : ObjectState

Parameters

Name Type Default value Description
$stateId mixed - -

Return values

ObjectState

Tags
Throws
NotFoundException

if the state was not found

publicloadAllGroups()

Handler.php : 54

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>

publicloadByIdentifier()

Handler.php : 116

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
Throws
NotFoundException

if the state was not found

publicloadGroup()

Handler.php : 33

Loads a object state group.

public loadGroup(mixed $groupId) : Group

Parameters

Name Type Default value Description
$groupId mixed - -

Return values

Group

Tags
Throws
NotFoundException

if the group was not found

publicloadGroupByIdentifier()

Handler.php : 44

Loads a object state group by identifier.

public loadGroupByIdentifier(string $identifier) : Group

Parameters

Name Type Default value Description
$identifier string - -

Return values

Group

Tags
Throws
NotFoundException

if the group was not found

publicloadObjectStates()

Handler.php : 63

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>

publicsetContentState()

Handler.php : 153

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

publicsetPriority()

Handler.php : 134

Changes the priority of the state.

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

Parameters

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

publicupdate()

Handler.php : 126

Updates an object state.

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

Parameters

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

Return values

ObjectState

publicupdateGroup()

Handler.php : 73

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