FolderTable extends ObjectTable
FinalYes
Class FolderTable
DO NOT WRITE ANYTHING BELOW THIS
<<< ORMENTITYANNOTATION
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 = \Bitrix\Disk\Internals\ObjectTable::TYPE_FOLDER
- TYPE_FILE = 3
- TYPE_FOLDER = 2
Methods
- add() : mixed
- changeSyncDateTime() : UpdateResult
- checkFields() : mixed
- className() : string
- createCollection() : EO_Folder_Collection
- createObject() : EO_Folder
- delete() : mixed
- deleteByFilter() : bool
- Deletes rows by filter.
- getAncestors() : ArrayResult|Result
- Get all ancestors by this folder.
- getById() : EO_Folder_Result
- getByPrimary() : EO_Folder_Result
- getChildren() : ArrayResult|Result
- Get direct children.
- getDescendants() : ArrayResult|Result
- Get all descendants by this folder.
- getEntity() : EO_Folder_Entity
- getList() : EO_Folder_Result
- 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() : EO_Folder_Query
- Creates and returns the Query object for the entity
- updateSyncTime() : mixed
- validateCode() : mixed
- validateContentProvider() : mixed
- validateEtag() : mixed
- validateExternalHash() : mixed
- validateName() : mixed
- validateType() : mixed
- validateTypeLogic() : mixed
- validateXmlId() : mixed
- wakeUpCollection() : EO_Folder_Collection
- wakeUpObject() : EO_Folder
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
public
mixed
TYPE
= \Bitrix\Disk\Internals\ObjectTable::TYPE_FOLDER
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>
changeSyncDateTime()
public
static changeSyncDateTime(mixed $primary, DateTime $dateTime) : UpdateResult
Parameters
- $primary : mixed
- $dateTime : DateTime
Return values
UpdateResultcheckFields()
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.
createCollection()
public
static createCollection() : EO_Folder_Collection
Return values
EO_Folder_CollectioncreateObject()
public
static createObject([mixed $setDefaultValues = = 'true' ]) : EO_Folder
Parameters
- $setDefaultValues : mixed = = 'true'
Return values
EO_Folderdelete()
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
Return values
boolgetAncestors()
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
Return values
ArrayResult|ResultgetById()
public
static getById(mixed $id) : EO_Folder_Result
Parameters
- $id : mixed
Return values
EO_Folder_ResultgetByPrimary()
public
static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_Folder_Result
Parameters
- $primary : mixed
- $parameters : array<string|int, mixed> = = '[]'
Return values
EO_Folder_ResultgetChildren()
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
Return values
ArrayResult|ResultgetDescendants()
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
Return values
ArrayResult|ResultgetEntity()
public
static getEntity() : EO_Folder_Entity
Return values
EO_Folder_EntitygetList()
public
static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_Folder_Result
Parameters
- $parameters : array<string|int, mixed> = = '[]'
Return values
EO_Folder_ResultgetListOfDeletedTypes()
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
Return values
ArrayResult|ResultgetTableName()
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
UpdateResultonAfterAdd()
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() : EO_Folder_Query
Return values
EO_Folder_QueryupdateSyncTime()
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
validateType()
public
static validateType() : mixed
validateTypeLogic()
public
static validateTypeLogic(mixed $value) : mixed
Parameters
- $value : mixed
validateXmlId()
public
static validateXmlId() : mixed
wakeUpCollection()
public
static wakeUpCollection(mixed $rows) : EO_Folder_Collection
Parameters
- $rows : mixed
Return values
EO_Folder_CollectionwakeUpObject()
public
static wakeUpObject(mixed $row) : EO_Folder
Parameters
- $row : mixed