Bitrix API

LocationTable extends Tree

FinalYes

Class LocationTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION

Table of Contents

Constants

BLOCK_INSERT_MTU  = 9999
SORT_FREE_AFTER  = 2
SORT_FREE_BEFORE  = 1
SORT_HOLE_SIZE  = 10
SORT_HOLE_SIZE_HALF  = 5
SPACE_ADD  = 1
SPACE_REMOVE  = 2

Methods

add()  : mixed
addExtended()  : AddResult
Adds a new location
checkFields()  : mixed
checkIntegrity()  : mixed
checkNodeIsParentOfNode()  : mixed
checkNodeIsParentOfNodeById()  : mixed
createCollection()  : EO_Location_Collection
createObject()  : EO_Location
delete()  : mixed
deleteExtended()  : DeleteResult
Deletes location from the tree
getByCode()  : Result
Returns location with the specified code.
getById()  : EO_Location_Result
getByPrimary()  : EO_Location_Result
getChildren()  : mixed
getCodeValidators()  : mixed
getCountByFilter()  : mixed
getDeepestCommonParent()  : mixed
getEntity()  : EO_Location_Entity
getExternalData()  : mixed
getFilePath()  : mixed
getList()  : EO_Location_Result
getListFast()  : mixed
getMap()  : mixed
getParentTree()  : mixed
Fetches a chain of parents with their subtrees expanded
getPathToMultipleNodes()  : mixed
getPathToNode()  : mixed
getPathToNodeByCode()  : mixed
Fetches a parent chain of a specified node, using its code
getPathToNodeByCondition()  : mixed
Fetches a parent chain of a specified node
getSubTree()  : mixed
Fetches a set of items which form sub-tree of a given node
getSubtreeRangeSqlForNode()  : mixed
This method is for internal use only. It may be changed without any notification further, or even mystically disappear.
getTableName()  : mixed
mergeRelationsFromTemporalTable()  : mixed
query()  : EO_Location_Query
resetLegacyPath()  : mixed
resort()  : mixed
update()  : mixed
updateExtended()  : UpdateResult
Updates an existed location
wakeUpCollection()  : EO_Location_Collection
wakeUpObject()  : EO_Location

Constants

BLOCK_INSERT_MTU

public mixed BLOCK_INSERT_MTU = 9999

SORT_FREE_AFTER

public mixed SORT_FREE_AFTER = 2

SORT_FREE_BEFORE

public mixed SORT_FREE_BEFORE = 1

SORT_HOLE_SIZE

public mixed SORT_HOLE_SIZE = 10

SORT_HOLE_SIZE_HALF

public mixed SORT_HOLE_SIZE_HALF = 5

SPACE_ADD

public mixed SPACE_ADD = 1

SPACE_REMOVE

public mixed SPACE_REMOVE = 2

Methods

add()

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

addExtended()

Adds a new location

public static addExtended(array<string|int, mixed> $data[, array<string|int, mixed> $additional = array() ]) : AddResult
Parameters
$data : array<string|int, mixed>

to be added. Additional data keys could be passed:

  • NAME string[] : add name string to a newly created location
  • EXTERNAL string[] : add external data records to a newly created location
$additional : array<string|int, mixed> = array()

an additional behaviour flags:

  • REBALANCE boolean (default: true) : do rebalance after add
Return values
AddResult —

the result of add operation

checkFields()

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

checkIntegrity()

public static checkIntegrity() : mixed

checkNodeIsParentOfNode()

public static checkNodeIsParentOfNode(mixed $primary, mixed $childPrimary[, mixed $behaviour = array('ACCEPT_CODE' => false, 'CHECK_DIRECT' => false) ]) : mixed
Parameters
$primary : mixed
$childPrimary : mixed
$behaviour : mixed = array('ACCEPT_CODE' => false, 'CHECK_DIRECT' => false)

checkNodeIsParentOfNodeById()

public static checkNodeIsParentOfNodeById(mixed $primary, mixed $childPrimary[, mixed $behaviour = array('CHECK_DIRECT' => false) ]) : mixed
Parameters
$primary : mixed
$childPrimary : mixed
$behaviour : mixed = array('CHECK_DIRECT' => false)

createCollection()

public static createCollection() : EO_Location_Collection
Return values
EO_Location_Collection

createObject()

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

delete()

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

deleteExtended()

Deletes location from the tree

public static deleteExtended(mixed $primary[, array<string|int, mixed> $additional = array() ]) : DeleteResult
Parameters
$primary : mixed
$additional : array<string|int, mixed> = array()
Tags
throws
ArgumentException
throws
SystemException
throws
NodeNotFoundException
Return values
DeleteResult

getByCode()

Returns location with the specified code.

public static getByCode([string $code = '' ][, mixed $parameters = array() ]) : Result
Parameters
$code : string = ''

location code to search for

$parameters : mixed = array()
Tags
throws
ArgumentNullException
Return values
Result —

location

getById()

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

getByPrimary()

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

