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

Inheritance: extends eZ\Publish\Core\Persistence\Legacy\Content\ObjectState\Gateway
Show file Open project: ezsystems/ezpublish-kernel

Protected Properties

Property Type Description
$dbHandler eZ\Publish\Core\Persistence\Database\DatabaseHandler Database handler.
$maskGenerator eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator Language mask generator.

Public Methods

Method Description
__construct ( eZ\Publish\Core\Persistence\Database\DatabaseHandler $dbHandler, MaskGenerator $maskGenerator ) Creates a new Doctrine database ObjectState Gateway.
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 to $newStateId.
updateObjectStatePriority ( mixed $stateId, integer $priority ) Updates the object state priority to provided value.

Protected Methods

Method Description
createObjectStateFindQuery ( ) : eZ\Publish\Core\Persistence\Database\SelectQuery Creates a generalized query for fetching object state(s).
createObjectStateGroupFindQuery ( ) : eZ\Publish\Core\Persistence\Database\SelectQuery Creates a generalized query for fetching object state group(s).
deleteObjectStateGroupTranslations ( mixed $groupId ) Deletes all translations of the $groupId state group.
deleteObjectStateTranslations ( mixed $stateId ) Deletes all translations of the $stateId state.
generateLanguageMask ( array $languageCodes ) : integer Generates language mask from provided language codes Also sets always available bit.
insertObjectStateGroupTranslations ( eZ\Publish\SPI\Persistence\Content\ObjectState\Group $objectStateGroup ) Inserts object state group translations into database.
insertObjectStateTranslations ( eZ\Publish\SPI\Persistence\Content\ObjectState $objectState ) Inserts object state group translations into database.

Method Details

__construct() public method

Creates a new Doctrine database ObjectState Gateway.
public __construct ( eZ\Publish\Core\Persistence\Database\DatabaseHandler $dbHandler, MaskGenerator $maskGenerator )
$dbHandler eZ\Publish\Core\Persistence\Database\DatabaseHandler
$maskGenerator eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator

createObjectStateFindQuery() protected method

Creates a generalized query for fetching object state(s).
protected createObjectStateFindQuery ( ) : eZ\Publish\Core\Persistence\Database\SelectQuery
return eZ\Publish\Core\Persistence\Database\SelectQuery

createObjectStateGroupFindQuery() protected method

Creates a generalized query for fetching object state group(s).
protected createObjectStateGroupFindQuery ( ) : eZ\Publish\Core\Persistence\Database\SelectQuery
return eZ\Publish\Core\Persistence\Database\SelectQuery

deleteObjectState() public method

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

deleteObjectStateGroup() public method

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

deleteObjectStateGroupTranslations() protected method

Deletes all translations of the $groupId state group.
protected deleteObjectStateGroupTranslations ( mixed $groupId )
$groupId mixed

deleteObjectStateTranslations() protected method

Deletes all translations of the $stateId state.
protected deleteObjectStateTranslations ( mixed $stateId )
$stateId mixed

generateLanguageMask() protected method

Generates language mask from provided language codes Also sets always available bit.
protected generateLanguageMask ( array $languageCodes ) : integer
$languageCodes array
return integer

getContentCount() public method

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

insertObjectState() public method

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

insertObjectStateGroup() public method

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

insertObjectStateGroupTranslations() protected method

Inserts object state group translations into database.
protected insertObjectStateGroupTranslations ( eZ\Publish\SPI\Persistence\Content\ObjectState\Group $objectStateGroup )
$objectStateGroup eZ\Publish\SPI\Persistence\Content\ObjectState\Group

insertObjectStateTranslations() protected method

Inserts object state group translations into database.
protected insertObjectStateTranslations ( eZ\Publish\SPI\Persistence\Content\ObjectState $objectState )
$objectState eZ\Publish\SPI\Persistence\Content\ObjectState

loadObjectStateData() public method

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

loadObjectStateDataByIdentifier() public method

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

loadObjectStateDataForContent() public method

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

loadObjectStateGroupData() public method

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

loadObjectStateGroupDataByIdentifier() public method

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

loadObjectStateGroupListData() public method

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

loadObjectStateListData() public method

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

setContentState() public method

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

updateObjectState() public method

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

updateObjectStateGroup() public method

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

updateObjectStatePriority() public method

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

Property Details

$dbHandler protected property

Database handler.
protected DatabaseHandler,eZ\Publish\Core\Persistence\Database $dbHandler
return eZ\Publish\Core\Persistence\Database\DatabaseHandler

$maskGenerator protected property

Language mask generator.
protected MaskGenerator,eZ\Publish\Core\Persistence\Legacy\Content\Language $maskGenerator
return eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator