Bitrix API

Helper

Table of Contents

Constants

REQUEST_FIELD_NAME  = 'ui_avatar_editor'

Methods

addSystemMask()  : Item|null
getData()  : array<string|int, mixed>|null
getDataFromRequest()  : array<string|int, mixed>|null
getHTMLAttribute()  : mixed
getJson()  : string
getMaskedFile()  : array<string|int, mixed>|null
save()  : int|null
setSystemGroup()  : Group|null

Constants

REQUEST_FIELD_NAME

public mixed REQUEST_FIELD_NAME = 'ui_avatar_editor'

Methods

addSystemMask()

public static addSystemMask(array<string|int, mixed> $file, array<string|int, mixed> $descriptionParams) : Item|null
Parameters
$file : array<string|int, mixed>
$descriptionParams : array<string|int, mixed>
Tags
params

$file ['name' => 'name.png', 'type' => '', 'tmp_name' => '', 'size' => 124]

example

Bitrix\UI\Avatar\Mask\Helper::addSystemMask([ 'name' => 'example.png', 'type' => 'image/png', 'tmp_name' => '', ], [ 'TITLE' => 'Flag', 'DESCRIPTION' => 'This is an example', 'SORT' => 100, ]);

Return values
Item|null

getData()

public static getData(int|null $fileId) : array<string|int, mixed>|null
Parameters
$fileId : int|null
Return values
array<string|int, mixed>|null

getDataFromRequest()

public static getDataFromRequest(string $fieldName[, HttpRequest|null $request = null ]) : array<string|int, mixed>|null

Delete after intranet 23.100.0 will be released

Parameters
$fieldName : string
$request : HttpRequest|null = null
Return values
array<string|int, mixed>|null

getHTMLAttribute()

public static getHTMLAttribute(mixed $fileId) : mixed
Parameters
$fileId : mixed

getJson()

public static getJson(mixed $fileId) : string
Parameters
$fileId : mixed
Return values
string

getMaskedFile()

public static getMaskedFile(string $fieldName[, HttpRequest|null $request = null ]) : array<string|int, mixed>|null
Parameters
$fieldName : string
$request : HttpRequest|null = null
Return values
array<string|int, mixed>|null

save()

public static save(int|null $originalFileId, array<string|int, mixed> $file[, CurrentUser|null $currentUser = null ]) : int|null
Parameters
$originalFileId : int|null
$file : array<string|int, mixed>
$currentUser : CurrentUser|null = null
Return values
int|null

setSystemGroup()

public static setSystemGroup(string $title, string|null $description) : Group|null
Parameters
$title : string
$description : string|null
Return values
Group|null 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results