Bitrix API

EditorAdapter uses VisibilityConfig

Constants

CONTEXT_PARENT_ID = 'PARENT_ID'
CONTEXT_PARENT_TYPE_ID = 'PARENT_TYPE_ID'
CONTEXT_PARENT_TYPE_NAME = 'PARENT_TYPE_NAME'
CONTROLLER_PRODUCT_LIST = 'PRODUCT_LIST'
DATA_FILES = 'DISK_FILES'
FIELD_ACCOUNT_OPPORTUNITY = 'OPPORTUNITY_ACCOUNT_WITH_CURRENCY'
FIELD_BANK_DETAIL_ID = 'BANK_DETAIL_ID'
FIELD_CLIENT = 'CLIENT'
FIELD_CLIENT_DATA_NAME = 'CLIENT_DATA'
FIELD_FILES = 'FILES'
FIELD_MY_COMPANY_BANK_DETAIL_ID = 'MC_BANK_DETAIL_ID'
FIELD_MY_COMPANY_DATA_INFO = 'MYCOMPANY_ID_INFO'
FIELD_MY_COMPANY_DATA_NAME = 'MYCOMPANY_ID_DATA'
FIELD_MY_COMPANY_REQUISITE_ID = 'MC_REQUISITE_ID'
FIELD_OPPORTUNITY = 'OPPORTUNITY_WITH_CURRENCY'
FIELD_PARENT_PREFIX = 'PARENT_ID_'
FIELD_PRODUCT_ROW_SUMMARY = 'PRODUCT_ROW_SUMMARY'
FIELD_REQUISITE_BINDING = 'REQUISITE_BINDING'
FIELD_REQUISITE_ID = 'REQUISITE_ID'
FIELD_UTM = 'UTM'
LAST_COMPANY_INFOS = 'LAST_COMPANY_INFOS'
LAST_CONTACT_INFOS = 'LAST_CONTACT_INFOS'
LAST_MYCOMPANY_INFOS = 'LAST_MYCOMPANY_INFOS'

Methods

__construct() : mixed
addEntityData() : $this: Add additional $value by $name to entityData.
addEntityField() : $this: Add additional $field to entityFields.
addParentFieldsEntityData() : void: Adds data about parent fields from $entityFields into $entityData, where $identifiers is array of parent identifiers.
addParentItemToContextIfFound() : bool: Find data about parent item in request.
combineConfigIntoOneSection() : array<string|int, mixed>
enableSearchHistory() : EditorAdapter
extractRequisiteBinding() : array<string|int, mixed>: Try to find requisites and bank details binding from $entityData, having $resultData with possible added requisites identifiers.
fillParentFieldFromContextEnrichedData() : bool: Try to find data about parent item in data.
formProductRowData() : array<string|int, mixed>: Returns formed product info from $product for display it in product summary list block
getAdditionalField() : array<string|int, mixed>|null
getClientDataFromEmbeddedEditor() : Result: Parses $json with data from Client field from editor, saves data about company and contacts from it.
getClientEntityData() : array<string|int, mixed>: Return processed before entityData for Client field.
getClientField() : array<string|int, mixed>: Return field description for CLIENT field (with embedded editor)
getContext() : array<string|int, mixed>
getDataForClientField() : array<string|int, mixed>: Return entityField for Client field.
getEntityData() : array<string|int, mixed>: Return processed entityData.
getEntityFields() : array<string|int, mixed>: Return processed entityData.
getInstance() : mixed
getLastMyCompanyInfos() : array<string|int, mixed>: Return entityData for last myCompany elements.
getLocationFieldDescription() : array<string|int, mixed>: Return entityField for Location field.
getLocationFieldHtml() : string|null: Return html for location field.
getMyCompanyDataFromEmbeddedEditor() : Result: Parses $json with data from myCompany field with embedded editor, saves data about myCompany from it.
getMyCompanyFieldWithEditor() : array<string|int, mixed>: Return field description for MYCOMPANY_ID field with embedded editor.
getOpportunityField() : array<string|int, mixed>: Return entityField for Opportunity field.
getParentField() : array<string|int, mixed>: Return parent field description.
getParentFieldName() : string
getParentFieldsInfo() : array<string|int, mixed>: Return all parent fields description for $childEntityTypeId.
getProductListController() : array<string|int, mixed>: Return description for product_list editor controller.
getProductRowProxyController() : array<string|int, mixed>: Return description for product_row_proxy editor controller.
getProductRowSummaryDataByItem() : array<string|int, mixed>: Returns products summary data from item to display it in product row summary block
getProductRowSummaryField() : array<string|int, mixed>: Return entityField for product_row_summary field.
getSrcItemProductsEntityData() : array<string|int, array<string|int, mixed>>|null: Returns products entity data, that was received from a source item If the editor is not in @see ComponentMode::CONVERSION mode or if products are empty, returns null
getUtmEntityData() : string: Return entityData for UTM field.
getUtmField() : array<string|int, mixed>: Return entityField for UTM field.
hasData() : bool: Return true if method processByItem has been invoked.
isProductListEnabled() : bool: Return true if new products list enabled.
markFieldsAsRequired() : array<string|int, mixed>
prepareCrmEntityData() : array<string|int, mixed>|null
prepareEntityFieldVisibilityConfigs() : array<string|int, mixed>
prepareEntityUserFields() : array<string|int, mixed>: Generates entityField of the editor for $userFields with $visibilityConfig on item with $entityTypeId and $entityId.
processByItem() : $this: Process information on $item that can be placed on $stages with $componentParameters.
saveClientData() : Result: Saves data with clients from editor.
saveMyCompanyDataFromEmbeddedEditor() : Result: Saves data about my company from embedded editor.
saveProductsData() : Result: Saves data about products from interface.
setContext() : void

