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

Inheritance: extends eZ\Publish\Core\Persistence\Legacy\Content\Type\Gateway
Datei anzeigen Open project: ezsystems/ezpublish-kernel

Protected Properties

Property Type Description
$columns array Columns of database tables.
$dbHandler eZ\Publish\Core\Persistence\Database\DatabaseHandler DoctrineDatabase handler.
$languageMaskGenerator eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator Language mask generator.

Public Methods

Method Description
__construct ( eZ\Publish\Core\Persistence\Database\DatabaseHandler $db, MaskGenerator $languageMaskGenerator ) Creates a new gateway based on $db.
countGroupsForType ( integer $typeId, integer $status ) : integer Returns the number of Groups the type is assigned to.
countInstancesOfType ( integer $typeId ) : integer Counts the number of instances that exists of the identified type.
countTypesInGroup ( integer $groupId ) : integer Returns the number of types in a certain group.
delete ( mixed $typeId, integer $status ) Deletes a Type completely.
deleteFieldDefinition ( mixed $typeId, integer $status, mixed $fieldDefinitionId ) Deletes a field definition.
deleteFieldDefinitionsForType ( mixed $typeId, integer $status ) Deletes all field definitions of a Type.
deleteGroup ( integer $groupId ) Deletes the Group with the given $groupId.
deleteGroupAssignment ( mixed $groupId, mixed $typeId, integer $status ) Deletes a group assignments for a Type.
deleteGroupAssignmentsForType ( mixed $typeId, integer $status ) Deletes all group assignments for a Type.
deleteType ( mixed $typeId, integer $status ) Deletes a the Type.
getSearchableFieldMapData ( ) : array Returns searchable field mapping data.
insertFieldDefinition ( mixed $typeId, integer $status, eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition $fieldDefinition, StorageFieldDefinition $storageFieldDef ) : mixed Inserts a $fieldDefinition for $typeId.
insertGroup ( eZ\Publish\SPI\Persistence\Content\Type\Group $group ) : mixed Inserts the given $group.
insertGroupAssignment ( mixed $groupId, mixed $typeId, integer $status ) Insert assignment of $typeId to $groupId.
insertType ( eZ\Publish\SPI\Persistence\Content\Type $type, mixed | null $typeId = null ) : mixed Inserts a new content type.
loadAllGroupsData ( ) : string[][] Returns an array with data about all Group objects.
loadFieldDefinition ( mixed $id, integer $status ) : array Loads an array with data about field definition referred $id and $status.
loadGroupData ( mixed $groupId ) : string[][] Loads data about Group with $groupId.
loadGroupDataByIdentifier ( mixed $identifier ) : string[][] Loads data about Group with $identifier.
loadTypeData ( mixed $typeId, integer $status ) : array Loads an array with data about $typeId in $status.
loadTypeDataByIdentifier ( string $identifier, integer $status ) : array(int=>array(string=>mixed)) Loads an array with data about the type referred to by $identifier in $status.
loadTypeDataByRemoteId ( mixed $remoteId, integer $status ) : array(int=>array(string=>mixed)) Loads an array with data about the type referred to by $remoteId in $status.
loadTypesDataForGroup ( mixed $groupId, integer $status ) : string[][] Loads data for all Types in $status in $groupId.
publishTypeAndFields ( integer $typeId, integer $sourceVersion, integer $targetVersion ) Publishes the Type with $typeId from $sourceVersion to $targetVersion, including its fields.
updateFieldDefinition ( mixed $typeId, integer $status, eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition $fieldDefinition, StorageFieldDefinition $storageFieldDef ) Updates a $fieldDefinition for $typeId.
updateGroup ( eZ\Publish\SPI\Persistence\Content\Type\Group\UpdateStruct $group ) Updates a group with data in $group.
updateType ( mixed $typeId, integer $status, eZ\Publish\SPI\Persistence\Content\Type\UpdateStruct $updateStruct ) Update a type with $updateStruct.

Protected Methods

Method Description
createGroupLoadQuery ( ) : eZ\Publish\Core\Persistence\Database\SelectQuery Creates the basic query to load Group data.
deleteTypeNameData ( integer $typeId, integer $typeStatus ) Deletes all name data for $typeId in $typeStatus.
getLoadTypeQuery ( ) : eZ\Publish\Core\Persistence\Database\SelectQuery Returns a basic query to retrieve Type data.
insertTypeNameData ( integer $typeId, integer $typeStatus, array $languages ) Inserts data into contentclass_name.
selectColumns ( eZ\Publish\Core\Persistence\Database\SelectQuery $q, string $tableName ) Creates an array of select columns for $tableName.
setCommonFieldColumns ( eZ\Publish\Core\Persistence\Database\Query $q, eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition $fieldDefinition, StorageFieldDefinition $storageFieldDef ) Set common columns for insert/update of FieldDefinition.
setCommonTypeColumns ( eZ\Publish\Core\Persistence\Database\Query $q, eZ\Publish\SPI\Persistence\ValueObject $type ) Set common columns for insert/update of a Type.

