Bitrix API

AddressType extends BaseType

Class AddressType

Table of Contents

Constants

BITRIX24_RESTRICTION  = 100
BITRIX24_RESTRICTION_CODE  = 'uf_address'
MODE_EDIT  = 'main.edit'
MODE_VIEW  = 'main.view'
RENDER_COMPONENT  = 'bitrix:fileman.field.address'
USER_TYPE_ID  = 'address'

Methods

canUseMap()  : bool
checkFields()  : array<string|int, mixed>
checkRestriction()  : bool
getAddressFieldsByValue()  : array<string|int, mixed>|null
getAdminListEditHTML()  : string
getAdminListViewHtml()  : string
getApiKey()  : string|null
getApiKeyHint()  : string
getDbColumnType()  : string
getDefaultValue()  : mixed
getDescription()  : array<string|int, mixed>
getEditFormHtml()  : string
getFilterData()  : array<string|int, mixed>
getFilterHtml()  : string
getPublicEdit()  : string
getPublicText()  : string
getPublicView()  : string
getSettingsHtml()  : string
getTrialHint()  : array<string|int, mixed>|null
getUserTypeDescription()  : array<string|int, mixed>
isMandatorySupported()  : bool
isMultiplicitySupported()  : bool
isRawValue()  : bool
onBeforeSave()  : string|null
onBeforeSaveAll()  : mixed
onSearchIndex()  : string|null
parseValue()  : array<string|int, mixed>
prepareSettings()  : array<string|int, mixed>
renderAdminListEdit()  : string
This function is called when the property value is displayed in the list of items in edit mode.
renderAdminListView()  : string
This function is called when the property value is displayed in the list of elements.
renderEdit()  : string
This function is called when editing property values in the public part of the site.
renderEditForm()  : string
This function is called when the form for editing the property value is displayed, for example, here /bitrix/admin/iblock_section_edit.php
renderField()  : string
renderFilter()  : string
This function is called when the filter is displayed on the list page.
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.
useRestriction()  : bool

Constants

BITRIX24_RESTRICTION

public mixed BITRIX24_RESTRICTION = 100

BITRIX24_RESTRICTION_CODE

public mixed BITRIX24_RESTRICTION_CODE = 'uf_address'

MODE_EDIT

public mixed MODE_EDIT = 'main.edit'

MODE_VIEW

public mixed MODE_VIEW = 'main.view'

RENDER_COMPONENT

public mixed RENDER_COMPONENT = 'bitrix:fileman.field.address'

Methods

canUseMap()

public static canUseMap() : bool
Return values
bool

checkFields()

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

checkRestriction()

public static checkRestriction() : bool
Return values
bool

getAddressFieldsByValue()

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

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

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

getApiKey()

public static getApiKey() : string|null
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
LoaderException
Return values
string|null

getApiKeyHint()

public static getApiKeyHint() : string
Tags
throws
ArgumentNullException
throws
ArgumentOutOfRangeException
throws
LoaderException
Return values
string

getDbColumnType()

public static getDbColumnType() : string
Return values
string

getDefaultValue()

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

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

getFilterData()

public static getFilterData(null|array<string|int, mixed> $userField, array<string|int, mixed> $additionalSettings) : array<string|int, mixed>
Parameters
$userField : null|array<string|int, mixed>
$additionalSettings : array<string|int, mixed>
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

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

getTrialHint()

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

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

isRawValue()

public static isRawValue(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

onBeforeSave()

public static onBeforeSave(array<string|int, mixed> $userField, mixed $value) : string|null
Parameters
$userField : array<string|int, mixed>
$value : mixed
Tags
throws
LoaderException
Return values
string|null

onBeforeSaveAll()

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

onSearchIndex()

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

parseValue()

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

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>

renderAdminListEdit()

This function is called when the property value is displayed in the list of items in edit mode.

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

Returns html to embed in a table cell. $AdditionalParameters elements are converted to html safe mode.

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

An array describing the field.

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

An array of controls from the form. Contains the elements NAME and VALUE.

Return values
string —

HTML

renderAdminListView()

This function is called when the property value is displayed in the list of elements.

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

Returns html to embed in a table cell. $AdditionalParameters elements are converted to html safe mode.

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

An array describing the field.

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

An array of controls from the form. Contains the elements NAME and VALUE.

Return values
string —

HTML

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

Returns html. If the class does not provide such a function, then the type manager will call the component specified in the property metadata or system bitrix: system.field.edit

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

An array describing the field.

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

Additional parameters (e.g. context).

Return values
string —

HTML для вывода.

renderEditForm()

This function is called when the form for editing the property value is displayed, for example, here /bitrix/admin/iblock_section_edit.php

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

Returns html for embedding in a table cell in the entity editing form (on the "Advanced Properties" tab).

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

An array describing the field.

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

An array of controls from the form. Contains the elements NAME and VALUE.

Return values
string

renderField()

public static renderField(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

renderFilter()

This function is called when the filter is displayed on the list page.

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

Returns html to embed in a table cell. $additionalParameters elements are html safe.

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

An array describing the field.

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

An array of controls from the form. Contains the elements NAME and VALUE.

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

Returns html. If the class does not provide such a function, then the type manager will call the component specified in the property metadata or system bitrix: system.field.view

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

An array describing the field.

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

Additional parameters (e.g. context).

Return values
string

useRestriction()

public static useRestriction() : bool
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results