CONTEXT_PARENT_ID


    public
        mixed
    CONTEXT_PARENT_ID
    = 'PARENT_ID'

CONTEXT_PARENT_TYPE_ID


    public
        mixed
    CONTEXT_PARENT_TYPE_ID
    = 'PARENT_TYPE_ID'

CONTEXT_PARENT_TYPE_NAME


    public
        mixed
    CONTEXT_PARENT_TYPE_NAME
    = 'PARENT_TYPE_NAME'

CONTROLLER_PRODUCT_LIST


    public
        mixed
    CONTROLLER_PRODUCT_LIST
    = 'PRODUCT_LIST'

DATA_FILES


    public
        mixed
    DATA_FILES
    = 'DISK_FILES'

FIELD_ACCOUNT_OPPORTUNITY


    public
        mixed
    FIELD_ACCOUNT_OPPORTUNITY
    = 'OPPORTUNITY_ACCOUNT_WITH_CURRENCY'

FIELD_BANK_DETAIL_ID


    public
        mixed
    FIELD_BANK_DETAIL_ID
    = 'BANK_DETAIL_ID'

FIELD_CLIENT


    public
        mixed
    FIELD_CLIENT
    = 'CLIENT'

FIELD_CLIENT_DATA_NAME


    public
        mixed
    FIELD_CLIENT_DATA_NAME
    = 'CLIENT_DATA'

FIELD_FILES


    public
        mixed
    FIELD_FILES
    = 'FILES'

FIELD_MY_COMPANY_BANK_DETAIL_ID


    public
        mixed
    FIELD_MY_COMPANY_BANK_DETAIL_ID
    = 'MC_BANK_DETAIL_ID'

FIELD_MY_COMPANY_DATA_INFO


    public
        mixed
    FIELD_MY_COMPANY_DATA_INFO
    = 'MYCOMPANY_ID_INFO'

FIELD_MY_COMPANY_DATA_NAME


    public
        mixed
    FIELD_MY_COMPANY_DATA_NAME
    = 'MYCOMPANY_ID_DATA'

FIELD_MY_COMPANY_REQUISITE_ID


    public
        mixed
    FIELD_MY_COMPANY_REQUISITE_ID
    = 'MC_REQUISITE_ID'

