Bitrix API

CheckListTable extends DataManager

Class CheckListTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION

Table of Contents

Methods

add()  : mixed
createCollection()  : EO_CheckList_Collection
createObject()  : EO_CheckList
deleteByCheckListsIds()  : mixed
deleteByTemplateId()  : mixed
Removes all checklist's items for given template.
getById()  : EO_CheckList_Result
getByPrimary()  : EO_CheckList_Result
getClass()  : static
getEntity()  : EO_CheckList_Entity
getList()  : EO_CheckList_Result
getListByTemplateDependency()  : mixed
getMap()  : array<string|int, mixed>
Returns entity map definition.
getSortColumnName()  : string
getTableName()  : string
Returns DB table name for entity.
getUfId()  : mixed
moveAfterItem()  : mixed
Move item after other item.
query()  : EO_CheckList_Query
update()  : mixed
updateForTemplate()  : array<string|int, mixed>
Update list items for a certain template: add new, update passed and delete absent.
wakeUpCollection()  : EO_CheckList_Collection
wakeUpObject()  : EO_CheckList

Methods

add()

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

createCollection()

public static createCollection() : EO_CheckList_Collection
Return values
EO_CheckList_Collection

createObject()

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

deleteByCheckListsIds()

public static deleteByCheckListsIds(string $ids) : mixed
Parameters
$ids : string
  • string of type (1,2,...,7)

deleteByTemplateId()

Removes all checklist's items for given template.

public static deleteByTemplateId(int $templateId) : mixed

This function is low-level, i.e. it disrespects any events\callbacks

Parameters
$templateId : int
Tags
throws
ArgumentException

getById()

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

getByPrimary()

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

getClass()

public static getClass() : static
Return values
static

getEntity()

public static getEntity() : EO_CheckList_Entity
Return values
EO_CheckList_Entity

getList()

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

getListByTemplateDependency()

public static getListByTemplateDependency(mixed $templateId, mixed $parameters) : mixed
Parameters
$templateId : mixed
$parameters : mixed

getMap()

Returns entity map definition.

public static getMap() : array<string|int, mixed>
Return values
array<string|int, mixed>

getSortColumnName()

public static getSortColumnName() : string
Return values
string

getTableName()

Returns DB table name for entity.

public static getTableName() : string
Return values
string

moveAfterItem()

Move item after other item.

public static moveAfterItem(mixed $templateId, int $selectedItemId, int $insertAfterItemId) : mixed

This function is low-level, i.e. it disrespects any events\callbacks.

Parameters
$templateId : mixed
$selectedItemId : int
$insertAfterItemId : int
Tags
throws
ArgumentException

query()

public static query() : EO_CheckList_Query
Return values
EO_CheckList_Query

update()

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

updateForTemplate()

Update list items for a certain template: add new, update passed and delete absent.

public static updateForTemplate(int $templateId[, array<string|int, mixed> $items = array() ]) : array<string|int, mixed>

This function is low-level, i.e. it disrespects any events\callbacks

Parameters
$templateId : int
$items : array<string|int, mixed> = array()
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

wakeUpCollection()

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

wakeUpObject()

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

        
On this page

Search results