eZPublishCommunityProject  2012.12
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway Class Reference

ObjectState Gateway. More...

+ Inheritance diagram for eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway:

Public Member Functions

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

Detailed Description

Member Function Documentation

eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::deleteObjectState (   $stateId)
abstract

Deletes object state identified by $stateId.

Parameters
int$stateId
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::deleteObjectStateGroup (   $groupId)
abstract

Deletes the object state group identified by $groupId.

Parameters
mixed$groupId
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::deleteObjectStateLinks (   $stateId)
abstract

Deletes object state links identified by $stateId.

Parameters
int$stateId
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::getContentCount (   $stateId)
abstract

Returns the number of objects which are in this state.

Parameters
mixed$stateId
Returns
int
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::insertObjectState ( ObjectState  $objectState,
  $groupId 
)
abstract

Inserts a new object state into database.

Parameters
\eZ\Publish\SPI\Persistence\Content\ObjectState$objectState
int$groupId
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::insertObjectStateGroup ( Group  $objectStateGroup)
abstract

Inserts a new object state group into database.

Parameters
\eZ\Publish\SPI\Persistence\Content\ObjectState\Group$objectStateGroup
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::loadObjectStateData (   $stateId)
abstract

Loads data for an object state.

Parameters
mixed$stateId
Returns
array
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::loadObjectStateDataByIdentifier (   $identifier,
  $groupId 
)
abstract

Loads data for an object state by identifier.

Parameters
string$identifier
mixed$groupId
Returns
array
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::loadObjectStateDataForContent (   $contentId,
  $stateGroupId 
)
abstract

Loads object state data for $contentId content from $stateGroupId state group.

Parameters
int$contentId
int$stateGroupId
Returns
array
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::loadObjectStateGroupData (   $groupId)
abstract

Loads data for an object state group.

Parameters
mixed$groupId
Returns
array
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::loadObjectStateGroupDataByIdentifier (   $identifier)
abstract

Loads data for an object state group by identifier.

Parameters
string$identifier
Returns
array
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::loadObjectStateGroupListData (   $offset,
  $limit 
)
abstract

Loads data for all object state groups, filtered by $offset and $limit.

Parameters
int$offset
int$limit
Returns
array
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::loadObjectStateListData (   $groupId)
abstract

Loads data for all object states belonging to group with $groupId ID.

Parameters
mixed$groupId
Returns
array
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::setContentState (   $contentId,
  $groupId,
  $stateId 
)
abstract

Sets the object state $stateId to content with $contentId ID.

Parameters
mixed$contentId
mixed$groupId
mixed$stateId
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::updateObjectState ( ObjectState  $objectState)
abstract

Updates the stored object state with provided data.

Parameters
\eZ\Publish\SPI\Persistence\Content\ObjectState$objectState
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::updateObjectStateGroup ( Group  $objectStateGroup)
abstract

Updates the stored object state group with provided data.

Parameters
\eZ\Publish\SPI\Persistence\Content\ObjectState\Group$objectStateGroup
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::updateObjectStateLinks (   $oldStateId,
  $newStateId 
)
abstract

Update object state links from $oldStateId to $newStateId.

Parameters
int$oldStateId
int$newStateId
eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway::updateObjectStatePriority (   $stateId,
  $priority 
)
abstract

Updates the object state priority to provided value.

Parameters
mixed$stateId
int$priority

The documentation for this class was generated from the following file: