Bitrix API

ObjectTable extends DataManager

Table of Contents

Constants

DELETED_TYPE_CHILD  = 4
DELETED_TYPE_NONE  = 0
DELETED_TYPE_ROOT  = 3
EVENT_ON_AFTER_MOVE  = "OnAfterMove"
EVENT_ON_AFTER_UPDATE_ATTR_BY_FILTER  = "OnAfterUpdateAttrByFilter"
EVENT_ON_BEFORE_MOVE  = "OnBeforeMove"
EVENT_ON_BEFORE_UPDATE_ATTR_BY_FILTER  = "OnBeforeUpdateAttrByFilter"
EVENT_ON_MOVE  = "OnMove"
EVENT_ON_UPDATE_ATTR_BY_FILTER  = "OnUpdateAttrByFilter"
MAX_LENGTH_BATCH_MYSQL_QUERY  = \Bitrix\Disk\Internals\Db\SqlHelper::MAX_LENGTH_BATCH_MYSQL_QUERY
TYPE_FILE  = 3
TYPE_FOLDER  = 2

Methods

add()  : mixed
changeSyncDateTime()  : UpdateResult
checkFields()  : mixed
className()  : string
delete()  : mixed
deleteByFilter()  : bool
Deletes rows by filter.
getAncestors()  : ArrayResult|Result
Get all ancestors by this folder.
getChildren()  : ArrayResult|Result
Get direct children.
getDescendants()  : ArrayResult|Result
Get all descendants by this folder.
getListOfDeletedTypes()  : mixed
getListOfTypeValues()  : mixed
getMap()  : mixed
getParents()  : ArrayResult|Result
Get all ancestors by this folder.
getTableName()  : mixed
merge()  : mixed
move()  : UpdateResult
Move object from node to another node.
onAfterAdd()  : mixed
onBeforeUpdate()  : mixed
query()  : Query
Creates and returns the Query object for the entity
updateSyncTime()  : mixed
validateCode()  : mixed
validateContentProvider()  : mixed
validateEtag()  : mixed
validateExternalHash()  : mixed
validateName()  : mixed
validateXmlId()  : mixed

Constants

DELETED_TYPE_CHILD

public mixed DELETED_TYPE_CHILD = 4

DELETED_TYPE_NONE

public mixed DELETED_TYPE_NONE = 0

DELETED_TYPE_ROOT

public mixed DELETED_TYPE_ROOT = 3

EVENT_ON_AFTER_MOVE

public mixed EVENT_ON_AFTER_MOVE = "OnAfterMove"

EVENT_ON_AFTER_UPDATE_ATTR_BY_FILTER

public mixed EVENT_ON_AFTER_UPDATE_ATTR_BY_FILTER = "OnAfterUpdateAttrByFilter"

EVENT_ON_BEFORE_MOVE

public mixed EVENT_ON_BEFORE_MOVE = "OnBeforeMove"

EVENT_ON_BEFORE_UPDATE_ATTR_BY_FILTER

public mixed EVENT_ON_BEFORE_UPDATE_ATTR_BY_FILTER = "OnBeforeUpdateAttrByFilter"

EVENT_ON_MOVE

public mixed EVENT_ON_MOVE = "OnMove"

EVENT_ON_UPDATE_ATTR_BY_FILTER

public mixed EVENT_ON_UPDATE_ATTR_BY_FILTER = "OnUpdateAttrByFilter"

MAX_LENGTH_BATCH_MYSQL_QUERY

public mixed MAX_LENGTH_BATCH_MYSQL_QUERY = \Bitrix\Disk\Internals\Db\SqlHelper::MAX_LENGTH_BATCH_MYSQL_QUERY

TYPE_FILE

public mixed TYPE_FILE = 3

TYPE_FOLDER

public mixed TYPE_FOLDER = 2

Methods

add()

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

checkFields()

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

className()

public static className() : string
Return values
string —

the fully qualified name of this class.

delete()

public static delete(mixed $primary) : mixed
Parameters
$primary : mixed

deleteByFilter()

Deletes rows by filter.

public static deleteByFilter(array<string|int, mixed> $filter) : bool
Parameters
$filter : array<string|int, mixed>

Filter

Tags
throws
ArgumentNullException
Return values
bool

getAncestors()

Get all ancestors by this folder.

public static getAncestors(mixed $objectId[, array<string|int, mixed> $parameters = array() ]) : ArrayResult|Result
Parameters
$objectId : mixed
$parameters : array<string|int, mixed> = array()
Tags
throws
ArgumentException
throws
Exception
Return values
ArrayResult|Result

getChildren()

Get direct children.

public static getChildren(mixed $objectId[, array<string|int, mixed> $parameters = array() ]) : ArrayResult|Result
Parameters
$objectId : mixed
$parameters : array<string|int, mixed> = array()
Tags
throws
ArgumentException
throws
Exception
Return values
ArrayResult|Result

getDescendants()

Get all descendants by this folder.

public static getDescendants(mixed $objectId[, array<string|int, mixed> $parameters = array() ]) : ArrayResult|Result
Parameters
$objectId : mixed
$parameters : array<string|int, mixed> = array()
Tags
throws
ArgumentException
throws
Exception
Return values
ArrayResult|Result

getListOfDeletedTypes()

public static getListOfDeletedTypes() : mixed

getListOfTypeValues()

public static getListOfTypeValues() : mixed

getMap()

public static getMap() : mixed

getParents()

Get all ancestors by this folder.

public static getParents(mixed $objectId[, array<string|int, mixed> $parameters = array() ]) : ArrayResult|Result
Parameters
$objectId : mixed
$parameters : array<string|int, mixed> = array()
Tags
throws
ArgumentException
Return values
ArrayResult|Result

getTableName()

public static getTableName() : mixed

merge()

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

move()

Move object from node to another node.

public static move(mixed $primary, mixed $newParentId) : UpdateResult

Use this method instead update.

Parameters
$primary : mixed
$newParentId : mixed
Return values
UpdateResult

onAfterAdd()

public static onAfterAdd(Event $event) : mixed
Parameters
$event : Event

onBeforeUpdate()

public static onBeforeUpdate(Event $event) : mixed
Parameters
$event : Event

query()

Creates and returns the Query object for the entity

public static query() : Query
Return values
Query

updateSyncTime()

public static updateSyncTime(mixed $objectId, DateTime $dateTime) : mixed
Parameters
$objectId : mixed
$dateTime : DateTime

validateCode()

public static validateCode() : mixed

validateContentProvider()

public static validateContentProvider() : mixed

validateEtag()

public static validateEtag() : mixed

validateExternalHash()

public static validateExternalHash() : mixed

validateName()

public static validateName() : mixed

validateXmlId()

public static validateXmlId() : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results