Bitrix API

Template extends Task

Table of Contents

Methods

addField()  : mixed
cancelCloneValues()  : mixed
checkContainsUFKeys()  : bool
Checks if argument array contains userfield keys
checkFieldExists()  : bool
Checks if a userfield with $code exists for this entity
checkValues()  : Result
Check values of the specified user fields for the specified entity
clearCache()  : mixed
cloneValues()  : Result
deleteField()  : mixed
getClass()  : mixed
getControllerClassByEntityCode()  : string
Solves problem of matching entity code to user field controller class
getDefaultValue()  : mixed
getEntityCode()  : mixed
getField()  : mixed
getFreeFieldName()  : mixed
getScheme()  : mixed
Get user field map for this entity, with optional restoring missing fields
getSysScheme()  : mixed
Get system fields for this entity
getTypes()  : mixed
isFieldExist()  : mixed
isUFKey()  : bool
Check if a given string looks like a user field name
isValueEmpty()  : bool
onAfterUserTypeAdd()  : mixed
OnAfterUserTypeDelete()  : mixed
OnAfterUserTypeUpdate()  : mixed
updateField()  : mixed
updateValues()  : Result
Update values of the specified user fields for the specified entity

Methods

addField()

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

cancelCloneValues()

public cancelCloneValues(mixed $data[, mixed $userId = 0 ]) : mixed
Parameters
$data : mixed
$userId : mixed = 0

checkContainsUFKeys()

Checks if argument array contains userfield keys

public static checkContainsUFKeys(mixed $fields) : bool
Parameters
$fields : mixed
Return values
bool

checkFieldExists()

Checks if a userfield with $code exists for this entity

public static checkFieldExists(mixed $code) : bool
Parameters
$code : mixed
Return values
bool

checkValues()

Check values of the specified user fields for the specified entity

public checkValues(mixed $data[, int $entityId = 0 ][, int $userId = 0 ]) : Result
Parameters
$data : mixed
$entityId : int = 0
$userId : int = 0
Return values
Result

clearCache()

public static clearCache() : mixed

cloneValues()

public cloneValues(mixed $data, UserField $dstUFController[, int $userId = 0 ][, array<string|int, mixed> $parameters = array() ]) : Result
Parameters
$data : mixed
$dstUFController : UserField
$userId : int = 0
$parameters : array<string|int, mixed> = array()
Tags
throws
ArgumentException
Return values
Result

deleteField()

public deleteField(mixed $id) : mixed
Parameters
$id : mixed

getClass()

public static getClass() : mixed

getControllerClassByEntityCode()

Solves problem of matching entity code to user field controller class

public static getControllerClassByEntityCode(mixed $code) : string
Parameters
$code : mixed
Return values
string

getDefaultValue()

public static getDefaultValue(mixed $code[, mixed $userId = false ]) : mixed
Parameters
$code : mixed
$userId : mixed = false

getEntityCode()

public static getEntityCode() : mixed

getField()

public static getField(mixed $id) : mixed
Parameters
$id : mixed

getFreeFieldName()

public static getFreeFieldName() : mixed

getScheme()

Get user field map for this entity, with optional restoring missing fields

public static getScheme([int $entityId = 0 ][, int $userId = 0 ][, string $languageId = LANGUAGE_ID ]) : mixed
Parameters
$entityId : int = 0
$userId : int = 0
$languageId : string = LANGUAGE_ID

getSysScheme()

Get system fields for this entity

public static getSysScheme() : mixed

getTypes()

public static getTypes() : mixed

isFieldExist()

public static isFieldExist(mixed $name) : mixed
Parameters
$name : mixed

isUFKey()

Check if a given string looks like a user field name

public static isUFKey(mixed $key) : bool
Parameters
$key : mixed
Return values
bool

isValueEmpty()

public static isValueEmpty(Collection|string|int|array<string|int, mixed>|null $value) : bool
Parameters
$value : Collection|string|int|array<string|int, mixed>|null
Return values
bool

onAfterUserTypeAdd()

public static onAfterUserTypeAdd(array<string|int, mixed> $field) : mixed
Parameters
$field : array<string|int, mixed>

OnAfterUserTypeDelete()

public static OnAfterUserTypeDelete(array<string|int, mixed> $field, mixed $id) : mixed
Parameters
$field : array<string|int, mixed>
$id : mixed

OnAfterUserTypeUpdate()

public static OnAfterUserTypeUpdate(array<string|int, mixed> $field, mixed $id) : mixed
Parameters
$field : array<string|int, mixed>
$id : mixed

updateField()

public updateField(mixed $id, array<string|int, mixed> $fields) : mixed
Parameters
$id : mixed
$fields : array<string|int, mixed>

updateValues()

Update values of the specified user fields for the specified entity

public updateValues(array<string|int, mixed> $data[, int $entityId = 0 ][, int $userId = 0 ]) : Result
Parameters
$data : array<string|int, mixed>
$entityId : int = 0
$userId : int = 0
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results