Bitrix API

BaseComponent extends Base uses VisibilityConfig

AbstractYes

Table of Contents

Constants

TOOLBAR_SETTINGS_BUTTON_ID  = 'crm-toolbar-settings-button'

Methods

__construct()  : mixed
addJsRouter()  : void
addToolbar()  : void
addTopPanel()  : void
createClient()  : Result
Creates new contact or company with $entityData.
createEntity()  : mixed
deleteEntity()  : mixed
getEntityID()  : mixed
getEntityTypeID()  : mixed
getErrorByCode()  : Error
Getting once error with the necessary code.
getErrorMessages()  : array<string|int, string>
getErrors()  : array<string|int, Error>
Getting array of errors.
getInstance()  : mixed
getMode()  : mixed
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
prepareMultifieldsForSave()  : mixed
setEntityID()  : mixed
showFirstErrorViaInfoErrorUI()  : void
updateClient()  : Result
updateEntity()  : mixed

Constants

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

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()

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>

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>

prepareMultifieldsForSave()

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

setEntityID()

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

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