PHP Class eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway

Show file Open project: ezsystems/ezpublish-kernel Class Usage Examples

Public Methods

Method Description
deleteObjectState ( integer $stateId ) Deletes object state identified by $stateId.
deleteObjectStateGroup ( mixed $groupId ) Deletes the object state group identified by $groupId.
deleteObjectStateLinks ( integer $stateId ) Deletes object state links identified by $stateId.
getContentCount ( mixed $stateId ) : integer Returns the number of objects which are in this state.
insertObjectState ( eZ\Publish\SPI\Persistence\Content\ObjectState $objectState, integer $groupId ) Inserts a new object state into database.
insertObjectStateGroup ( eZ\Publish\SPI\Persistence\Content\ObjectState\Group $objectStateGroup ) Inserts a new object state group into database.
loadObjectStateData ( mixed $stateId ) : array Loads data for an object state.
loadObjectStateDataByIdentifier ( string $identifier, mixed $groupId ) : array Loads data for an object state by identifier.
loadObjectStateDataForContent ( integer $contentId, integer $stateGroupId ) : array Loads object state data for $contentId content from $stateGroupId state group.
loadObjectStateGroupData ( mixed $groupId ) : array Loads data for an object state group.
loadObjectStateGroupDataByIdentifier ( string $identifier ) : array Loads data for an object state group by identifier.
loadObjectStateGroupListData ( integer $offset, integer $limit ) : array Loads data for all object state groups, filtered by $offset and $limit.
loadObjectStateListData ( mixed $groupId ) : array Loads data for all object states belonging to group with $groupId ID.
setContentState ( mixed $contentId, mixed $groupId, mixed $stateId ) Sets the object state $stateId to content with $contentId ID.
updateObjectState ( eZ\Publish\SPI\Persistence\Content\ObjectState $objectState ) Updates the stored object state with provided data.
updateObjectStateGroup ( eZ\Publish\SPI\Persistence\Content\ObjectState\Group $objectStateGroup ) Updates the stored object state group with provided data.
updateObjectStateLinks ( integer $oldStateId, integer $newStateId ) Update object state links from $oldStateId to $newStateId.
updateObjectStatePriority ( mixed $stateId, integer $priority ) Updates the object state priority to provided value.

Method Details

deleteObjectState() abstract public method

Deletes object state identified by $stateId.
abstract public deleteObjectState ( integer $stateId )
$stateId integer

deleteObjectStateGroup() abstract public method

Deletes the object state group identified by $groupId.
abstract public deleteObjectStateGroup ( mixed $groupId )
$groupId mixed

getContentCount() abstract public method

Returns the number of objects which are in this state.
abstract public getContentCount ( mixed $stateId ) : integer
$stateId mixed
return integer

insertObjectState() abstract public method

Inserts a new object state into database.
abstract public insertObjectState ( eZ\Publish\SPI\Persistence\Content\ObjectState $objectState, integer $groupId )
$objectState eZ\Publish\SPI\Persistence\Content\ObjectState
$groupId integer

insertObjectStateGroup() abstract public method

Inserts a new object state group into database.
abstract public insertObjectStateGroup ( eZ\Publish\SPI\Persistence\Content\ObjectState\Group $objectStateGroup )
$objectStateGroup eZ\Publish\SPI\Persistence\Content\ObjectState\Group

loadObjectStateData() abstract public method

Loads data for an object state.
abstract public loadObjectStateData ( mixed $stateId ) : array
$stateId mixed
return array

loadObjectStateDataByIdentifier() abstract public method

Loads data for an object state by identifier.
abstract public loadObjectStateDataByIdentifier ( string $identifier, mixed $groupId ) : array
$identifier string
$groupId mixed
return array

loadObjectStateDataForContent() abstract public method

Loads object state data for $contentId content from $stateGroupId state group.
abstract public loadObjectStateDataForContent ( integer $contentId, integer $stateGroupId ) : array
$contentId integer
$stateGroupId integer
return array

loadObjectStateGroupData() abstract public method

Loads data for an object state group.
abstract public loadObjectStateGroupData ( mixed $groupId ) : array
$groupId mixed
return array

loadObjectStateGroupDataByIdentifier() abstract public method

Loads data for an object state group by identifier.
abstract public loadObjectStateGroupDataByIdentifier ( string $identifier ) : array
$identifier string
return array

loadObjectStateGroupListData() abstract public method

Loads data for all object state groups, filtered by $offset and $limit.
abstract public loadObjectStateGroupListData ( integer $offset, integer $limit ) : array
$offset integer
$limit integer
return array

loadObjectStateListData() abstract public method

Loads data for all object states belonging to group with $groupId ID.
abstract public loadObjectStateListData ( mixed $groupId ) : array
$groupId mixed
return array

setContentState() abstract public method

Sets the object state $stateId to content with $contentId ID.
abstract public setContentState ( mixed $contentId, mixed $groupId, mixed $stateId )
$contentId mixed
$groupId mixed
$stateId mixed

updateObjectState() abstract public method

Updates the stored object state with provided data.
abstract public updateObjectState ( eZ\Publish\SPI\Persistence\Content\ObjectState $objectState )
$objectState eZ\Publish\SPI\Persistence\Content\ObjectState

updateObjectStateGroup() abstract public method

Updates the stored object state group with provided data.
abstract public updateObjectStateGroup ( eZ\Publish\SPI\Persistence\Content\ObjectState\Group $objectStateGroup )
$objectStateGroup eZ\Publish\SPI\Persistence\Content\ObjectState\Group

updateObjectStatePriority() abstract public method

Updates the object state priority to provided value.
abstract public updateObjectStatePriority ( mixed $stateId, integer $priority )
$stateId mixed
$priority integer