Bitrix API

FactoryBased extends BaseComponent implements Controllerable, SupportsEditorProvider uses EditorInitialMode, InitializeAdditionalFieldsData

AbstractYes

Table of Contents

Interfaces

Controllerable
SupportsEditorProvider

Constants

TAB_LISTS_PREFIX  = 'tab_lists_'
TAB_NAME_AUTOMATION  = 'tab_automation'
TAB_NAME_BIZPROC  = 'tab_bizproc'
TAB_NAME_EVENT  = 'tab_event'
TAB_NAME_ORDERS  = 'tab_order'
TAB_NAME_PRODUCTS  = 'tab_products'
TAB_NAME_TREE  = 'tab_tree'
TOOLBAR_SETTINGS_BUTTON_ID  = 'crm-toolbar-settings-button'

Methods

__construct()  : mixed
addJsRouter()  : void
addToolbar()  : void
addTopPanel()  : void
compatibleAction()  : Json|null
configureActions()  : array<string|int, mixed>
createClient()  : Result
Creates new contact or company with $entityData.
createEntity()  : mixed
deleteEntity()  : mixed
enableSearchHistory()  : void
getEditorConfig()  : array<string|int, mixed>
getEditorConfigId()  : string
getEditorEntityConfig()  : array<string|int, mixed>
getEntityID()  : mixed
getEntityTypeID()  : int
getErrorByCode()  : Error
Getting once error with the necessary code.
getErrorMessages()  : array<string|int, string>
getErrors()  : array<string|int, Error>
Getting array of errors.
getInlineEditorEntityConfig()  : array<string|int, mixed>
getInstance()  : mixed
getMode()  : mixed
init()  : void
initializeEditorAdapter()  : void
initializeEditorData()  : void
initializeParams()  : void
loadAction()  : array<string|int, mixed>|null
onPrepareComponentParams()  : array<string|int, mixed>
parseParentIdsFromRequest()  : array<string|int, ItemIdentifier>
prepareEntityDataScheme()  : mixed
prepareEntityFieldVisibilityConfigs()  : array<string|int, mixed>
prepareEntityUserFieldInfos()  : array<string|int, mixed>
Returns user fields description for the editor
prepareEntityUserFields()  : array<string|int, mixed>
Return data from UserFieldTable about user fields of the current entity
prepareFieldInfos()  : array<string|int, mixed>
prepareMultifieldsForSave()  : mixed
saveAction()  : array<string|int, mixed>|null
setCategoryId()  : void
setEntityID()  : void
setEntityTypeID()  : void
showFirstErrorViaInfoErrorUI()  : void
updateClient()  : Result
updateEntity()  : mixed

Constants

TAB_LISTS_PREFIX

public mixed TAB_LISTS_PREFIX = 'tab_lists_'

TAB_NAME_AUTOMATION

public mixed TAB_NAME_AUTOMATION = 'tab_automation'

TAB_NAME_BIZPROC

public mixed TAB_NAME_BIZPROC = 'tab_bizproc'

TAB_NAME_EVENT

public mixed TAB_NAME_EVENT = 'tab_event'

TAB_NAME_ORDERS

public mixed TAB_NAME_ORDERS = 'tab_order'

TAB_NAME_PRODUCTS

public mixed TAB_NAME_PRODUCTS = 'tab_products'

TOOLBAR_SETTINGS_BUTTON_ID

public mixed TOOLBAR_SETTINGS_BUTTON_ID = 'crm-toolbar-settings-button'

Methods

__construct()

public __construct([mixed $component = null ]) : mixed
Parameters
$component : mixed = null

addJsRouter()

public addJsRouter(CBitrixComponentTemplate $template) : void
Parameters
$template : CBitrixComponentTemplate

addToolbar()

public addToolbar(CBitrixComponentTemplate $template) : void
Parameters
$template : CBitrixComponentTemplate

addTopPanel()

public addTopPanel(CBitrixComponentTemplate $template) : void
Parameters
$template : CBitrixComponentTemplate

compatibleAction()

public compatibleAction(int $entityTypeId, int $entityId) : Json|null
Parameters
$entityTypeId : int
$entityId : int
Return values
Json|null

configureActions()

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

createClient()

Creates new contact or company with $entityData.

public static createClient(int $entityTypeID, array<string|int, mixed> $entityData[, array<string|int, mixed> $options = [] ]) : Result

