Bitrix API

CustomType

Table of Contents

Constants

MAX_ITEM_COUNT  = 50

Methods

add()  : int
Add new entry.
delete()  : void
Delete entry by ID.
eraseUserFields()  : void
Remove all user fields those are belong to specified activity type entry.
exists()  : bool
Check if entry already exists.
get()  : array<string|int, mixed>|null
Retrieve entry by ID.
getAll()  : array<string|int, mixed>
Get all entries
getCount()  : int
Get total quantity
getFieldsInfo()  : array<string|int, mixed>
Get metadata fields.
getJavaScriptInfos()  : array<string|int, mixed>
Prepare JavaScript infos
getList()  : Result
Get entry list
getUserFieldTypes()  : mixed
hasDependencies()  : bool
Check if exist activities are bound to spacified type ID.
prepareUserFieldEntityID()  : string
Prepare User field entity ID.
update()  : void
Update entry fields.

Constants

Methods

add()

Add new entry.

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

Fields.

Tags
throws
AddException
Return values
int

delete()

Delete entry by ID.

public static delete(int $ID) : void
Parameters
$ID : int

Entry ID.

Tags
throws
DeleteException

eraseUserFields()

Remove all user fields those are belong to specified activity type entry.

public static eraseUserFields(int $ID) : void
Parameters
$ID : int

Actiity type entry ID (must be greater than 0).

exists()

Check if entry already exists.

public static exists(int $ID) : bool
Parameters
$ID : int

Entry ID.

Tags
throws
ArgumentException
Return values
bool

get()

Retrieve entry by ID.

public static get(int $ID) : array<string|int, mixed>|null
Parameters
$ID : int

Entry ID.

Return values
array<string|int, mixed>|null

getAll()

Get all entries

public static getAll([array<string|int, mixed> $sort = null ]) : array<string|int, mixed>
Parameters
$sort : array<string|int, mixed> = null

Sorting params.

Tags
throws
ArgumentException
Return values
array<string|int, mixed>

getCount()

Get total quantity

public static getCount() : int
Return values
int

getFieldsInfo()

Get metadata fields.

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

getJavaScriptInfos()

Prepare JavaScript infos

public static getJavaScriptInfos([array<string|int, mixed> $IDs = null ][, mixed $encode = false ]) : array<string|int, mixed>
Parameters
$IDs : array<string|int, mixed> = null

Entry IDs to add.

$encode : mixed = false
Return values
array<string|int, mixed>

getList()

Get entry list

public static getList(array<string|int, mixed> $params) : Result
Parameters
$params : array<string|int, mixed>

List params.

Tags
throws
ArgumentException
Return values
Result

getUserFieldTypes()

public static getUserFieldTypes() : mixed

hasDependencies()

Check if exist activities are bound to spacified type ID.

public static hasDependencies(int $ID) : bool
Parameters
$ID : int

Entry ID.

Return values
bool

prepareUserFieldEntityID()

Prepare User field entity ID.

public static prepareUserFieldEntityID(int $ID) : string
Parameters
$ID : int

Entry ID.

Return values
string

update()

Update entry fields.

public static update(int $ID, array<string|int, mixed> $fields) : void
Parameters
$ID : int

Entry ID.

$fields : array<string|int, mixed>

Entry fields.

Tags
throws
UpdateException 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results