Bitrix API

IBlockElementProperty

Table of Contents

Constants

USER_TYPE  = 'ECrm'

Methods

addFilterFields()  : void
Add values in filter.
checkFields()  : array<string|int, mixed>
Check fields before inserting into the database.
convertFromDB()  : mixed
Convert the value of properties suitable format for storage in a database in the format processing.
convertToDB()  : mixed
Convert the property value into a format suitable for storage in a database.
getAdminListViewHTML()  : string
Return html for public view value.
getLength()  : int
Get the length of the value. Checks completion of mandatory.
getPropertyFieldHtml()  : string
The method should return the html display for editing property values in the administrative part.
getPropertyFieldHtmlMulty()  : string
The method should return the html display for editing property multiple values in the administrative part.
getPublicEditHTML()  : string
Return html for public edit value.
getPublicEditHTMLMulty()  : string
Return html for public edit value.
getPublicViewHTML()  : string
Return html for public view value.
getPublicViewHTMLMulty()  : string
Return html for public view value.
getSettingsHTML()  : string
Returns html for show in edit property page.
GetUIEntityEditorProperty()  : mixed
GetUIEntityEditorPropertyEditHtml()  : mixed
GetUIEntityEditorPropertyViewHtml()  : mixed
getUIFilterProperty()  : void
Returns filter field description.
getUserTypeDescription()  : array<string|int, mixed>
Returns property type description.
getValuePrintable()  : string
Get a printable the entity crm.
isUsePrefix()  : mixed
prepareSettings()  : array<string|int, mixed>
Prepare settings for property.

Constants

Methods

addFilterFields()

Add values in filter.

public static addFilterFields(array<string|int, mixed> $property, array<string|int, mixed> $controlSettings, array<string|int, mixed> &$filter, bool &$filtered) : void
Parameters
$property : array<string|int, mixed>

Property data.

$controlSettings : array<string|int, mixed>

Form data.

$filter : array<string|int, mixed>

Filter data.

$filtered : bool

Marker filter.

checkFields()

Check fields before inserting into the database.

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

Property data.

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

An empty array, if no errors.

convertFromDB()

Convert the value of properties suitable format for storage in a database in the format processing.

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

Property data.

$value : mixed

convertToDB()

Convert the property value into a format suitable for storage in a database.

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

Property data.

$value : mixed

getAdminListViewHTML()

Return html for public view value.

public static getAdminListViewHTML(array<string|int, mixed> $property, array<string|int, mixed> $value, array<string|int, mixed> $controlSettings) : string
Parameters
$property : array<string|int, mixed>

Property data.

$value : array<string|int, mixed>

Current value.

$controlSettings : array<string|int, mixed>

Form data.

Return values
string

getLength()

Get the length of the value. Checks completion of mandatory.

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

Property data.

$value : mixed
Return values
int

getPropertyFieldHtml()

The method should return the html display for editing property values in the administrative part.

public static getPropertyFieldHtml(array<string|int, mixed> $property, array<string|int, mixed> $value, array<string|int, mixed> $controlSettings) : string
Parameters
$property : array<string|int, mixed>

Property data.

$value : array<string|int, mixed>

Current value.

$controlSettings : array<string|int, mixed>

Form data.

Return values
string

getPropertyFieldHtmlMulty()

The method should return the html display for editing property multiple values in the administrative part.

public static getPropertyFieldHtmlMulty(array<string|int, mixed> $property, array<string|int, mixed> $value, array<string|int, mixed> $controlSettings) : string
Parameters
$property : array<string|int, mixed>

Property data.

$value : array<string|int, mixed>

Current value.

$controlSettings : array<string|int, mixed>

Form data.

Return values
string

getPublicEditHTML()

Return html for public edit value.

public static getPublicEditHTML(array<string|int, mixed> $property, array<string|int, mixed> $value, array<string|int, mixed> $controlSettings) : string
Parameters
$property : array<string|int, mixed>

Property data.

$value : array<string|int, mixed>

Current value.

$controlSettings : array<string|int, mixed>

Form data.

Return values
string

getPublicEditHTMLMulty()

Return html for public edit value.

public static getPublicEditHTMLMulty(array<string|int, mixed> $property, array<string|int, mixed> $value, array<string|int, mixed> $controlSettings) : string
Parameters
$property : array<string|int, mixed>

Property data.

$value : array<string|int, mixed>

Current value.

$controlSettings : array<string|int, mixed>

Form data.

Return values
string

getPublicViewHTML()

Return html for public view value.

public static getPublicViewHTML(array<string|int, mixed> $property, array<string|int, mixed> $value, array<string|int, mixed> $controlSettings) : string
Parameters
$property : array<string|int, mixed>

Property data.

$value : array<string|int, mixed>

Current value.

$controlSettings : array<string|int, mixed>

Form data.

Return values
string

getPublicViewHTMLMulty()

Return html for public view value.

public static getPublicViewHTMLMulty(array<string|int, mixed> $property, array<string|int, mixed> $value, array<string|int, mixed> $controlSettings) : string
Parameters
$property : array<string|int, mixed>

Property data.

$value : array<string|int, mixed>

Current value.

$controlSettings : array<string|int, mixed>

Form data.

Return values
string

getSettingsHTML()

Returns html for show in edit property page.

public static getSettingsHTML(array<string|int, mixed> $property, array<string|int, mixed> $controlSettings, array<string|int, mixed> &$propertyFields) : string
Parameters
$property : array<string|int, mixed>

Property data.

$controlSettings : array<string|int, mixed>

Form data.

$propertyFields : array<string|int, mixed>

Property fields for edit form.

Return values
string

GetUIEntityEditorProperty()

public static GetUIEntityEditorProperty(mixed $settings, mixed $value) : mixed
Parameters
$settings : mixed
$value : mixed

GetUIEntityEditorPropertyEditHtml()

public static GetUIEntityEditorPropertyEditHtml([array<string|int, mixed> $params = [] ]) : mixed
Parameters
$params : array<string|int, mixed> = []

GetUIEntityEditorPropertyViewHtml()

public static GetUIEntityEditorPropertyViewHtml([array<string|int, mixed> $params = [] ]) : mixed
Parameters
$params : array<string|int, mixed> = []

getUIFilterProperty()

Returns filter field description.

public static getUIFilterProperty(array<string|int, mixed> $property, array<string|int, mixed> $strHTMLControlName, array<string|int, mixed> &$field) : void
Parameters
$property : array<string|int, mixed>
$strHTMLControlName : array<string|int, mixed>
$field : array<string|int, mixed>

getUserTypeDescription()

Returns property type description.

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

getValuePrintable()

Get a printable the entity crm.

public static getValuePrintable(array<string|int, mixed> $property, array<string|int, mixed> $listValue, string $formatSeparator) : string
Parameters
$property : array<string|int, mixed>

Property data.

$listValue : array<string|int, mixed>

List entity id.

$formatSeparator : string

Separator.

Return values
string

isUsePrefix()

public static isUsePrefix(array<string|int, mixed> $property) : mixed
Parameters
$property : array<string|int, mixed>

prepareSettings()

Prepare settings for property.

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

Property data.

Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results