Data in Result

Parameters
$entityTypeID : int
$entityData : array<string|int, mixed>
$options : array<string|int, mixed> = []
Tags
throws
NotSupportedException
Return values
Result

createEntity()

public static createEntity(mixed $entityTypeID, array<string|int, mixed> $entityData[, array<string|int, mixed> $options = array() ]) : mixed
Parameters
$entityTypeID : mixed
$entityData : array<string|int, mixed>
$options : array<string|int, mixed> = array()

deleteEntity()

public static deleteEntity(int $entityTypeID, mixed $entityID[, array<string|int, mixed> $options = array() ]) : mixed
Parameters
$entityTypeID : int
$entityID : mixed
$options : array<string|int, mixed> = array()

enableSearchHistory()

public enableSearchHistory(mixed $enable) : void
Parameters
$enable : mixed

getEditorConfig()

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

getEditorConfigId()

public getEditorConfigId() : string
Return values
string

getEditorEntityConfig()

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

getEntityTypeID()

public getEntityTypeID() : int
Return values
int

getErrorByCode()

Getting once error with the necessary code.

public getErrorByCode(string $code) : Error
Parameters
$code : string

Code of error.

Return values
Error

getErrorMessages()

public getErrorMessages() : array<string|int, string>
Return values
array<string|int, string>

getErrors()

Getting array of errors.

public getErrors() : array<string|int, Error>
Return values
array<string|int, Error>

getInlineEditorEntityConfig()

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

initializeEditorAdapter()

public initializeEditorAdapter() : void

initializeEditorData()

public initializeEditorData() : void

initializeParams()

public initializeParams(array<string|int, mixed> $params) : void
Parameters
$params : array<string|int, mixed>

loadAction()

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

onPrepareComponentParams()

public onPrepareComponentParams(mixed $arParams) : array<string|int, mixed>
Parameters
$arParams : mixed
Return values
array<string|int, mixed>

parseParentIdsFromRequest()

public parseParentIdsFromRequest([Request|null $request = null ]) : array<string|int, ItemIdentifier>
Parameters
$request : Request|null = null
Return values
array<string|int, ItemIdentifier>

prepareEntityDataScheme()

public prepareEntityDataScheme() : mixed

prepareEntityFieldVisibilityConfigs()

public prepareEntityFieldVisibilityConfigs(mixed $entityTypeId) : array<string|int, mixed>
Parameters
$entityTypeId : mixed
Tags
throws
ArgumentException
Return values
array<string|int, mixed>

prepareEntityUserFieldInfos()

Returns user fields description for the editor

public prepareEntityUserFieldInfos() : array<string|int, mixed>
Tags
noinspection

ReturnTypeCanBeDeclaredInspection

Return values
array<string|int, mixed>

prepareEntityUserFields()

Return data from UserFieldTable about user fields of the current entity

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

prepareFieldInfos()

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

prepareMultifieldsForSave()

public static prepareMultifieldsForSave(mixed $entityTypeID, mixed $entityID, array<string|int, mixed> $multifieldData) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$multifieldData : array<string|int, mixed>

saveAction()

public saveAction(array<string|int, mixed> $data) : array<string|int, mixed>|null
Parameters
$data : array<string|int, mixed>
Return values
array<string|int, mixed>|null

setCategoryId()

public setCategoryId(int $categoryId) : void
Parameters
$categoryId : int

setEntityID()

public setEntityID(mixed $entityID) : void
Parameters
$entityID : mixed

setEntityTypeID()

public setEntityTypeID(int $id) : void
Parameters
$id : int

showFirstErrorViaInfoErrorUI()

public showFirstErrorViaInfoErrorUI() : void

updateClient()

public static updateClient(ItemIdentifier $identifier, array<string|int, mixed> $entityData[, array<string|int, mixed> $options = [] ]) : Result
Parameters
$identifier : ItemIdentifier
$entityData : array<string|int, mixed>
$options : array<string|int, mixed> = []
Tags
throws
ArgumentException
throws
NotImplementedException
throws
NotSupportedException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

updateEntity()

public static updateEntity(mixed $entityTypeID, mixed $entityID, array<string|int, mixed> $entityData[, array<string|int, mixed> $options = array() ]) : mixed
Parameters
$entityTypeID : mixed
$entityID : mixed
$entityData : array<string|int, mixed>
$options : array<string|int, mixed> = array() 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results