Bitrix API

ObjectPathTable extends DataManager

FinalYes

Class ObjectPathTable

Fields:

  • ID int mandatory
  • PARENT_ID int mandatory
  • OBJECT_ID int mandatory
  • DEPTH_LEVEL int optional

Table of Contents

Constants

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

Methods

addAsRoot()  : AddResult
Create root in closure.
appendTo()  : mixed
Append target to node,
className()  : string
createCollection()  : EO_ObjectPath_Collection
createObject()  : EO_ObjectPath
deleteByFilter()  : bool
Deletes rows by filter.
deleteByObject()  : mixed
getAncestors()  : array<string|int, mixed>
Get ancestors objects of $objectId.
getById()  : EO_ObjectPath_Result
getByPrimary()  : EO_ObjectPath_Result
getChildren()  : array<string|int, mixed>
Get direct children objects of $objectId.
getDescendants()  : array<string|int, mixed>
Get descendants objects of $objectId.
getEntity()  : EO_ObjectPath_Entity
getList()  : EO_ObjectPath_Result
getMap()  : mixed
getTableName()  : mixed
hasChildren()  : bool
Checks if object has children.
isLeaf()  : bool
Object is leaf?
merge()  : mixed
moveTo()  : mixed
Action move object to another node.
query()  : EO_ObjectPath_Query
Creates and returns the Query object for the entity
recalculateByStorage()  : void
Recalculates paths for the storage.
wakeUpCollection()  : EO_ObjectPath_Collection
wakeUpObject()  : EO_ObjectPath

Constants

MAX_LENGTH_BATCH_MYSQL_QUERY

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

Methods

addAsRoot()

Create root in closure.

public static addAsRoot(mixed $objectId) : AddResult
Parameters
$objectId : mixed
Tags
throws
ConfigurationException
throws
Exception
Return values
AddResult

appendTo()

Append target to node,

public static appendTo(mixed $objectId, mixed $appendToNodeId) : mixed
Parameters
$objectId : mixed
$appendToNodeId : mixed
Tags
throws
ConfigurationException
throws
ArgumentTypeException
throws
ArgumentNullException

className()

public static className() : string
Return values
string —

the fully qualified name of this class.

createCollection()

public static createCollection() : EO_ObjectPath_Collection
Return values
EO_ObjectPath_Collection

createObject()

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

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

deleteByObject()

public static deleteByObject(mixed $objectId) : mixed
Parameters
$objectId : mixed

getAncestors()

Get ancestors objects of $objectId.

public static getAncestors(mixed $objectId[, int $orderDepthLevel = SORT_ASC ]) : array<string|int, mixed>

PARENT_ID not really! Be careful :)

Parameters
$objectId : mixed
$orderDepthLevel : int = SORT_ASC

SORT_ASC | SORT_DESC

Tags
throws
ArgumentOutOfRangeException
throws
ArgumentException
throws
Exception
Return values
array<string|int, mixed>

getById()

public static getById(mixed $id) : EO_ObjectPath_Result
Parameters
$id : mixed
Return values
EO_ObjectPath_Result

getByPrimary()

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

getChildren()

Get direct children objects of $objectId.

public static getChildren(mixed $objectId) : array<string|int, mixed>
Parameters
$objectId : mixed
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

getDescendants()

Get descendants objects of $objectId.

public static getDescendants(mixed $objectId[, int $orderDepthLevel = SORT_ASC ]) : array<string|int, mixed>

PARENT_ID not really! Be careful :)

Parameters
$objectId : mixed
$orderDepthLevel : int = SORT_ASC

SORT_ASC | SORT_DESC

Tags
throws
ArgumentOutOfRangeException
throws
ArgumentException
throws
Exception
Return values
array<string|int, mixed>

getEntity()

public static getEntity() : EO_ObjectPath_Entity
Return values
EO_ObjectPath_Entity

getList()

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

getTableName()

public static getTableName() : mixed

hasChildren()

Checks if object has children.

public static hasChildren(int $objectId) : bool
Parameters
$objectId : int

Object id.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool

isLeaf()

Object is leaf?

public static isLeaf(mixed $objectId) : bool
Parameters
$objectId : mixed
Tags
throws
ArgumentException
throws
Exception
Return values
bool

merge()

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

moveTo()

Action move object to another node.

public static moveTo(mixed $objectId, mixed $toNodeId) : mixed

Recalculated paths.

Parameters
$objectId : mixed
$toNodeId : mixed
Tags
throws
ConfigurationException
throws
ArgumentTypeException
throws
ArgumentNullException

query()

Creates and returns the Query object for the entity

public static query() : EO_ObjectPath_Query
Return values
EO_ObjectPath_Query

recalculateByStorage()

Recalculates paths for the storage.

public static recalculateByStorage(int $storageId) : void
Parameters
$storageId : int

Storage id.

Tags
throws
ArgumentOutOfRangeException

wakeUpCollection()

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

wakeUpObject()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results