Bitrix API

Dispatcher

Table of Contents

Methods

__construct()  : mixed
addField()  : mixed
Adds field to the processing list
createField()  : mixed
deleteField()  : mixed
editField()  : mixed
getCreateSignature()  : mixed
getResult()  : array<string|int, mixed>
Returns processing result
getSignature()  : mixed
getSignatureManager()  : SignatureManager
getView()  : IDisplay
Returns current view object
instance()  : Dispatcher
Singleton
setLanguage()  : mixed
Sets current language of fields data
setSignatureManager()  : mixed
setView()  : mixed
Sets current view object
validateField()  : mixed

Methods

addField()

Adds field to the processing list

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

Input array format: array( 'ENTITY_ID' => field's entity code: USER, CRM_CONTACT, etc. Required 'FIELD' => field code. Required 'VALUE' => field value 'ENTITY_VALUE_ID' => field's item id, may be needed for enum type fields 'SIGNATURE' => field's data signature got from \Bitrix\Main\UserField\Dispatcher::getSignature. Required. )

Parameters
$field : array<string|int, mixed>

createField()

public createField(mixed $fieldInfo) : mixed
Parameters
$fieldInfo : mixed

deleteField()

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

editField()

public editField(mixed $fieldInfo) : mixed
Parameters
$fieldInfo : mixed

getCreateSignature()

public getCreateSignature(array<string|int, mixed> $fieldParam) : mixed
Parameters
$fieldParam : array<string|int, mixed>

getResult()

Returns processing result

public getResult() : array<string|int, mixed>

array( 'FIELD' => array( FIELD_NAME => array( 'FIELD' => array(field description)), 'HTML' => field_html, ), ), 'ERROR' => array( list of processing error messages ), 'ASSET' => array( list of js,css,etc needed for field functioning ), );

Return values
array<string|int, mixed>

getSignature()

public getSignature(array<string|int, mixed> $fieldParam) : mixed
Parameters
$fieldParam : array<string|int, mixed>

setLanguage()

Sets current language of fields data

public setLanguage(mixed $languageId) : mixed
Parameters
$languageId : mixed

validateField()

public validateField(mixed $fieldInfo) : mixed
Parameters
$fieldInfo : mixed 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results