Граф наследования:LocationTable:

Открытые статические члены
static	getFilePath ()
static	getTableName ()
static	getByCode ($code='', $parameters=array())
static	checkFields (Entity\Result $result, $primary, array $data)
static	add (array $data)
static	addExtended (array $data, array $additional=array())
static	update ($primary, array $data)
static	updateExtended ($primary, array $data, array $additional=array())
static	delete ($primary)
static	deleteExtended ($primary, array $additional=array())
static	getExternalData ($primary, $parameters=array())
static	getPathToNodeByCode ($code, $parameters, $behaviour=array('SHOW_LEAF'=> true))
static	checkNodeIsParentOfNode ($primary, $childPrimary, $behaviour=array('ACCEPT_CODE'=> false, 'CHECK_DIRECT'=> false))
static	resetLegacyPath ()
static	getCodeValidators ()
static	getMap ()
static	getListFast ($parameters=array())
Открытые статические члены унаследованные от Tree
static	getSubtreeRangeSqlForNode ($primary, $node=array())
static	checkIntegrity ()
static	checkNodeIsParentOfNodeById ($primary, $childPrimary, $behaviour=array('CHECK_DIRECT'=> false))
static	resort ($dontCareEvents=false)
static	getPathToNode ($primary, $parameters, $behaviour=array('SHOW_LEAF'=> true))
static	getPathToNodeByCondition ($filter, $parameters=array(), $behaviour=array('SHOW_LEAF'=> true))
static	getPathToMultipleNodes ($nodeInfo=array(), $parameters=array(), $behaviour=array('SHOW_LEAF'=> true))
static	getDeepestCommonParent ($nodeInfo=array(), $parameters=array())
static	getChildren ($primary, $parameters=array())
static	getSubTree ($primary, $parameters=array())
static	getParentTree ($primary, $parameters=array(), $behaviour=array('SHOW_CHILDREN'=> true, 'START_FROM'=> false))
static	mergeRelationsFromTemporalTable ($temporalTabName, $additinalFlds=array(), $fldMap=array())
static	getCountByFilter ($filter=array())

Защищенные статические члены
static	resetLegacy ($typeId)
Защищенные статические члены унаследованные от Tree
static	rebalance ($node, $id)
static	checkNodeIsParentOfNodeByCondition ($parentNodeFilter, $nodeFilter, $behaviour=array('CHECK_DIRECT'=> false))
static	moveSubtree ($primary, $primaryDst)
	PROTECTED.
static	processInsertInstruction (&$data)
static	manageFreeSpace ($right, $length=2, $op=self::SPACE_ADD, $exceptId=false)
static	makeSortSpace ($primary, $direction, $primaryParent, $knownSort=false)
static	walkTreeInDeep ($primary, $edges, &$nodes, $margin, $depth=0, $dontCareEvents=false)
static	applyRestrictions (&$data)
static	getNodeInfo ($primary)
static	getMaxMargin ()
static	checkNodeThrowException ($node)
static	checkNodeIsParentOfNodeByFilters ($parentNodeFilter, $nodeFilter, $behaviour=array('CHECK_DIRECT'=> false))

Дополнительные унаследованные члены
Поля данных унаследованные от Tree
const	SORT_FREE_BEFORE = 1
const	SORT_FREE_AFTER = 2
const	SORT_HOLE_SIZE = 10
const	SORT_HOLE_SIZE_HALF = 5
const	BLOCK_INSERT_MTU = 9999
const	SPACE_ADD = 1
const	SPACE_REMOVE = 2

Подробное описание

Class LocationTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION @method static EO_Location_Query query() @method static EO_Location_Result getByPrimary($primary, array $parameters = []) @method static EO_Location_Result getById($id) @method static EO_Location_Result getList(array $parameters = []) @method static EO_Location_Entity getEntity() @method static \Bitrix\Sale\Location\EO_Location createObject($setDefaultValues = true) @method static \Bitrix\Sale\Location\EO_Location_Collection createCollection() @method static \Bitrix\Sale\Location\EO_Location wakeUpObject($row) @method static \Bitrix\Sale\Location\EO_Location_Collection wakeUpCollection($rows)

