Class

eZ\Publish\Core\Persistence\Legacy\Content\Type\Gateway

abstract class Gateway

Base class for content type gateways.

Methods

mixed insertGroup(Group $group)

Inserts the given $group.

updateGroup(UpdateStruct $group)

Updates a group with data in $group.

int countTypesInGroup(int $groupId)

Returns the number of types in a certain group.

int countGroupsForType(int $typeId, int $status)

Returns the number of Groups the type is assigned to.

deleteGroup(int $groupId)

Deletes the Group with the given $groupId.

array loadGroupData(int $groupId)

Returns an array with data about the Group with $groupId.

array loadGroupDataByIdentifier(int $identifier)

Returns an array with data about the Group with $identifier.

array loadAllGroupsData()

Returns an array with data about all Group objects.

string[][] loadTypesDataForGroup(mixed $groupId, int $status)

Loads data for all Types in $status in $groupId.

mixed insertType(Type $type, mixed|null $typeId = null)

Inserts a new content type.

insertGroupAssignment(mixed $typeId, int $status, mixed $groupId)

Insert assignment of $typeId to $groupId.

deleteGroupAssignment(mixed $groupId, mixed $typeId, int $status)

Deletes a group assignments for a Type.

array loadFieldDefinition(mixed $id, int $status)

Loads an array with data about field definition referred $id and $status.

mixed insertFieldDefinition(mixed $typeId, int $status, FieldDefinition $fieldDefinition, StorageFieldDefinition $storageFieldDef)

Inserts a $fieldDefinition for $typeId.

deleteFieldDefinition(mixed $typeId, int $status, mixed $fieldDefinitionId)

Deletes a field definition.

updateFieldDefinition(mixed $typeId, int $status, FieldDefinition $fieldDefinition, StorageFieldDefinition $storageFieldDef)

Updates a $fieldDefinition for $typeId.

updateType(mixed $typeId, int $status, UpdateStruct $updateStruct)

Update a type with $updateStruct.

array loadTypeData(mixed $typeId, int $status)

Loads an array with data about $typeId in $status.

array(int=>array(string=>mixed)) loadTypeDataByIdentifier(string $identifier, int $status)

Loads an array with data about the type referred to by $identifier in $status.

array(int=>array(string=>mixed)) loadTypeDataByRemoteId(mixed $remoteId, int $status)

Loads an array with data about the type referred to by $remoteId in $status.

int countInstancesOfType(int $typeId)

Counts the number of instances that exists of the identified type.

delete(mixed $typeId, int $status)

Deletes a Type completely.

deleteFieldDefinitionsForType(mixed $typeId, int $status)

Deletes all field definitions of a Type.

deleteType(mixed $typeId, int $status)

Deletes a the Type.

deleteGroupAssignmentsForType(mixed $typeId, int $status)

Deletes all group assignments for a Type.

publishTypeAndFields(int $typeId, int $sourceStatus, int $targetStatus)

Publishes the Type with $typeId from $sourceVersion to $targetVersion, including its fields.

array getSearchableFieldMapData()

Returns searchable fields mapping data.

Details

at line 30
abstract public mixed insertGroup(Group $group)

Inserts the given $group.

Parameters

Group $group

Return Value

mixed Group ID

at line 37
abstract public updateGroup(UpdateStruct $group)

Updates a group with data in $group.

Parameters

UpdateStruct $group

at line 46
abstract public int countTypesInGroup(int $groupId)

Returns the number of types in a certain group.

Parameters

int $groupId

Return Value

int

at line 56
abstract public int countGroupsForType(int $typeId, int $status)

Returns the number of Groups the type is assigned to.

Parameters

int $typeId
int $status

Return Value

int

at line 63
abstract public deleteGroup(int $groupId)

Deletes the Group with the given $groupId.

Parameters

int $groupId

at line 72
abstract public array loadGroupData(int $groupId)

Returns an array with data about the Group with $groupId.

Parameters

int $groupId

Return Value

array

at line 81
abstract public array loadGroupDataByIdentifier(int $identifier)

Returns an array with data about the Group with $identifier.

Parameters

int $identifier

Return Value

array

at line 88
abstract public array loadAllGroupsData()