Method Details

__construct() public method

Creates a new gateway based on $db.
public __construct ( eZ\Publish\Core\Persistence\Database\DatabaseHandler $db, MaskGenerator $languageMaskGenerator )
$db eZ\Publish\Core\Persistence\Database\DatabaseHandler
$languageMaskGenerator eZ\Publish\Core\Persistence\Legacy\Content\Language\MaskGenerator

countGroupsForType() public method

Returns the number of Groups the type is assigned to.
public countGroupsForType ( integer $typeId, integer $status ) : integer
$typeId integer
$status integer
return integer

countInstancesOfType() public method

Counts the number of instances that exists of the identified type.
public countInstancesOfType ( integer $typeId ) : integer
$typeId integer
return integer

countTypesInGroup() public method

Returns the number of types in a certain group.
public countTypesInGroup ( integer $groupId ) : integer
$groupId integer
return integer

createGroupLoadQuery() protected method

Creates the basic query to load Group data.
protected createGroupLoadQuery ( ) : eZ\Publish\Core\Persistence\Database\SelectQuery
return eZ\Publish\Core\Persistence\Database\SelectQuery

delete() public method

Deletes a Type completely.
public delete ( mixed $typeId, integer $status )
$typeId mixed
$status integer

deleteFieldDefinition() public method

Deletes a field definition.
public deleteFieldDefinition ( mixed $typeId, integer $status, mixed $fieldDefinitionId )
$typeId mixed
$status integer
$fieldDefinitionId mixed

deleteFieldDefinitionsForType() public method

Deletes all field definitions of a Type.
public deleteFieldDefinitionsForType ( mixed $typeId, integer $status )
$typeId mixed
$status integer

deleteGroup() public method

Deletes the Group with the given $groupId.
public deleteGroup ( integer $groupId )
$groupId integer

deleteGroupAssignment() public method

Deletes a group assignments for a Type.
public deleteGroupAssignment ( mixed $groupId, mixed $typeId, integer $status )
$groupId mixed
$typeId mixed
$status integer

deleteGroupAssignmentsForType() public method

Deletes all group assignments for a Type.
public deleteGroupAssignmentsForType ( mixed $typeId, integer $status )
$typeId mixed
$status integer

deleteType() public method

Does no delete the field definitions!
public deleteType ( mixed $typeId, integer $status )
$typeId mixed
$status integer

deleteTypeNameData() protected method

Deletes all name data for $typeId in $typeStatus.
protected deleteTypeNameData ( integer $typeId, integer $typeStatus )
$typeId integer
$typeStatus integer

getLoadTypeQuery() protected method

Returns a basic query to retrieve Type data.
protected getLoadTypeQuery ( ) : eZ\Publish\Core\Persistence\Database\SelectQuery
return eZ\Publish\Core\Persistence\Database\SelectQuery

getSearchableFieldMapData() public method

Returns searchable field mapping data.
public getSearchableFieldMapData ( ) : array
return array

insertFieldDefinition() public method

Inserts a $fieldDefinition for $typeId.
public insertFieldDefinition ( mixed $typeId, integer $status, eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition $fieldDefinition, StorageFieldDefinition $storageFieldDef ) : mixed
$typeId mixed
$status integer
$fieldDefinition eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition
$storageFieldDef eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldDefinition
return mixed Field definition ID

insertGroup() public method

Inserts the given $group.
public insertGroup ( eZ\Publish\SPI\Persistence\Content\Type\Group $group ) : mixed
$group eZ\Publish\SPI\Persistence\Content\Type\Group
return mixed Group ID

insertGroupAssignment() public method

Insert assignment of $typeId to $groupId.
public insertGroupAssignment ( mixed $groupId, mixed $typeId, integer $status )
$groupId mixed
$typeId mixed
$status integer

insertType() public method

Inserts a new content type.
public insertType ( eZ\Publish\SPI\Persistence\Content\Type $type, mixed | null $typeId = null ) : mixed
$type eZ\Publish\SPI\Persistence\Content\Type
$typeId mixed | null
return mixed Type ID

