Bitrix API

TypeTable extends TypeDataManager

Class TypeTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION

Table of Contents

Constants

EVENT_ON_ADD  = "OnAdd"
EVENT_ON_AFTER_ADD  = "OnAfterAdd"
EVENT_ON_AFTER_DELETE  = "OnAfterDelete"
EVENT_ON_AFTER_UPDATE  = "OnAfterUpdate"
EVENT_ON_BEFORE_ADD  = "OnBeforeAdd"
EVENT_ON_BEFORE_DELETE  = "OnBeforeDelete"
EVENT_ON_BEFORE_UPDATE  = "OnBeforeUpdate"
EVENT_ON_DELETE  = "OnDelete"
EVENT_ON_UPDATE  = "OnUpdate"
MAXIMUM_TABLE_NAME_LENGTH  = 64

Methods

add()  : AddResult
Adds row to entity table
addMulti()  : AddResult
checkFields()  : mixed
Checks the data fields before saving to DB. Result stores in the $result object
cleanCache()  : void
Cleans the tablet cache after data modifications.
compileEntity()  : Entity
compileItemFieldsContextEntity()  : Entity
compileItemIndexEntity()  : Entity
createCollection()  : EO_Type_Collection
createItemFieldsContextTable()  : Result
createItemIndexTable()  : Result
createItemIndexTableInAgent()  : string
createObject()  : Type
cryptoEnabled()  : bool
Returns true if crypto is enabled for a field.
delete()  : DeleteResult
Deletes row in entity table by primary key
deleteEntityAutomation()  : void
deleteItemFieldsContextTable()  : Result
deleteItemIndexTable()  : Result
enableCrypto()  : mixed
Sets a flag indicating crypto support for a field.
generateName()  : string|null
getByEntityTypeId()  : Result
getById()  : EO_Type_Result
Returns selection by entity's primary key
getByPrimary()  : EO_Type_Result
Returns selection by entity's primary key and optional parameters for getList()
getCollectionClass()  : string|Collection
Returns class of Object collection for current entity.
getCollectionClassName()  : string
Returns class name (without namespace) of Object collection for current entity.
getCollectionParentClass()  : Collection|string
getConnectionName()  : string
Returns connection name for entity
getCount()  : int
Performs COUNT query on entity and returns the result.
getEntity()  : EO_Type_Entity
Returns entity object
getEntityClass()  : Entity|string
getFactory()  : TypeFactory
getFieldsInfo()  : array<string|int, mixed>
getList()  : EO_Type_Result
Executes the query and returns selection by parameters of the query. This function is an alias to the Query object functions
getMap()  : array<string|int, mixed>
Returns entity map definition.
getMultipleValueTableName()  : string
getNextAvailableEntityTypeId()  : int|null
getObjectClass()  : Entity|string
Returns class of Object for current entity.
getObjectClassName()  : string
Returns class name (without namespace) of Object for current entity.
getObjectParentClass()  : EntityObject|string
getQueryClass()  : Query|string
getRow()  : array<string|int, mixed>|null
Returns one row (or null) by parameters for getList()
getRowById()  : array<string|int, mixed>|null
Returns one row (or null) by entity's primary key
getTableName()  : string
Returns DB table name for entity
getTitle()  : string|null
getUfId()  : mixed
getUtmEntityClassName()  : string
isCacheable()  : bool
You can disable cache for the tablet completely.
isCreatingInProgress()  : bool
isUtm()  : mixed
isUts()  : mixed
onAdd()  : mixed
onAfterAdd()  : EventResult
onAfterDelete()  : EventResult
onAfterUpdate()  : EventResult
onBeforeAdd()  : EventResult
onBeforeDelete()  : EventResult
onBeforeUpdate()  : EventResult
onDelete()  : mixed
onUpdate()  : mixed
postInitialize()  : null
query()  : EO_Type_Query
Creates and returns the Query object for the entity
resolveType()  : array<string|int, mixed>|null
setCurrentDeletingObject()  : void
setDefaultScope()  : Query
unsetEntity()  : mixed
update()  : UpdateResult
Updates row in entity table by primary key
updateMulti()  : UpdateResult
validateEntityTypeId()  : mixed
validateTableExisting()  : mixed
wakeUpCollection()  : EO_Type_Collection
wakeUpObject()  : Type

Constants

EVENT_ON_AFTER_ADD

public mixed EVENT_ON_AFTER_ADD = "OnAfterAdd"

EVENT_ON_AFTER_DELETE

public mixed EVENT_ON_AFTER_DELETE = "OnAfterDelete"

EVENT_ON_AFTER_UPDATE

public mixed EVENT_ON_AFTER_UPDATE = "OnAfterUpdate"

EVENT_ON_BEFORE_ADD

public mixed EVENT_ON_BEFORE_ADD = "OnBeforeAdd"

EVENT_ON_BEFORE_DELETE

public mixed EVENT_ON_BEFORE_DELETE = "OnBeforeDelete"

EVENT_ON_BEFORE_UPDATE

public mixed EVENT_ON_BEFORE_UPDATE = "OnBeforeUpdate"

