Bitrix API

Import extends Add

Table of Contents

Constants

ACTION_AFTER_SAVE  = 'afterSave'

ACTION_BEFORE_SAVE  = 'beforeSave'

DEFAULT_ACTION_SORT  = 500

ERROR_CODE_ITEM_ADD_ACCESS_DENIED  = 'CRM_ITEM_ADD_ACCESS_DENIED'

ERROR_CODE_ITEM_DELETE_ACCESS_DENIED  = 'CRM_ITEM_DELETE_ACCESS_DENIED'

ERROR_CODE_ITEM_HAS_RUNNING_WORKFLOWS  = 'CRM_ITEM_HAS_RUNNING_WORKFLOWS'

ERROR_CODE_ITEM_IMPORT_ACCESS_DENIED  = 'CRM_ITEM_IMPORT_ACCESS_DENIED'

ERROR_CODE_ITEM_READ_ACCESS_DENIED  = 'CRM_ITEM_READ_ACCESS_DENIED'

ERROR_CODE_ITEM_UPDATE_ACCESS_DENIED  = 'CRM_ITEM_UPDATE_ACCESS_DENIED'

MESSAGE_FIELD_CRATED_TIME_VALUE_IN_FUTURE  = 'CRM_FIELD_CRATED_TIME_VALUE_IN_FUTURE_ERROR'

MESSAGE_FIELD_CRATED_TIME_VALUE_NOT_MONOTONE  = 'CRM_FIELD_CRATED_TIME_VALUE_NOT_MONOTONE_ERROR'

MESSAGE_FIELD_ONLY_ADMIN_CAN_SET  = 'CRM_FIELD_VALUE_ONLY_ADMIN_CAN_SET_ERROR'

MESSAGE_FIELD_VALUE_CAN_NOT_BE_GREATER  = 'CRM_FIELD_VALUE_CAN_NOT_BE_GREATER_ERROR'

Methods

__construct()  : mixed

addAction()  : self

checkAccess()  : Result

checkFields()  : Result

This method checks that user fields filled properly according to their types and settings.

checkRequiredFields()  : Result

Check that required fields are filled.

checkRunningWorkflows()  : Result

Check running workflows and abort operation if needed.

checkSystemFieldsValues()  : Result

disableActivitiesAutocompletion()  : self

disableAfterSaveActions()  : self

disableAllChecks()  : self

disableAutomation()  : self

disableBeforeSaveActions()  : self

disableBizProc()  : self

disableCheckAccess()  : self

disableCheckFields()  : self

disableCheckLimits()  : self

disableCheckRequiredUserFields()  : self

disableCheckWorkflows()  : self

disableDeferredCleaning()  : self

disableDuplicatesIndexInvalidation()  : self

disableFieldProcession()  : self

disableSaveToHistory()  : self

disableSaveToTimeline()  : self

enableActivitiesAutocompletion()  : self

enableAfterSaveActions()  : self

enableAutomation()  : self

enableBeforeSaveActions()  : self

enableBizProc()  : self

enableCheckAccess()  : self

enableCheckFields()  : self

enableCheckLimits()  : self

enableCheckRequiredUserFields()  : self

enableCheckWorkflows()  : self

enableDeferredCleaning()  : self

enableDuplicatesIndexInvalidation()  : self

enableFieldProcession()  : self

enableSaveToHistory()  : self

enableSaveToTimeline()  : self

excludeItemsFromTimelineRelationEventsRegistration()  : $this

Exclude the specified items from being registered in this item's timeline as bound item

exportSettings()  : Settings

Returns an object that describes a configuration of this Operation

getActivityProvidersToAutocomplete()  : array<string|int, string>

Returns ids of activity providers that should be autocompleted.

getContext()  : Context

Returns a Context object from the current settings

getItem()  : Item

getItemBeforeSave()  : Item|null

getItemsThatExcludedFromTimelineRelationEventsRegistration()  : array<string|int, ItemIdentifier>

Get items that are excluded from being registered in this item's timeline as bound item

getRequiredFields()  : array<string|int, mixed>

getStageDependantRequiredFields()  : array<string|int, string>

Returns a list of names of fields that are required by FieldAttributeManager configs.

getStatisticsFacade()  : OperationFacade|null

importSettings()  : $this

Set a new settings object that describes a configuration of this Operation

isActivitiesAutocompletionEnabled()  : bool

isAfterSaveActionsEnabled()  : bool

isAutomationEnabled()  : bool

isBeforeSaveActionsEnabled()  : bool

isBizProcEnabled()  : bool

isCheckAccessEnabled()  : bool

isCheckFieldsEnabled()  : bool

isCheckLimitsEnabled()  : bool

isCheckRequiredUserFields()  : bool

isCheckWorkflowsEnabled()  : bool

isDeferredCleaningEnabled()  : bool

isDuplicatesIndexInvalidationEnabled()  : bool

isFieldProcessionEnabled()  : bool

isItemChanged()  : bool

Return true if item has been changed.

isSaveToHistoryEnabled()  : bool

isSaveToTimelineEnabled()  : bool

launch()  : Result

processFieldsAfterSave()  : Result

processFieldsBeforeSave()  : Result

Invoke Field::process() on each field from $this->fieldsCollection and collect errors.

processFieldsWithPermissions()  : Result

removeAction()  : self

setActivityProvidersToAutocomplete()  : $this

setContext()  : $this

Sets a new Context object to the current settings

setStatisticsFacade()  : self

updateItemFromUpdateEvent()  : void