insertTypeNameData() protected method

Inserts data into contentclass_name.
protected insertTypeNameData ( integer $typeId, integer $typeStatus, array $languages )
$typeId integer
$typeStatus integer
$languages array

loadAllGroupsData() public method

Returns an array with data about all Group objects.
public loadAllGroupsData ( ) : string[][]
return string[][]

loadFieldDefinition() public method

Loads an array with data about field definition referred $id and $status.
public loadFieldDefinition ( mixed $id, integer $status ) : array
$id mixed field definition id
$status integer One of Type::STATUS_DEFINED|Type::STATUS_DRAFT|Type::STATUS_MODIFIED
return array Data rows.

loadGroupData() public method

Loads data about Group with $groupId.
public loadGroupData ( mixed $groupId ) : string[][]
$groupId mixed
return string[][]

loadGroupDataByIdentifier() public method

Loads data about Group with $identifier.
public loadGroupDataByIdentifier ( mixed $identifier ) : string[][]
$identifier mixed
return string[][]

loadTypeData() public method

Loads an array with data about $typeId in $status.
public loadTypeData ( mixed $typeId, integer $status ) : array
$typeId mixed
$status integer
return array Data rows.

loadTypeDataByIdentifier() public method

Loads an array with data about the type referred to by $identifier in $status.
public loadTypeDataByIdentifier ( string $identifier, integer $status ) : array(int=>array(string=>mixed))
$identifier string
$status integer
return array(int=>array(string=>mixed))

loadTypeDataByRemoteId() public method

Loads an array with data about the type referred to by $remoteId in $status.
public loadTypeDataByRemoteId ( mixed $remoteId, integer $status ) : array(int=>array(string=>mixed))
$remoteId mixed
$status integer
return array(int=>array(string=>mixed))

loadTypesDataForGroup() public method

Loads data for all Types in $status in $groupId.
public loadTypesDataForGroup ( mixed $groupId, integer $status ) : string[][]
$groupId mixed
$status integer
return string[][]

publishTypeAndFields() public method

Publishes the Type with $typeId from $sourceVersion to $targetVersion, including its fields.
public publishTypeAndFields ( integer $typeId, integer $sourceVersion, integer $targetVersion )
$typeId integer
$sourceVersion integer
$targetVersion integer

selectColumns() protected method

Creates an array of select columns for $tableName.
protected selectColumns ( eZ\Publish\Core\Persistence\Database\SelectQuery $q, string $tableName )
$q eZ\Publish\Core\Persistence\Database\SelectQuery
$tableName string

setCommonFieldColumns() protected method

Set common columns for insert/update of FieldDefinition.
protected setCommonFieldColumns ( eZ\Publish\Core\Persistence\Database\Query $q, eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition $fieldDefinition, StorageFieldDefinition $storageFieldDef )
$q eZ\Publish\Core\Persistence\Database\Query
$fieldDefinition eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition
$storageFieldDef eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldDefinition

setCommonTypeColumns() protected method

Set common columns for insert/update of a Type.
protected setCommonTypeColumns ( eZ\Publish\Core\Persistence\Database\Query $q, eZ\Publish\SPI\Persistence\ValueObject $type )
$q eZ\Publish\Core\Persistence\Database\Query
$type eZ\Publish\SPI\Persistence\ValueObject

updateFieldDefinition() public method

Updates a $fieldDefinition for $typeId.
public updateFieldDefinition ( mixed $typeId, integer $status, eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition $fieldDefinition, StorageFieldDefinition $storageFieldDef )
$typeId mixed
$status integer
$fieldDefinition eZ\Publish\SPI\Persistence\Content\Type\FieldDefinition
$storageFieldDef eZ\Publish\Core\Persistence\Legacy\Content\StorageFieldDefinition

updateGroup() public method

Updates a group with data in $group.
public updateGroup ( eZ\Publish\SPI\Persistence\Content\Type\Group\UpdateStruct $group )
$group eZ\Publish\SPI\Persistence\Content\Type\Group\UpdateStruct

updateType() public method

Update a type with $updateStruct.
public updateType ( mixed $typeId, integer $status, eZ\Publish\SPI\Persistence\Content\Type\UpdateStruct $updateStruct )
$typeId mixed
$status integer
$updateStruct eZ\Publish\SPI\Persistence\Content\Type\UpdateStruct

Property Details

$columns protected_oe property

Columns of database tables.
protected array $columns
return array

$dbHandler protected_oe property

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

$languageMaskGenerator protected_oe property

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