Returns an array with data about all Group objects.

Return Value

array

at line 98
abstract public string[][] loadTypesDataForGroup(mixed $groupId, int $status)

Loads data for all Types in $status in $groupId.

Parameters

mixed $groupId
int $status

Return Value

string[][]

at line 108
abstract public mixed insertType(Type $type, mixed|null $typeId = null)

Inserts a new content type.

Parameters

Type $type
mixed|null $typeId

Return Value

mixed Type ID

at line 117
abstract public insertGroupAssignment(mixed $typeId, int $status, mixed $groupId)

Insert assignment of $typeId to $groupId.

Parameters

mixed $typeId
int $status
mixed $groupId

at line 126
abstract public deleteGroupAssignment(mixed $groupId, mixed $typeId, int $status)

Deletes a group assignments for a Type.

Parameters

mixed $groupId
mixed $typeId
int $status

at line 136
abstract public array loadFieldDefinition(mixed $id, int $status)

Loads an array with data about field definition referred $id and $status.

Parameters

mixed $id field definition id
int $status field definition status

Return Value

array Data rows.

at line 148
abstract public mixed insertFieldDefinition(mixed $typeId, int $status, FieldDefinition $fieldDefinition, StorageFieldDefinition $storageFieldDef)

Inserts a $fieldDefinition for $typeId.

Parameters

mixed $typeId
int $status
FieldDefinition $fieldDefinition
StorageFieldDefinition $storageFieldDef

Return Value

mixed Field definition ID

at line 162
abstract public deleteFieldDefinition(mixed $typeId, int $status, mixed $fieldDefinitionId)

Deletes a field definition.

Parameters

mixed $typeId
int $status
mixed $fieldDefinitionId

at line 172
abstract public updateFieldDefinition(mixed $typeId, int $status, FieldDefinition $fieldDefinition, StorageFieldDefinition $storageFieldDef)

Updates a $fieldDefinition for $typeId.

Parameters

mixed $typeId
int $status
FieldDefinition $fieldDefinition
StorageFieldDefinition $storageFieldDef

at line 186
abstract public updateType(mixed $typeId, int $status, UpdateStruct $updateStruct)

Update a type with $updateStruct.

Parameters

mixed $typeId
int $status
UpdateStruct $updateStruct

at line 196
abstract public array loadTypeData(mixed $typeId, int $status)

Loads an array with data about $typeId in $status.

Parameters

mixed $typeId
int $status

Return Value

array Data rows.

at line 207
abstract public array(int=>array(string=>mixed)) loadTypeDataByIdentifier(string $identifier, int $status)

Loads an array with data about the type referred to by $identifier in $status.

Parameters

string $identifier
int $status

Return Value

array(int=>array(string=>mixed)) Data rows.

at line 218
abstract public array(int=>array(string=>mixed)) loadTypeDataByRemoteId(mixed $remoteId, int $status)

Loads an array with data about the type referred to by $remoteId in $status.

Parameters

mixed $remoteId
int $status

Return Value

array(int=>array(string=>mixed)) Data rows.

at line 227
abstract public int countInstancesOfType(int $typeId)

Counts the number of instances that exists of the identified type.

Parameters

int $typeId

Return Value

int

at line 235
abstract public delete(mixed $typeId, int $status)

Deletes a Type completely.

Parameters

mixed $typeId
int $status

at line 243
abstract public deleteFieldDefinitionsForType(mixed $typeId, int $status)

Deletes all field definitions of a Type.

Parameters

mixed $typeId
int $status

at line 253
abstract public deleteType(mixed $typeId, int $status)

Deletes a the Type.

Does no delete the field definitions!

Parameters

mixed $typeId
int $status

at line 261
abstract public deleteGroupAssignmentsForType(mixed $typeId, int $status)

Deletes all group assignments for a Type.

Parameters

mixed $typeId
int $status

at line 271
abstract public publishTypeAndFields(int $typeId, int $sourceStatus, int $targetStatus)

Publishes the Type with $typeId from $sourceVersion to $targetVersion, including its fields.

Parameters

int $typeId
int $sourceStatus
int $targetStatus

at line 278
abstract public array getSearchableFieldMapData()

Returns searchable fields mapping data.

Return Value

array