FIELD_OPPORTUNITY


    public
        mixed
    FIELD_OPPORTUNITY
    = 'OPPORTUNITY_WITH_CURRENCY'

FIELD_PARENT_PREFIX


    public
        mixed
    FIELD_PARENT_PREFIX
    = 'PARENT_ID_'

FIELD_PRODUCT_ROW_SUMMARY


    public
        mixed
    FIELD_PRODUCT_ROW_SUMMARY
    = 'PRODUCT_ROW_SUMMARY'

FIELD_REQUISITE_BINDING


    public
        mixed
    FIELD_REQUISITE_BINDING
    = 'REQUISITE_BINDING'

FIELD_REQUISITE_ID


    public
        mixed
    FIELD_REQUISITE_ID
    = 'REQUISITE_ID'

FIELD_UTM


    public
        mixed
    FIELD_UTM
    = 'UTM'

LAST_COMPANY_INFOS


    public
        mixed
    LAST_COMPANY_INFOS
    = 'LAST_COMPANY_INFOS'

LAST_CONTACT_INFOS


    public
        mixed
    LAST_CONTACT_INFOS
    = 'LAST_CONTACT_INFOS'

LAST_MYCOMPANY_INFOS


    public
        mixed
    LAST_MYCOMPANY_INFOS
    = 'LAST_MYCOMPANY_INFOS'

__construct()


    public
                    __construct(Collection $fieldsCollection[, array<string|int, mixed> $dependantFieldsMap = [] ]) : mixed

Parameters

$fieldsCollection : Collection
$dependantFieldsMap : array<string|int, mixed> = []

addEntityData()

Add additional $value by $name to entityData.


    public
                    addEntityData(mixed $name, mixed $value) : $this

If processByItem has not been invoked - throws InvalidOperationException.

Parameters

$name : mixed
$value : mixed

Return values

$this

addEntityField()

Add additional $field to entityFields.


    public
                    addEntityField(array<string|int, mixed> $field) : $this

Parameters

$field : array<string|int, mixed>

Return values

$this

addParentFieldsEntityData()

Adds data about parent fields from $entityFields into $entityData, where $identifiers is array of parent identifiers.


    public
                    addParentFieldsEntityData(array<string|int, ItemIdentifier> $identifiers, array<string|int, mixed> $entityFields, array<string|int, mixed> &$entityData) : void

Parameters

$identifiers : array<string|int, ItemIdentifier>
$entityFields : array<string|int, mixed>
$entityData : array<string|int, mixed>

addParentItemToContextIfFound()

Find data about parent item in request.


    public
            static        addParentItemToContextIfFound(array<string|int, mixed> &$context[, Request|null $request = null ]) : bool

If found - add data about it to context.

Parameters

$context : array<string|int, mixed>
$request : Request|null = null

Return values

bool

combineConfigIntoOneSection()


    public
            static        combineConfigIntoOneSection(array<string|int, mixed> $entityConfig[, string $title = null ]) : array<string|int, mixed>

Parameters

$entityConfig : array<string|int, mixed>
$title : string = null

Return values

array<string|int, mixed>

enableSearchHistory()


    public
                    enableSearchHistory(bool $state) : EditorAdapter

Parameters

$state : bool

Return values

EditorAdapter

extractRequisiteBinding()

Try to find requisites and bank details binding from $entityData, having $resultData with possible added requisites identifiers.


    public
                    extractRequisiteBinding(array<string|int, mixed> $entityData, array<string|int, mixed> $resultData, array<string|int, mixed> $fieldNames) : array<string|int, mixed>

Parameters

$entityData : array<string|int, mixed>
$resultData : array<string|int, mixed>
$fieldNames : array<string|int, mixed>

Return values

array<string|int, mixed>

fillParentFieldFromContextEnrichedData()

Try to find data about parent item in data.


    public
            static        fillParentFieldFromContextEnrichedData(array<string|int, mixed> &$data) : bool