EVENT_ON_DELETE

public mixed EVENT_ON_DELETE = "OnDelete"

EVENT_ON_UPDATE

public mixed EVENT_ON_UPDATE = "OnUpdate"

MAXIMUM_TABLE_NAME_LENGTH

public mixed MAXIMUM_TABLE_NAME_LENGTH = 64

Methods

add()

Adds row to entity table

public static add(array<string|int, mixed> $data) : AddResult
Parameters
$data : array<string|int, mixed>

An array with fields like array( "fields" => array( "FIELD1" => "value1", "FIELD2" => "value2", ), "auth_context" => \Bitrix\Main\Authentication\Context object ) or just a plain array of fields.

Tags
throws
Exception
Return values
AddResult —

Contains ID of inserted row

addMulti()

public static addMulti(mixed $rows[, bool $ignoreEvents = false ]) : AddResult
Parameters
$rows : mixed
$ignoreEvents : bool = false
Tags
throws
ArgumentException
throws
SystemException
Return values
AddResult

checkFields()

Checks the data fields before saving to DB. Result stores in the $result object

public static checkFields(Result $result, mixed $primary, array<string|int, mixed> $data) : mixed
Parameters
$result : Result
$primary : mixed
$data : array<string|int, mixed>
Tags
throws
ArgumentException
throws
SystemException

cleanCache()

Cleans the tablet cache after data modifications.

public static cleanCache() : void

compileEntity()

public static compileEntity(mixed $type) : Entity
Parameters
$type : mixed
Return values
Entity

compileItemFieldsContextEntity()

public static compileItemFieldsContextEntity(mixed $type) : Entity
Parameters
$type : mixed
Return values
Entity

compileItemIndexEntity()

public static compileItemIndexEntity(mixed $type) : Entity
Parameters
$type : mixed
Return values
Entity

createCollection()

public static createCollection() : EO_Type_Collection
Return values
EO_Type_Collection

createItemFieldsContextTable()

public static createItemFieldsContextTable(mixed $type) : Result
Parameters
$type : mixed
Return values
Result

createItemIndexTable()

public static createItemIndexTable(mixed $type) : Result
Parameters
$type : mixed
Return values
Result

createItemIndexTableInAgent()

public static createItemIndexTableInAgent(mixed $type) : string
Parameters
$type : mixed
Return values
string

createObject()

public static createObject([mixed $setDefaultValues = = 'true' ]) : Type
Parameters
$setDefaultValues : mixed = = 'true'
Return values
Type

cryptoEnabled()

Returns true if crypto is enabled for a field.

public static cryptoEnabled(string $field[, string $table = null ]) : bool
Parameters
$field : string
$table : string = null
Return values
bool

delete()

Deletes row in entity table by primary key

public static delete(mixed $primary) : DeleteResult
Parameters
$primary : mixed
Tags
throws
Exception
Return values
DeleteResult

deleteEntityAutomation()

public static deleteEntityAutomation(int $entityTypeId) : void
Parameters
$entityTypeId : int

deleteItemFieldsContextTable()

public static deleteItemFieldsContextTable(mixed $type) : Result
Parameters
$type : mixed
Return values
Result

deleteItemIndexTable()

public static deleteItemIndexTable(mixed $type) : Result
Parameters
$type : mixed
Return values
Result

enableCrypto()

Sets a flag indicating crypto support for a field.

public static enableCrypto(string $field[, string $table = null ][, bool $mode = true ]) : mixed
Parameters
$field : string
$table : string = null
$mode : bool = true

generateName()

public static generateName([string $title = null ][, int $try = 0 ]) : string|null
Parameters
$title : string = null
$try : int = 0
Return values
string|null

getByEntityTypeId()

public static getByEntityTypeId(int $entityTypeId) : Result
Parameters
$entityTypeId : int
Return values
Result

getById()

Returns selection by entity's primary key

public static getById(mixed $id) : EO_Type_Result
Parameters
$id : mixed

Primary key of the entity

Return values
EO_Type_Result

getByPrimary()

Returns selection by entity's primary key and optional parameters for getList()

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_Type_Result
Parameters
$primary : mixed

Primary key of the entity

$parameters : array<string|int, mixed> = = '[]'

Additional parameters for getList()

Return values
EO_Type_Result

getCollectionClass()

Returns class of Object collection for current entity.

public static getCollectionClass() : string|Collection
Return values
string|Collection

getCollectionClassName()

Returns class name (without namespace) of Object collection for current entity.

public final static getCollectionClassName() : string
Return values
string

getConnectionName()

Returns connection name for entity

public static getConnectionName() : string
Return values
string

getCount()

Performs COUNT query on entity and returns the result.

public static getCount([array<string|int, mixed>|ConditionTree $filter = array() ][, array<string|int, mixed> $cache = array() ]) : int
Parameters
$filter : array<string|int, mixed>|ConditionTree = array()
$cache : array<string|int, mixed> = array()

An array of cache options "ttl" => integer indicating cache TTL

Tags
throws
ObjectPropertyException
throws
SystemException
Return values
int

getEntity()

Returns entity object

