Bitrix API

SectionType extends ElementType

Class SectionType

Table of Contents

Constants

DISPLAY_CHECKBOX  = 'CHECKBOX'
DISPLAY_DIALOG  = 'DIALOG'
DISPLAY_LIST  = 'LIST'
DISPLAY_UI  = 'UI'
MODE_EDIT  = 'main.edit'
MODE_VIEW  = 'main.view'
RENDER_COMPONENT  = 'bitrix:iblock.field.section'
USER_TYPE_ID  = 'iblock_section'

Methods

checkFields()  : array<string|int, mixed>
Validate field value.
getAdminListEditHTML()  : string
getAdminListEditHtmlMulty()  : string
Returns multiply user field control for admin grid row.
getAdminListViewHtml()  : string
getDbColumnType()  : string
Returns database column type for user field.
getDefaultValue()  : array<string|int, mixed>|string
Returns default value, if exists.
getDescription()  : array<string|int, mixed>
getEditFormHtml()  : string
getEmptyCaption()  : string
Returns description for empty user field value.
getEnumList()  : void
Returns values list.
getFieldValue()  : array<string|int, mixed>|int|string|null
Returns current value for user field in form.
getFilterData()  : array<string|int, mixed>
Returns values for filter.
getFilterHtml()  : string
getGroupActionData()  : array<string|int, mixed>
Returns values for old format group action.
getList()  : bool|CDBResult
Returns iblock elements with filter.
getPublicEdit()  : string
getPublicText()  : string
getPublicView()  : string
getSettingsHtml()  : string
getUserTypeDescription()  : array<string|int, mixed>
isMandatorySupported()  : bool
isMultiplicitySupported()  : bool
onBeforeSave()  : array<string|int, mixed>|string|int|null
Modify user field value before save to database.
onSearchIndex()  : string
Prepare data for search.
prepareSettings()  : array<string|int, mixed>
Validate user field settings.
renderAdminListEdit()  : string
This function is called when editing property values in the admin part of the site.
renderAdminListView()  : string
This function is called when viewing property values in the admin part of the site.
renderEdit()  : string
This function is called when editing property values in the public part of the site.
renderEditForm()  : string
This function is called when editing user field settings.
renderField()  : string
Render user field control.
renderFilter()  : string
This function is called when show filter for user field.
renderSettings()  : string
This function is called when the property settings form is displayed.
renderText()  : string
renderView()  : string
This function is called when the property values are displayed in the public part of the site.

Constants

DISPLAY_CHECKBOX

public mixed DISPLAY_CHECKBOX = 'CHECKBOX'

DISPLAY_DIALOG

public mixed DISPLAY_DIALOG = 'DIALOG'

MODE_EDIT

public mixed MODE_EDIT = 'main.edit'

MODE_VIEW

public mixed MODE_VIEW = 'main.view'

RENDER_COMPONENT

public mixed RENDER_COMPONENT = 'bitrix:iblock.field.section'

USER_TYPE_ID

public mixed USER_TYPE_ID = 'iblock_section'

Methods

checkFields()

Validate field value.

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

User field description.

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

Current value.

Return values
array<string|int, mixed>

getAdminListEditHTML()

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

getAdminListEditHtmlMulty()

Returns multiply user field control for admin grid row.

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

User field description.

$additionalParameters : array<string|int, mixed>|null

Options, values, etc.

Return values
string

getAdminListViewHtml()

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

getDbColumnType()

Returns database column type for user field.

public static getDbColumnType() : string
Return values
string

getDefaultValue()

Returns default value, if exists.

public static getDefaultValue(array<string|int, mixed> $userField[, array<string|int, mixed> $additionalParameters = [] ]) : array<string|int, mixed>|string
Parameters
$userField : array<string|int, mixed>

User field description.

$additionalParameters : array<string|int, mixed> = []

Optional parameters.

Return values
array<string|int, mixed>|string

getDescription()

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

getEditFormHtml()

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

getEmptyCaption()

Returns description for empty user field value.

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

User field description.

Return values
string

getEnumList()

Returns values list.

public static getEnumList(array<string|int, mixed> &$userField[, array<string|int, mixed> $additionalParameters = [] ]) : void
Parameters
$userField : array<string|int, mixed>
$additionalParameters : array<string|int, mixed> = []

getFieldValue()

Returns current value for user field in form.

