Bitrix API

Dependence extends ClosureTree

FinalYes

Table of Contents

Methods

attach()  : Result
Attach node $id to node $parentId. If node $id has subtree, it will be relocated
attachNew()  : Result
Attaches new node (without checking for subtree existence)
canAttach()  : mixed
delete()  : Result
Deletes node $id and, optionally, its entire sub-tree
detach()  : Result
Detach node $id from its parent
getCount()  : mixed
getDirectChildCount()  : array<string|int, mixed>
Get child count for $ids parents, according to the access rights
getParentTree()  : array<string|int, mixed>|Fragment
Returns parent tree for node $id
getPath()  : array<string|int, mixed>
Returns path from tree root to node $id
getSubTree()  : array<string|int, mixed>|Fragment
Returns subtree for node $id
getTableName()  : string
isNodeExist()  : bool
Checks if node $id exists
isPathExist()  : bool
Checks if there is a path from node $parentId to node $id

Methods

attach()

Attach node $id to node $parentId. If node $id has subtree, it will be relocated

public static attach(mixed $id[, mixed $parentId = 0 ][, array<string|int, mixed> $settings = array() ]) : Result
Parameters
$id : mixed
$parentId : mixed = 0
$settings : array<string|int, mixed> = array()
Return values
Result

attachNew()

Attaches new node (without checking for subtree existence)

public static attachNew(mixed $id, mixed $parentId[, array<string|int, mixed> $settings = array() ]) : Result
Parameters
$id : mixed
$parentId : mixed
$settings : array<string|int, mixed> = array()
Return values
Result

canAttach()

public static canAttach(mixed $id[, mixed $parentId = 0 ]) : mixed
Parameters
$id : mixed
$parentId : mixed = 0

delete()

Deletes node $id and, optionally, its entire sub-tree

public static delete(mixed $id[, array<string|int, mixed> $settings = array() ]) : Result
Parameters
$id : mixed
$settings : array<string|int, mixed> = array()
Return values
Result

detach()

Detach node $id from its parent

public static detach(mixed $id) : Result
Parameters
$id : mixed
Return values
Result

getDirectChildCount()

Get child count for $ids parents, according to the access rights

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

getParentTree()

Returns parent tree for node $id

public static getParentTree(mixed $id[, array<string|int, mixed> $parameters = array() ][, array<string|int, mixed> $settings = array() ]) : array<string|int, mixed>|Fragment
Parameters
$id : mixed
$parameters : array<string|int, mixed> = array()
$settings : array<string|int, mixed> = array()
Tags
throws
NotImplementedException
Return values
array<string|int, mixed>|Fragment

getPath()

Returns path from tree root to node $id

public static getPath(mixed $id[, array<string|int, mixed> $parameters = array() ][, array<string|int, mixed> $settings = array() ]) : array<string|int, mixed>
Parameters
$id : mixed
$parameters : array<string|int, mixed> = array()
$settings : array<string|int, mixed> = array()
Tags
throws
NotImplementedException
Return values
array<string|int, mixed>

getSubTree()

Returns subtree for node $id

public static getSubTree(mixed $id[, array<string|int, mixed> $parameters = array() ][, array<string|int, mixed> $settings = array() ]) : array<string|int, mixed>|Fragment

todo: implement RETURN_DBRESULT key, if needed

Parameters
$id : mixed
$parameters : array<string|int, mixed> = array()
$settings : array<string|int, mixed> = array()
Tags
throws
NotImplementedException
Return values
array<string|int, mixed>|Fragment

getTableName()

public static getTableName() : string
Tags
throws
NotImplementedException
Return values
string

isNodeExist()

Checks if node $id exists

public static isNodeExist(mixed $id) : bool
Parameters
$id : mixed
Return values
bool

isPathExist()

Checks if there is a path from node $parentId to node $id

public static isPathExist(mixed $parentId, mixed $id[, array<string|int, mixed> $settings = array() ]) : bool
Parameters
$parentId : mixed
$id : mixed
$settings : array<string|int, mixed> = array()
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results