getChildren()

public static getChildren(mixed $primary[, mixed $parameters = array() ]) : mixed
Parameters
$primary : mixed
$parameters : mixed = array()

getCodeValidators()

public static getCodeValidators() : mixed

getCountByFilter()

public static getCountByFilter([mixed $filter = array() ]) : mixed
Parameters
$filter : mixed = array()

getDeepestCommonParent()

public static getDeepestCommonParent([mixed $nodeInfo = array() ][, mixed $parameters = array() ]) : mixed
Parameters
$nodeInfo : mixed = array()
$parameters : mixed = array()

getEntity()

public static getEntity() : EO_Location_Entity
Return values
EO_Location_Entity

getExternalData()

public static getExternalData(mixed $primary[, mixed $parameters = array() ]) : mixed
Parameters
$primary : mixed
$parameters : mixed = array()

getFilePath()

public static getFilePath() : mixed

getList()

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

getListFast()

public static getListFast([mixed $parameters = array() ]) : mixed
Parameters
$parameters : mixed = array()

getMap()

public static getMap() : mixed

getParentTree()

Fetches a chain of parents with their subtrees expanded

public static getParentTree(mixed $primary[, mixed $parameters = array() ][, mixed $behaviour = array('SHOW_CHILDREN' => true, 'START_FROM' => false) ]) : mixed

Available keys in $behaviour SHOW_CHILDREN : if set to true, do return direct ancestors of $primary in the result START_FROM

Parameters
$primary : mixed
$parameters : mixed = array()
$behaviour : mixed = array('SHOW_CHILDREN' => true, 'START_FROM' => false)

getPathToMultipleNodes()

public static getPathToMultipleNodes([mixed $nodeInfo = array() ][, mixed $parameters = array() ][, mixed $behaviour = array('SHOW_LEAF' => true) ]) : mixed
Parameters
$nodeInfo : mixed = array()
$parameters : mixed = array()
$behaviour : mixed = array('SHOW_LEAF' => true)

getPathToNode()

public static getPathToNode(mixed $primary, mixed $parameters[, mixed $behaviour = array('SHOW_LEAF' => true) ]) : mixed
Parameters
$primary : mixed
$parameters : mixed
$behaviour : mixed = array('SHOW_LEAF' => true)

getPathToNodeByCode()

Fetches a parent chain of a specified node, using its code

public static getPathToNodeByCode(mixed $code, mixed $parameters[, mixed $behaviour = array('SHOW_LEAF' => true) ]) : mixed

Available keys in $behaviour SHOW_LEAF : if set to true, return node itself in the result

Parameters
$code : mixed
$parameters : mixed
$behaviour : mixed = array('SHOW_LEAF' => true)

getPathToNodeByCondition()

Fetches a parent chain of a specified node

public static getPathToNodeByCondition(mixed $filter[, mixed $parameters = array() ][, mixed $behaviour = array('SHOW_LEAF' => true) ]) : mixed

Available keys in $behaviour SHOW_LEAF : if set to true, return node itself in the result

Parameters
$filter : mixed
$parameters : mixed = array()
$behaviour : mixed = array('SHOW_LEAF' => true)
Tags
access

private

getSubTree()

Fetches a set of items which form sub-tree of a given node

public static getSubTree(mixed $primary[, mixed $parameters = array() ]) : mixed
Parameters
$primary : mixed
$parameters : mixed = array()

getSubtreeRangeSqlForNode()

This method is for internal use only. It may be changed without any notification further, or even mystically disappear.

public static getSubtreeRangeSqlForNode(mixed $primary[, mixed $node = array() ]) : mixed
Parameters
$primary : mixed
$node : mixed = array()
Tags
access

private

getTableName()

public static getTableName() : mixed

mergeRelationsFromTemporalTable()

public static mergeRelationsFromTemporalTable(mixed $temporalTabName[, mixed $additinalFlds = array() ][, mixed $fldMap = array() ]) : mixed
Parameters
$temporalTabName : mixed
$additinalFlds : mixed = array()
$fldMap : mixed = array()

query()

public static query() : EO_Location_Query
Return values
EO_Location_Query

resetLegacyPath()

public static resetLegacyPath() : mixed

resort()

public static resort([mixed $dontCareEvents = false ]) : mixed
Parameters
$dontCareEvents : mixed = false

update()

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

updateExtended()

Updates an existed location

public static updateExtended(int $primary, array<string|int, mixed> $data[, array<string|int, mixed> $additional = array() ]) : UpdateResult
Parameters
$primary : int

location primary key of a element being updated

$data : array<string|int, mixed>

new data to set. Additional data keys could be passed:

  • NAME string[] : update name string for specified location
  • EXTERNAL string[] : update external data records for specified location
$additional : array<string|int, mixed> = array()

an additional behaviour flags:

  • REBALANCE boolean (default: true) : do rebalancing after add
Return values
UpdateResult —

the result of update operation

wakeUpCollection()

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

wakeUpObject()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results