public static getFieldValue(array<string|int, mixed> $userField[, array<string|int, mixed> $additionalParameters = [] ]) : array<string|int, mixed>|int|string|null
Parameters
$userField : array<string|int, mixed>

User field description.

$additionalParameters : array<string|int, mixed> = []

Options, values, etc.

Return values
array<string|int, mixed>|int|string|null

getFilterData()

Returns values for filter.

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

User field description.

$additionalParameters : array<string|int, mixed>

Options, values, etc.

Return values
array<string|int, mixed>

getFilterHtml()

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

getGroupActionData()

Returns values for old format group action.

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

User field description.

$additionalParameters : array<string|int, mixed>|null

Optional parameters.

Return values
array<string|int, mixed>

getList()

Returns iblock elements with filter.

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

getPublicEdit()

public static getPublicEdit(array<string|int, mixed> $userField[, array<string|int, mixed>|null $additionalParameters = [] ]) : string
Parameters
$userField : array<string|int, mixed>
$additionalParameters : array<string|int, mixed>|null = []
Return values
string

getPublicText()

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

getPublicView()

public static getPublicView(array<string|int, mixed> $userField[, array<string|int, mixed>|null $additionalParameters = [] ]) : string
Parameters
$userField : array<string|int, mixed>
$additionalParameters : array<string|int, mixed>|null = []
Return values
string

getSettingsHtml()

public static getSettingsHtml(array<string|int, mixed>|bool $userField, array<string|int, mixed>|null $additionalParameters, mixed $varsFromForm) : string
Parameters
$userField : array<string|int, mixed>|bool
$additionalParameters : array<string|int, mixed>|null
$varsFromForm : mixed
Return values
string

getUserTypeDescription()

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

isMandatorySupported()

public static isMandatorySupported() : bool
Return values
bool

isMultiplicitySupported()

public static isMultiplicitySupported() : bool
Return values
bool

onBeforeSave()

Modify user field value before save to database.

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

User field description.

$value : array<string|int, mixed>|string|int|false|null

Raw user field value.

Return values
array<string|int, mixed>|string|int|null

onSearchIndex()

Prepare data for search.

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

prepareSettings()

Validate user field settings.

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

User field description.

Return values
array<string|int, mixed>

renderAdminListEdit()

This function is called when editing property values in the admin part of the site.

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

User field description.

$additionalParameters : array<string|int, mixed>|null

Options, values, etc.

Return values
string

renderAdminListView()

This function is called when viewing property values in the admin part of the site.

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

User field description.

$additionalParameters : array<string|int, mixed>|null

Options, values, etc.

Return values
string

renderEdit()

This function is called when editing property values in the public part of the site.

public static renderEdit(array<string|int, mixed> $userField[, array<string|int, mixed>|null $additionalParameters = [] ]) : string
Parameters
$userField : array<string|int, mixed>

User field description.

$additionalParameters : array<string|int, mixed>|null = []

Options, values, etc.

Return values
string

renderEditForm()

This function is called when editing user field settings.

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

User field description.

$additionalParameters : array<string|int, mixed>|null

Options, values, etc.

Return values
string

renderField()

Render user field control.

public static renderField(array<string|int, mixed> $userField[, array<string|int, mixed>|null $additionalParameters = [] ]) : string
Parameters
$userField : array<string|int, mixed>

User field description.

$additionalParameters : array<string|int, mixed>|null = []

Options, values, etc.

Return values
string

renderFilter()

This function is called when show filter for user field.

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

User field description.

$additionalParameters : array<string|int, mixed>|null

Options, values, etc.

Return values
string

renderSettings()

This function is called when the property settings form is displayed.

public static renderSettings(bool|array<string|int, mixed> $userField, array<string|int, mixed>|null $additionalParameters, mixed $varsFromForm) : string

Returns html for embedding in a 2-column table in the form usertype_edit.php

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

An array describing the field. For a new (not yet added field - false)

$additionalParameters : array<string|int, mixed>|null

Array of advanced parameters

$varsFromForm : mixed
Return values
string —

HTML

renderText()

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

renderView()

This function is called when the property values are displayed in the public part of the site.

public static renderView(array<string|int, mixed> $userField[, array<string|int, mixed>|null $additionalParameters = [] ]) : string
Parameters
$userField : array<string|int, mixed>

User field description.

$additionalParameters : array<string|int, mixed>|null = []

Options, values, etc.

Return values
string 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results