Bitrix API

Settings

Table of Contents

Methods

__construct()  : mixed
Settings constructor.
disableActivitiesAutocompletion()  : self
disableAfterSaveActions()  : $this
Disables 'after save' Actions procession in an Operation
disableAllChecks()  : $this
Disable all checks that will be performed in an Operation
disableAutomation()  : $this
Disables robots automation execution in an Operation
disableBeforeSaveActions()  : $this
Disables 'before save' Actions procession in an Operation
disableBizProc()  : $this
Disables business processes execution in an Operation
disableCheckAccess()  : $this
Disables user permission check in an Operation
disableCheckFields()  : self
disableCheckLimits()  : $this
Disables limits check.
disableCheckRequiredUserFields()  : self
disableCheckWorkflows()  : $this
Disables checking running workflows during category change.
disableDeferredCleaning()  : self
disableDuplicatesIndexInvalidation()  : self
disableFieldProcession()  : $this
Disables fields business-logic procession in an Operation
disableSaveToHistory()  : $this
Disables registration of an Operation launch in history (EventHistory, Timeline)
disableSaveToTimeline()  : self
enableActivitiesAutocompletion()  : self
enableAfterSaveActions()  : $this
Enables 'after save' Actions procession in an Operation
enableAutomation()  : $this
Enables robots automation execution in an Operation
enableBeforeSaveActions()  : $this
Enables 'before save' Actions procession in an Operation
enableBizProc()  : $this
Enables business processes execution in an Operation
enableCheckAccess()  : $this
Enables user permission check in an Operation
enableCheckFields()  : self
enableCheckLimits()  : $this
Enables limits check.
enableCheckRequiredUserFields()  : self
enableCheckWorkflows()  : $this
Enables checking running workflows during category change.
enableDeferredCleaning()  : self
enableDuplicatesIndexInvalidation()  : self
enableFieldProcession()  : $this
Enables fields business logic procession in an Operation
enableSaveToHistory()  : $this
Enables registration of an Operation launch in history (EventHistory, Timeline)
enableSaveToTimeline()  : self
excludeItemsFromTimelineRelationEventsRegistration()  : $this
Exclude the specified items from being registered in this item's timeline as bound item
getActivityProvidersToAutocomplete()  : array<string|int, string>
Returns ids of activity providers that should be autocompleted.
getContext()  : Context
Returns a Context object, that is used in an Operation
getItemsThatExcludedFromTimelineRelationEventsRegistration()  : array<string|int, ItemIdentifier>
Get items that are excluded from being registered in this item's timeline as bound item
getStatisticsFacade()  : OperationFacade|null
isActivitiesAutocompletionEnabled()  : bool
isAfterSaveActionsEnabled()  : bool
Returns true if 'after save' Actions procession is enabled
isAutomationEnabled()  : bool
Returns true if robots automation execution is enabled
isBeforeSaveActionsEnabled()  : bool
Returns true if 'before save' Actions procession is enabled
isBizProcEnabled()  : bool
Returns true if business processes execution is enabled
isCheckAccessEnabled()  : bool
Returns true if user permission check is enabled
isCheckFieldsEnabled()  : bool
isCheckLimitsEnabled()  : bool
Returns true if limits check is enabled
isCheckRequiredUserFields()  : bool
isCheckWorkflowsEnabled()  : bool
Return true if checking running workflows during category change enabled.
isDeferredCleaningEnabled()  : bool
isDuplicatesIndexInvalidationEnabled()  : bool
isFieldProcessionEnabled()  : bool
Returns true if fields business-logic procession is enabled
isSaveToHistoryEnabled()  : bool
Returns true if registration of an Operation launch in history is enabled
isSaveToTimelineEnabled()  : bool
setActivityProvidersToAutocomplete()  : $this
setContext()  : $this
Sets a Context object, that is used in an Operation
setStatisticsFacade()  : self

Methods

__construct()

Settings constructor.

public __construct(Context $context) : mixed
Parameters
$context : Context

disableActivitiesAutocompletion()

public disableActivitiesAutocompletion() : self
Return values
self

disableAfterSaveActions()

Disables 'after save' Actions procession in an Operation

public disableAfterSaveActions() : $this
Tags
see
Operation::addAction
Return values
$this

disableAllChecks()

Disable all checks that will be performed in an Operation

public disableAllChecks() : $this
Return values
$this

disableAutomation()

Disables robots automation execution in an Operation

public disableAutomation() : $this
Return values
$this

disableBeforeSaveActions()

Disables 'before save' Actions procession in an Operation

public disableBeforeSaveActions() : $this
Tags
see
Operation::addAction
Return values
$this

disableBizProc()

Disables business processes execution in an Operation

public disableBizProc() : $this
Return values
$this

disableCheckAccess()

Disables user permission check in an Operation

public disableCheckAccess() : $this
Return values
$this

disableCheckFields()

public disableCheckFields() : self
Return values
self

disableCheckLimits()

Disables limits check.

public disableCheckLimits() : $this
Return values
$this

disableCheckRequiredUserFields()

public disableCheckRequiredUserFields() : self
Return values
self

disableCheckWorkflows()

Disables checking running workflows during category change.