См. определение в файле location.php строка 38

Методы

◆ add()

add ( array $data )

static

Переопределяет метод предка Tree.

См. определение в файле location.php строка 133

◆ addExtended()

addExtended	(	array	$data,
		array	$additional = array() )

static

Adds a new location

Аргументы

mixed[] $data 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

Аргументы

mixed[] $additional an additional behaviour flags:

REBALANCE boolean (default: true) : do rebalance after add

Возвращает: \Bitrix\Main\Entity\AddResult the result of add operation

Переопределяет метод предка Tree.

См. определение в файле location.php строка 162

◆ checkFields()

checkFields	(	Entity\Result	$result,
			$primary,
		array	$data )

static

Переопределяет метод предка Tree.

См. определение в файле location.php строка 72

◆ checkNodeIsParentOfNode()

checkNodeIsParentOfNode	(	$primary,
		$childPrimary,
		$behaviour = array('ACCEPT_CODE' => false, 'CHECK_DIRECT' => false) )

static

См. определение в файле location.php строка 383

◆ delete()

delete ( $primary )

static

Переопределяет метод предка Tree.

См. определение в файле location.php строка 298

◆ deleteExtended()

deleteExtended	(		$primary,
		array	$additional = array() )

static

Deletes location from the tree

Аргументы

	$primary
array	$additional

Возвращает: Entity\DeleteResult

Исключения

Main

ArgumentException

Исключения

Main

SystemException

Исключения

Tree

NodeNotFoundException

Переопределяет метод предка Tree.

См. определение в файле location.php строка 312

◆ getByCode()

getByCode	(		$code = '',
			$parameters = array() )

static

Returns location with the specified code.

Аргументы

string $code location code to search for

Исключения

Bitrix

Main\ArgumentNullException

Возвращает: Bitrix\Main\DB\Result location

См. определение в файле location.php строка 59

◆ getCodeValidators()

getCodeValidators ( )

static

См. определение в файле location.php строка 456

◆ getExternalData()

getExternalData	(		$primary,
			$parameters = array() )

static

См. определение в файле location.php строка 356

◆ getFilePath()

getFilePath ( )

static

См. определение в файле location.php строка 40

◆ getListFast()

getListFast ( $parameters = array() )

static

См. определение в файле location.php строка 622

◆ getMap()

getMap ( )

static

См. определение в файле location.php строка 463

◆ getPathToNodeByCode()

getPathToNodeByCode	(	$code,
		$parameters,
		$behaviour = array('SHOW_LEAF' => true) )

static

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

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

См. определение в файле location.php строка 376

◆ getTableName()

getTableName ( )

static

См. определение в файле location.php строка 45

◆ resetLegacy()

resetLegacy ( $typeId )

staticprotected

См. определение в файле location.php строка 211

◆ resetLegacyPath()

resetLegacyPath ( )

static

См. определение в файле location.php строка 394

◆ update()

update	(		$primary,
		array	$data )

static

Переопределяет метод предка Tree.

См. определение в файле location.php строка 218

◆ updateExtended()

updateExtended	(		$primary,
		array	$data,
		array	$additional = array() )

static

Updates an existed location

Аргументы

integer	$primary	location primary key of a element being updated
mixed[]	$data	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

Аргументы

mixed[] $additional an additional behaviour flags:

REBALANCE boolean (default: true) : do rebalancing after add

Возвращает: \Bitrix\Main\Entity\UpdateResult the result of update operation

Переопределяет метод предка Tree.

См. определение в файле location.php строка 247

Объявления и описания членов класса находятся в файле:

C:/bitrix/modules/sale/lib/location/location.php

Открытые статические члены

Защищенные статические члены

Дополнительные унаследованные члены

Подробное описание

Методы

◆ add()

◆ addExtended()

◆ checkFields()

◆ checkNodeIsParentOfNode()

◆ delete()

◆ deleteExtended()

◆ getByCode()

◆ getCodeValidators()

◆ getExternalData()

◆ getFilePath()

◆ getListFast()

◆ getMap()

◆ getPathToNodeByCode()

◆ getTableName()

◆ resetLegacy()

◆ resetLegacyPath()

◆ update()

◆ updateExtended()