Bitrix API

UrlPreviewUserType

Table of Contents

Methods

checkfields()  : array<string|int, mixed>
Checks for current user's access to $value.
getAdminListEditHTML()  : string
getAdminListEditHTMLMulty()  : string
getAdminListViewHTML()  : string
getDBColumnType()  : string
Return internal type for storing url_preview user type values
getEditFormHTML()  : string
getFilterHTML()  : string
getPublicViewHTML()  : string
getSettingsHTML()  : string
getUserTypeDescription()  : array<string|int, mixed>
Returns url_preview user type description
onBeforeSave()  : int
Hook executed before saving url_preview user type value. Checks and removes signature of the $value.
prepareSettings()  : array<string|int, mixed>

Methods

checkfields()

Checks for current user's access to $value.

public static checkfields(array<string|int, mixed> $userField, int $value) : array<string|int, mixed>
Parameters
$userField : array<string|int, mixed>

Array containing parameters of the user field.

$value : int
Return values
array<string|int, mixed>

getAdminListEditHTML()

public static getAdminListEditHTML(array<string|int, mixed> $userField, array<string|int, mixed> $htmlControl) : string
Parameters
$userField : array<string|int, mixed>

Array containing parameters of the user field.

$htmlControl : array<string|int, mixed>
Return values
string

getAdminListEditHTMLMulty()

public static getAdminListEditHTMLMulty(array<string|int, mixed> $userField, array<string|int, mixed> $htmlControl) : string
Parameters
$userField : array<string|int, mixed>

Array containing parameters of the user field.

$htmlControl : array<string|int, mixed>
Return values
string

getAdminListViewHTML()

public static getAdminListViewHTML(array<string|int, mixed> $userField, array<string|int, mixed> $htmlControl) : string
Parameters
$userField : array<string|int, mixed>

Array containing parameters of the user field.

$htmlControl : array<string|int, mixed>
Return values
string

getDBColumnType()

Return internal type for storing url_preview user type values

public static getDBColumnType(array<string|int, mixed> $userField) : string
Parameters
$userField : array<string|int, mixed>

Array containing parameters of the user field.

Return values
string

getEditFormHTML()

public static getEditFormHTML(array<string|int, mixed> $userField, array<string|int, mixed> $htmlControl) : string
Parameters
$userField : array<string|int, mixed>

Array containing parameters of the user field.

$htmlControl : array<string|int, mixed>
Return values
string

getFilterHTML()

public static getFilterHTML(array<string|int, mixed> $userField, array<string|int, mixed> $htmlControl) : string
Parameters
$userField : array<string|int, mixed>

Array containing parameters of the user field.

$htmlControl : array<string|int, mixed>
Return values
string

getPublicViewHTML()

public static getPublicViewHTML(array<string|int, mixed> $userField, mixed $id[, array<string|int, mixed> $params = "" ][, mixed $settings = array() ]) : string
Parameters
$userField : array<string|int, mixed>

Array containing parameters of the user field.

$id : mixed
$params : array<string|int, mixed> = ""
$settings : mixed = array()
Return values
string

getSettingsHTML()

public static getSettingsHTML(array<string|int, mixed> $userField, mixed $htmlControl, mixed $varsFromForm) : string
Parameters
$userField : array<string|int, mixed>

Array containing parameters of the user field.

$htmlControl : mixed
$varsFromForm : mixed
Return values
string

getUserTypeDescription()

Returns url_preview user type description

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

onBeforeSave()

Hook executed before saving url_preview user type value. Checks and removes signature of the $value.

public static onBeforeSave(array<string|int, mixed> $userField, string $value) : int

If signature is correct, checks current user's access to $value.

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

Array containing parameters of the user field.

$value : string

Signed value of the user field.

Return values
int —

Unsigned value of the user field, or null in case of errors.

prepareSettings()

public static prepareSettings(array<string|int, mixed> $userField) : array<string|int, mixed>
Parameters
$userField : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results