If found and appropriate field is not passed - then it fills from context data.

Parameters

$data : array<string|int, mixed>

Return values

bool

formProductRowData()

Returns formed product info from $product for display it in product summary list block


    public
            static        formProductRowData(ProductRow $product, string $currencyId[, bool $checkTaxes = false ]) : array<string|int, mixed>

Parameters

$product : ProductRow
$currencyId : string
$checkTaxes : bool = false

Return values

array<string|int, mixed>

getAdditionalField()


    public
                    getAdditionalField(string $fieldName) : array<string|int, mixed>|null

Parameters

$fieldName : string

Return values

array<string|int, mixed>|null

getClientDataFromEmbeddedEditor()

Parses $json with data from Client field from editor, saves data about company and contacts from it.


    public
                    getClientDataFromEmbeddedEditor(string $json) : Result

Return information about new field values, processed entities and requisiteBindings.

Parameters

$json : string

Return values

Result

getClientEntityData()

Return processed before entityData for Client field.


    public
                    getClientEntityData() : array<string|int, mixed>

If processByItem has not been invoked - throws InvalidOperationException.

Return values

array<string|int, mixed>

getClientField()

Return field description for CLIENT field (with embedded editor)


    public
            static        getClientField(string $title[, string|null $fieldName = self::FIELD_CLIENT ][, string|null $fieldDataName = self::FIELD_CLIENT_DATA_NAME ][, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>

Parameters

$title : string
$fieldName : string|null = self::FIELD_CLIENT
$fieldDataName : string|null = self::FIELD_CLIENT_DATA_NAME
$options : array<string|int, mixed> = []

Return values

array<string|int, mixed>

getContext()


    public
                    getContext() : array<string|int, mixed>

Return values

array<string|int, mixed>

getDataForClientField()

Return entityField for Client field.


    public
                    getDataForClientField(int $clientEntityTypeId, int $clientEntityId[, bool $isEditRequisiteDataRequired = true ]) : array<string|int, mixed>

Parameters

$clientEntityTypeId : int
$clientEntityId : int
$isEditRequisiteDataRequired : bool = true

Return values

array<string|int, mixed>

getEntityData()

Return processed entityData.


    public
                    getEntityData() : array<string|int, mixed>

If processByItem has not been invoked - throws InvalidOperationException.

Return values

array<string|int, mixed>

getEntityFields()

Return processed entityData.


    public
                    getEntityFields() : array<string|int, mixed>

If processByItem has not been invoked - throws InvalidOperationException.

Return values

array<string|int, mixed>

getInstance()


    public
            static        getInstance() : mixed

getLastMyCompanyInfos()

Return entityData for last myCompany elements.


    public
                    getLastMyCompanyInfos() : array<string|int, mixed>

Return values

array<string|int, mixed>

getLocationFieldDescription()

Return entityField for Location field.


    public
            static        getLocationFieldDescription(Field $field) : array<string|int, mixed>

Parameters

$field : Field

Return values

array<string|int, mixed>

getLocationFieldHtml()

Return html for location field.


    public
            static        getLocationFieldHtml(Item $item, string $fieldName) : string|null

Parameters

$item : Item
$fieldName : string

Return values

string|null

getMyCompanyDataFromEmbeddedEditor()

Parses $json with data from myCompany field with embedded editor, saves data about myCompany from it.


    public
                    getMyCompanyDataFromEmbeddedEditor(string $json[, bool $checkPermissions = true ]) : Result

Return information about new field value and myCompany requisite bindings.

Parameters

$json : string
$checkPermissions : bool = true

Return values

Result

getMyCompanyFieldWithEditor()

Return field description for MYCOMPANY_ID field with embedded editor.


    public
            static        getMyCompanyFieldWithEditor([array<string|int, mixed> $description = [] ]) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed>

getOpportunityField()

Return entityField for Opportunity field.


    public
            static        getOpportunityField(string $title[, string|null $fieldName = null ][, bool $isPaymentsEnabled = false ]) : array<string|int, mixed>

Parameters

$title : string
$fieldName : string|null = null
$isPaymentsEnabled : bool = false

Return values

array<string|int, mixed>

getParentField()

Return parent field description.


    public
            static        getParentField(string $title, int $parentEntityTypeId[, string|null $context = null ]) : array<string|int, mixed>

Parameters

$title : string
$parentEntityTypeId : int
$context : string|null = null

Return values

array<string|int, mixed>

getParentFieldName()


    public
            static        getParentFieldName(int $parentEntityTypeId) : string

Parameters

$parentEntityTypeId : int

Return values

string

getParentFieldsInfo()

Return all parent fields description for $childEntityTypeId.


    public
                    getParentFieldsInfo(int $childEntityTypeId[, string|null $context = EntitySelector::CONTEXT ]) : array<string|int, mixed>

Parameters

$childEntityTypeId : int
$context : string|null = EntitySelector::CONTEXT

Return values

array<string|int, mixed>

getProductListController()

Return description for product_list editor controller.


    public
            static        getProductListController(string $productListId, string $currencyId[, string|null $fieldName = self::CONTROLLER_PRODUCT_LIST ]) : array<string|int, mixed>

Parameters

$productListId : string
$currencyId : string
$fieldName : string|null = self::CONTROLLER_PRODUCT_LIST

Return values

array<string|int, mixed>

getProductRowProxyController()

Return description for product_row_proxy editor controller.


    public
            static        getProductRowProxyController(string $productEditorId[, string|null $fieldName = 'PRODUCT_ROW_PROXY' ]) : array<string|int, mixed>

Parameters

$productEditorId : string
$fieldName : string|null = 'PRODUCT_ROW_PROXY'

Return values

array<string|int, mixed>

getProductRowSummaryDataByItem()

Returns products summary data from item to display it in product row summary block


    public
                    getProductRowSummaryDataByItem(Item $item[, int $mode = ComponentMode::VIEW ]) : array<string|int, mixed>

Parameters

$item : Item
$mode : int = ComponentMode::VIEW

Return values

array<string|int, mixed>

getProductRowSummaryField()

Return entityField for product_row_summary field.


    public
            static        getProductRowSummaryField(string $title[, string|null $fieldName = null ]) : array<string|int, mixed>

Parameters

$title : string
$fieldName : string|null = null

Return values

array<string|int, mixed>

getSrcItemProductsEntityData()

Returns products entity data, that was received from a source item If the editor is not in @see ComponentMode::CONVERSION mode or if products are empty, returns null


    public
                    getSrcItemProductsEntityData() : array<string|int, array<string|int, mixed>>|null

Return values

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

getUtmEntityData()

Return entityData for UTM field.


    public
            static        getUtmEntityData(Item $item) : string

Parameters

$item : Item

Return values

string

getUtmField()

Return entityField for UTM field.


    public
            static        getUtmField(string $title[, string|null $fieldName = null ]) : array<string|int, mixed>

Parameters

$title : string
$fieldName : string|null = null

Return values

array<string|int, mixed>

hasData()

Return true if method processByItem has been invoked.


    public
                    hasData() : bool

Return values

bool

isProductListEnabled()

Return true if new products list enabled.


    public
            static        isProductListEnabled() : bool

Return values

bool

markFieldsAsRequired()


    public
            static        markFieldsAsRequired(array<string|int, mixed> $entityFields, array<string|int, mixed> $requiredFieldNames) : array<string|int, mixed>

Parameters

$entityFields : array<string|int, mixed>
$requiredFieldNames : array<string|int, mixed>

Return values

array<string|int, mixed>

prepareCrmEntityData()


    public
                    prepareCrmEntityData(array<string|int, mixed> $field, int $entityId[, array<string|int, mixed> $entityRequisiteData = null ]) : array<string|int, mixed>|null

Parameters

$field : array<string|int, mixed>
$entityId : int
$entityRequisiteData : array<string|int, mixed> = null

Return values

array<string|int, mixed>|null

prepareEntityFieldVisibilityConfigs()


    public
                    prepareEntityFieldVisibilityConfigs(mixed $entityTypeId) : array<string|int, mixed>

Parameters

$entityTypeId : mixed

Return values

array<string|int, mixed>

prepareEntityUserFields()

Generates entityField of the editor for $userFields with $visibilityConfig on item with $entityTypeId and $entityId.


    public
            static        prepareEntityUserFields(array<string|int, mixed> $userFields, array<string|int, mixed> $visibilityConfig, int $entityTypeId, int $entityId[, string $fileHandlerUrl = '' ]) : array<string|int, mixed>

Parameters

$userFields : array<string|int, mixed>
$visibilityConfig : array<string|int, mixed>
$entityTypeId : int
$entityId : int
$fileHandlerUrl : string = ''

Return values

array<string|int, mixed>

processByItem()

Process information on $item that can be placed on $stages with $componentParameters.


    public
                    processByItem(Item $item, EO_Status_Collection $stages[, array<string|int, mixed> $componentParameters = [] ]) : $this

This method does not change $item.

Parameters

$item : Item
$stages : EO_Status_Collection
$componentParameters : array<string|int, mixed> = []

Return values

$this

saveClientData()

Saves data with clients from editor.


    public
                    saveClientData(Item $item, string $clientJson) : Result

Parameters

$item : Item

where clients should be bind to.

$clientJson : string

data from editor.

Return values

Result

saveMyCompanyDataFromEmbeddedEditor()

Saves data about my company from embedded editor.


    public
                    saveMyCompanyDataFromEmbeddedEditor(Item $item, string $json) : Result

Parameters

$item : Item
$json : string

Return values

Result

saveProductsData()

Saves data about products from interface.


    public
                    saveProductsData(Item $item, string $productsJson) : Result

Data generated by component crm.entity.product.list.

Parameters

$item : Item
$productsJson : string

Return values

Result

setContext()


    public
                    setContext(array<string|int, mixed> $context) : void

Parameters

$context : array<string|int, mixed>

EditorAdapter uses VisibilityConfig

Table of Contents

Constants

Methods

Constants

CONTEXT_PARENT_ID

CONTEXT_PARENT_TYPE_ID

CONTEXT_PARENT_TYPE_NAME

CONTROLLER_PRODUCT_LIST

DATA_FILES

FIELD_ACCOUNT_OPPORTUNITY

FIELD_BANK_DETAIL_ID

FIELD_CLIENT

FIELD_CLIENT_DATA_NAME

FIELD_FILES

FIELD_MY_COMPANY_BANK_DETAIL_ID

FIELD_MY_COMPANY_DATA_INFO

FIELD_MY_COMPANY_DATA_NAME

FIELD_MY_COMPANY_REQUISITE_ID

FIELD_OPPORTUNITY

FIELD_PARENT_PREFIX

FIELD_PRODUCT_ROW_SUMMARY

FIELD_REQUISITE_BINDING

FIELD_REQUISITE_ID

FIELD_UTM

LAST_COMPANY_INFOS

LAST_CONTACT_INFOS

LAST_MYCOMPANY_INFOS

Methods

__construct()

Parameters

addEntityData()

Parameters

Tags

Return values

addEntityField()

Parameters

Return values

addParentFieldsEntityData()

Parameters

addParentItemToContextIfFound()

Parameters

Return values

combineConfigIntoOneSection()

Parameters

Return values

enableSearchHistory()

Parameters

Return values

extractRequisiteBinding()

Parameters

Return values

fillParentFieldFromContextEnrichedData()

Parameters

Return values

formProductRowData()

Parameters

Return values

getAdditionalField()

Parameters

Return values

getClientDataFromEmbeddedEditor()

Parameters

Return values

getClientEntityData()

Tags

Return values

getClientField()

Parameters

Return values

getContext()

Return values

getDataForClientField()

Parameters

Return values

getEntityData()

Tags

Return values

getEntityFields()

Tags