public disableCheckWorkflows() : $this
Return values
$this

disableDeferredCleaning()

public disableDeferredCleaning() : self
Return values
self

disableDuplicatesIndexInvalidation()

public disableDuplicatesIndexInvalidation() : self
Return values
self

disableFieldProcession()

Disables fields business-logic procession in an Operation

public disableFieldProcession() : $this
Return values
$this

disableSaveToHistory()

Disables registration of an Operation launch in history (EventHistory, Timeline)

public disableSaveToHistory() : $this
Return values
$this

disableSaveToTimeline()

public disableSaveToTimeline() : self
Return values
self

enableActivitiesAutocompletion()

public enableActivitiesAutocompletion() : self
Return values
self

enableAfterSaveActions()

Enables 'after save' Actions procession in an Operation

public enableAfterSaveActions() : $this
Tags
see
Operation::addAction
Return values
$this

enableAutomation()

Enables robots automation execution in an Operation

public enableAutomation() : $this
Return values
$this

enableBeforeSaveActions()

Enables 'before save' Actions procession in an Operation

public enableBeforeSaveActions() : $this
Tags
see
Operation::addAction
Return values
$this

enableBizProc()

Enables business processes execution in an Operation

public enableBizProc() : $this
Return values
$this

enableCheckAccess()

Enables user permission check in an Operation

public enableCheckAccess() : $this
Return values
$this

enableCheckFields()

public enableCheckFields() : self
Return values
self

enableCheckLimits()

Enables limits check.

public enableCheckLimits() : $this
Return values
$this

enableCheckRequiredUserFields()

public enableCheckRequiredUserFields() : self
Return values
self

enableCheckWorkflows()

Enables checking running workflows during category change.

public enableCheckWorkflows() : $this
Return values
$this

enableDeferredCleaning()

public enableDeferredCleaning() : self
Return values
self

enableDuplicatesIndexInvalidation()

public enableDuplicatesIndexInvalidation() : self
Return values
self

enableFieldProcession()

Enables fields business logic procession in an Operation

public enableFieldProcession() : $this
Return values
$this

enableSaveToHistory()

Enables registration of an Operation launch in history (EventHistory, Timeline)

public enableSaveToHistory() : $this
Return values
$this

enableSaveToTimeline()

public enableSaveToTimeline() : self
Return values
self

excludeItemsFromTimelineRelationEventsRegistration()

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

public excludeItemsFromTimelineRelationEventsRegistration(array<string|int, ItemIdentifier> $itemsToExclude) : $this
Parameters
$itemsToExclude : array<string|int, ItemIdentifier>
Return values
$this

getActivityProvidersToAutocomplete()

Returns ids of activity providers that should be autocompleted.

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

Empty array as result means that no activities will be completed.

Return values
array<string|int, string>

getContext()

Returns a Context object, that is used in an Operation

public getContext() : Context
Return values
Context

getItemsThatExcludedFromTimelineRelationEventsRegistration()

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

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

isActivitiesAutocompletionEnabled()

public isActivitiesAutocompletionEnabled() : bool
Return values
bool

isAfterSaveActionsEnabled()

Returns true if 'after save' Actions procession is enabled

public isAfterSaveActionsEnabled() : bool
Return values
bool

isAutomationEnabled()

Returns true if robots automation execution is enabled

public isAutomationEnabled() : bool
Return values
bool

isBeforeSaveActionsEnabled()

Returns true if 'before save' Actions procession is enabled

public isBeforeSaveActionsEnabled() : bool
Return values
bool

isBizProcEnabled()

Returns true if business processes execution is enabled

public isBizProcEnabled() : bool
Return values
bool

isCheckAccessEnabled()

Returns true if user permission check is enabled

public isCheckAccessEnabled() : bool
Return values
bool

isCheckFieldsEnabled()

public isCheckFieldsEnabled() : bool
Return values
bool

isCheckLimitsEnabled()

Returns true if limits check is enabled

public isCheckLimitsEnabled() : bool
Return values
bool

isCheckRequiredUserFields()

public isCheckRequiredUserFields() : bool
Return values
bool

isCheckWorkflowsEnabled()

Return true if checking running workflows during category change enabled.

public isCheckWorkflowsEnabled() : bool
Return values
bool

isDeferredCleaningEnabled()

public isDeferredCleaningEnabled() : bool
Return values
bool

isDuplicatesIndexInvalidationEnabled()

public isDuplicatesIndexInvalidationEnabled() : bool
Return values
bool

isFieldProcessionEnabled()

Returns true if fields business-logic procession is enabled

public isFieldProcessionEnabled() : bool
Return values
bool

isSaveToHistoryEnabled()

Returns true if registration of an Operation launch in history is enabled

public isSaveToHistoryEnabled() : bool
Return values
bool

isSaveToTimelineEnabled()

public isSaveToTimelineEnabled() : bool
Return values
bool

setActivityProvidersToAutocomplete()

public setActivityProvidersToAutocomplete(array<string|int, string> $providersIds) : $this
Parameters
$providersIds : array<string|int, string>
Return values
$this

setContext()

Sets a Context object, that is used in an Operation

public setContext(Context $context) : $this
Parameters
$context : Context
Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results