public static getEntity() : EO_Type_Entity
Return values
EO_Type_Entity

getFieldsInfo()

public static getFieldsInfo() : array<string|int, mixed>
Return values
array<string|int, mixed>

getList()

Executes the query and returns selection by parameters of the query. This function is an alias to the Query object functions

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_Type_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'

An array of query parameters, available keys are:
"select" => array of fields in the SELECT part of the query, aliases are possible in the form of "alias"=>"field";
"filter" => array of filters in the WHERE/HAVING part of the query in the form of "(condition)field"=>"value"; also could be an instance of Filter;
"group" => array of fields in the GROUP BY part of the query;
"order" => array of fields in the ORDER BY part of the query in the form of "field"=>"asc|desc";
"limit" => integer indicating maximum number of rows in the selection (like LIMIT n in MySql);
"offset" => integer indicating first row number in the selection (like LIMIT n, 100 in MySql);
"runtime" => array of entity fields created dynamically;
"cache => array of cache options:
"ttl" => integer indicating cache TTL;
"cache_joins" => boolean enabling to cache joins, false by default.

Return values
EO_Type_Result

getMap()

Returns entity map definition.

public static getMap() : array<string|int, mixed>

To get initialized fields @see \Bitrix\Main\ORM\Entity::getFields() and \Bitrix\Main\ORM\Entity::getField()

Return values
array<string|int, mixed>

getMultipleValueTableName()

public static getMultipleValueTableName(mixed $type, mixed $userField) : string
Parameters
$type : mixed
$userField : mixed
Return values
string

getNextAvailableEntityTypeId()

public static getNextAvailableEntityTypeId() : int|null
Return values
int|null

getObjectClass()

Returns class of Object for current entity.

public static getObjectClass() : Entity|string
Return values
Entity|string

getObjectClassName()

Returns class name (without namespace) of Object for current entity.

public final static getObjectClassName() : string
Return values
string

getRow()

Returns one row (or null) by parameters for getList()

public static getRow(array<string|int, mixed> $parameters) : array<string|int, mixed>|null
Parameters
$parameters : array<string|int, mixed>

Primary key of the entity

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|null

getRowById()

Returns one row (or null) by entity's primary key

public static getRowById(mixed $id) : array<string|int, mixed>|null
Parameters
$id : mixed

Primary key of the entity

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>|null

getTableName()

Returns DB table name for entity

public static getTableName() : string
Return values
string

getTitle()

public static getTitle() : string|null
Return values
string|null

getUtmEntityClassName()

public static getUtmEntityClassName(Entity $typeEntity, mixed $userField) : string
Parameters
$typeEntity : Entity
$userField : mixed
Return values
string

isCacheable()

You can disable cache for the tablet completely.

public static isCacheable() : bool
Return values
bool

isCreatingInProgress()

public static isCreatingInProgress(int $entityTypeId) : bool
Parameters
$entityTypeId : int
Return values
bool

postInitialize()

public static postInitialize(Entity $entity) : null
Parameters
$entity : Entity
Return values
null

query()

Creates and returns the Query object for the entity

public static query() : EO_Type_Query
Return values
EO_Type_Query

resolveType()

public static resolveType(array<string|int, mixed>|int|string|Type $type) : array<string|int, mixed>|null
Parameters
$type : array<string|int, mixed>|int|string|Type

Could be an object, an array, ID or NAME of block.

Return values
array<string|int, mixed>|null

unsetEntity()

public static unsetEntity(mixed $class) : mixed
Parameters
$class : mixed

update()

Updates row in entity table by primary key

public static update(mixed $primary, array<string|int, mixed> $data) : UpdateResult
Parameters
$primary : mixed
$data : array<string|int, mixed>

An array with fields like array( "fields" => array( "FIELD1" => "value1", "FIELD2" => "value2", ), "auth_context" => \Bitrix\Main\Authentication\Context object ) or just a plain array of fields.

Tags
throws
Exception
Return values
UpdateResult

updateMulti()

public static updateMulti(array<string|int, mixed> $primaries, array<string|int, mixed> $data[, bool $ignoreEvents = false ]) : UpdateResult
Parameters
$primaries : array<string|int, mixed>
$data : array<string|int, mixed>
$ignoreEvents : bool = false
Tags
throws
ArgumentException
throws
SystemException
Return values
UpdateResult

validateEntityTypeId()

public static validateEntityTypeId(mixed $value, mixed $primary, array<string|int, mixed> $row, Field $field) : mixed
Parameters
$value : mixed
$primary : mixed
$row : array<string|int, mixed>
$field : Field

validateTableExisting()

public static validateTableExisting(mixed $value, mixed $primary, array<string|int, mixed> $row, Field $field) : mixed
Parameters
$value : mixed
$primary : mixed
$row : array<string|int, mixed>
$field : Field

wakeUpCollection()

public static wakeUpCollection(mixed $rows) : EO_Type_Collection
Parameters
$rows : mixed
Return values
EO_Type_Collection

wakeUpObject()

public static wakeUpObject(mixed $row) : Type
Parameters
$row : mixed
Return values
Type 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results