Bitrix API

Deal extends Entity

Constants

VIEW_TYPE_EDIT = 'edit'
VIEW_TYPE_VIEW = 'view'

Methods

__construct() : mixed
appendAdditionalData() : void
appendClientData() : void
appendMultiFieldData() : void
appendRelatedEntitiesValues() : array<string|int, mixed>
applyCountersFilter() : void
applySubQueryBasedFilters() : void: Apply filter fields that have to transform to sql query
canAddItemToStage() : bool: Returns true if user with $userPermissions can add item to stage with identifier $stageId.
canUseAllCategories() : bool: Return true if this entity can show elements from all categories
checkReadPermissions() : bool: Returns true if user with $permissions can read item with $id.
checkUpdatePermissions() : bool: Returns true if user with $permissions can update item with $id.
createPullItem() : array<string|int, mixed>
createPullStage() : array<string|int, mixed>
deleteItems() : void
deleteItemsV2() : Result
fillStageTotalSums() : void: Fills 'count', 'total' and 'total_format' keys in $stages.
getAdditionalEditFields() : array<string|int, mixed>: Returns fields for edit in quick form.
getAdditionalSelectFields() : array<string|int, mixed>|array<string|int, string>: Returns additional fields that should be selected to view them in the kanban card.
getAllowStages() : array<string|int, mixed>
getAssignedByFieldName() : string: Returns field name for assigned.
getBaseFields() : array<string|int, mixed>
getCategories() : array<string|int, mixed>: Returns categories to which user with $permissions has access.
getCategoriesWithAddPermissions() : array<string|int, mixed>
getCategoryId() : int: Get current category id.
getCloseDateFieldName() : string|null: Returns field name of the close date.
getColumnId() : string
getConfigurationPlacementUrlCode() : string
getCurrency() : string|null
getCustomPriceFieldName() : string|null: Returns custom field name for price if it is customized.
getCustomSectionCode() : string|null
getDbStageFieldName() : string
getDefaultAdditionalFields() : array<string|int, mixed>
getDisplayedFieldsList() : array<string|int, Field>
getEditorConfigId() : string: Returns string identifier for
getField() : Field|null
getFieldsRestrictions() : array<string|int, mixed>
getFieldsRestrictionsEngine() : string
getFilterFieldNameByEntityTypeName() : string: Returns field name for the filter of this entity by $typeName.
getFilterLazyLoadParams() : array<string|int, mixed>|null
getFilterOptions() : Options
getFilterPresets() : array<string|int, mixed>
getGridFilter() : array<string|int, mixed>
getGridId() : string
getHiddenPriceFormattedText() : string
getInlineEditorParameters() : array<string|int, mixed>|array<string|int, array<string|int, mixed>>: Returns parameters for inline editor in quick form.
getInstance() : Entity|null
getItem() : array<string|int, mixed>|null: Returns data of item by $id.
getItemLastId() : int: Returns last item identifier.
getItems() : CDBResult: Returns result of query for items by $parameters.
getItemsSelect() : array<string|int, mixed>: Returns full select by $additionalFields.
getItemsSelectPreset() : array<string|int, mixed>: Get initial fields to select items
getOwnMultiFieldsClientType() : string|null: Returns type of this entity for multi fields
getPathMarkers() : array<string|int, mixed>
getPermissionParameters() : array<string|int, mixed>: Returns additional permission parameters for the crm.kanban component.
getPopupFields() : array<string|int, mixed>
getPreparedCustomFieldsConfig() : array<string|int, mixed>
getRequiredFieldsByStages() : array<string|int, mixed>: Returns array where key is field name and value - list of stages where this field is required.
getSemanticIds() : array<string|int, mixed>
getSortSettings() : Settings
getStageFieldName() : string: Returns field name in which status id is stored.
getStagesList() : array<string|int, mixed>
getStatusEntityId() : null|string: Get ENTITY_ID identifier to StatusTable.
getTableAlias() : string: Returns table alias.
getTitle() : string
getTypeId() : int: Get integer identifier of the entity.
getTypeInfo() : array<string|int, mixed>: Settings for JS of the kanban
getTypeName() : string: Get string identifier of the entity.
getUrlTemplate() : string
getUserFields() : array<string|int, mixed>: Returns user fields of this entity and their description.
hasClientFields() : bool: Returns true if this entity supports clients fields.
hasOpenedField() : bool: Returns true if items of this entity has "OPENED" field.
hasOwnMultiFields() : bool: Returns true if this entity has own multi fields.
havePermissionToDisplayColumnSum() : bool
initFactory() : void
initFactoryByEntityTypeId() : self
isActivityCountersFilterSupported() : bool: Returns true if this entity has counters field in the filter.
isActivityCountersSupported() : bool: Returns true if this entity has counters.
isCategoriesSupported() : bool: Return true if this entity supports categories
isContactCenterSupported() : bool
isCustomPriceFieldsSupported() : bool: Returns true if this entity supports custom field for price.
isCustomSectionSupported() : bool
isDeleteAfterExclusion() : bool: Returns true if item of this entity should be deleted after exclusion.
isEditorConfigScopeCommon() : bool: Returns true if scope of current editor configuration is common.
isEntitiesLinksInFilterSupported() : bool: Returns true if this entity has entity links in the filter.
isExclusionSupported() : bool: Returns true if this entity supports exclusion.
isInlineEditorSupported() : bool: Returns true if this entity supports quick inline editor in the kanban.
isKanbanSupported() : bool: Return true if this entity supports kanban at all.
isLastActivityEnabled() : bool
isNeedToRunAutomation() : bool: Returns true if automation should be started after updating items of this entity.
isOverdueFilterSupported() : bool: Returns true if this entity has overdue field in the filter.
isRecurringSupported() : bool: Returns true if this entity supports recurring.
isRestPlacementSupported() : bool: Returns true if this entity supports rest placement to kanban.
isSmartActivityNotificationEnabled() : bool
isSmartActivityNotificationSupported() : bool
isStageEmpty() : bool: Returns true if there are no items on the stage.
isTotalPriceSupported() : bool: Returns true if this entity supports a total sum in the kanban columns.
prepareFilter() : void
prepareFilterField() : string: Prepare field name to filter items of this entity.
prepareItemCommonFields() : array<string|int, mixed>: Reformat some entity-specific field names to common names.
prepareItemLastActivity() : array<string, mixed>|null
prepareItemSort() : array<string|int, mixed>
prepareMultipleItemsLastActivity() : array<int, array<string, mixed>>
prepareMultipleItemsPingSettings() : array<string|int, mixed>
removeUserAdditionalSelectFields() : void: Clears settings of current user additional fields for view in kanban card.
resetAdditionalSelectFields() : array<string|int, mixed>|array<string|int, string>: Resets settings of additional fields for view in kanban card.
saveAdditionalFields() : array<string|int, mixed>: Save field settings
setCanEditCommonSettings() : $this: Mark that current user can or not edit common settings.
setCategoryId() : $this: Set current category id to work with.
setCompanyDataProvider() : self
setContactDataProvider() : self
setCurrentSortType() : Result
setCustomSectionCode() : void
setFactory() : self
setGridIdInstance() : self
setItemsAssigned() : Result: Set assigned of items with $ids.
skipClientField() : bool
updateItemsCategory() : Result: Moves items with $ids to the $categoryId.
updateItemsOpened() : Result: Set opened field of items with $ids.
updateItemStage() : Result: Moves item with $id to stage with id $stageId.

VIEW_TYPE_EDIT


    public
        mixed
    VIEW_TYPE_EDIT
    = 'edit'

VIEW_TYPE_VIEW


    public
        mixed
    VIEW_TYPE_VIEW
    = 'view'

__construct()


    public
                    __construct() : mixed

appendAdditionalData()


    public
                    appendAdditionalData(array<string|int, mixed> &$rows) : void

Parameters

$rows : array<string|int, mixed>

appendClientData()


    public
                    appendClientData(array<string|int, mixed> &$items, array<string|int, mixed> $visibleFields) : void

Parameters

$items : array<string|int, mixed>
$visibleFields : array<string|int, mixed>

appendMultiFieldData()


    public
                    appendMultiFieldData(array<string|int, mixed> &$items, array<string|int, mixed> $allowedTypes) : void

Parameters

$items : array<string|int, mixed>
$allowedTypes : array<string|int, mixed>

appendRelatedEntitiesValues()


    public
                    appendRelatedEntitiesValues(array<string|int, mixed> $items, array<string|int, mixed> $selectedFields) : array<string|int, mixed>

Parameters

$items : array<string|int, mixed>
$selectedFields : array<string|int, mixed>

Return values

array<string|int, mixed>

applyCountersFilter()


    public
                    applyCountersFilter(array<string|int, mixed> &$filter, DataProvider $provider) : void

Parameters

$filter : array<string|int, mixed>
$provider : DataProvider

applySubQueryBasedFilters()

Apply filter fields that have to transform to sql query


    public
                    applySubQueryBasedFilters(array<string|int, mixed> &$filter[, string|null $viewMode = null ]) : void

Parameters

$filter : array<string|int, mixed>
$viewMode : string|null = null

canAddItemToStage()

Returns true if user with $userPermissions can add item to stage with identifier $stageId.


    public
                    canAddItemToStage(string $stageId, CCrmPerms $userPermissions[, string $semantics = PhaseSemantics::UNDEFINED ]) : bool

Parameters

$stageId : string
$userPermissions : CCrmPerms
$semantics : string = PhaseSemantics::UNDEFINED

Return values

bool

canUseAllCategories()

Return true if this entity can show elements from all categories


    public
                    canUseAllCategories() : bool

Return values

bool

checkReadPermissions()

Returns true if user with $permissions can read item with $id.


    public
                    checkReadPermissions([int $id = 0 ][, CCrmPerms $permissions = null ]) : bool

Parameters

$id : int = 0
$permissions : CCrmPerms = null

Return values

bool

checkUpdatePermissions()

Returns true if user with $permissions can update item with $id.


    public
                    checkUpdatePermissions(int $id[, CCrmPerms $permissions = null ]) : bool

Parameters

$id : int
$permissions : CCrmPerms = null

Return values

bool

createPullItem()


    public
                    createPullItem([array<string|int, mixed>|null $data = null ][, array<string|int, mixed>|null $params = null ]) : array<string|int, mixed>

Parameters

$data : array<string|int, mixed>|null = null
$params : array<string|int, mixed>|null = null

Return values

array<string|int, mixed>

createPullStage()


    public
                    createPullStage([array<string|int, mixed>|null $fields = null ][, array<string|int, mixed>|null $params = null ]) : array<string|int, mixed>

Parameters

$fields : array<string|int, mixed>|null = null
$params : array<string|int, mixed>|null = null

Return values

array<string|int, mixed>

deleteItems()


    public
                    deleteItems(array<string|int, mixed> $ids[, bool $isIgnore = false ][, CCrmPerms|null $permissions = null ][, array<string|int, mixed> $params = [] ]) : void

since crm 24.0.0. Use deleteItemsV2 Delete items of this entity with $ids.

Parameters

$ids : array<string|int, mixed>
$isIgnore : bool = false
$permissions : CCrmPerms|null = null
$params : array<string|int, mixed> = []

deleteItemsV2()


    public
                    deleteItemsV2(array<string|int, mixed> $ids[, bool $isIgnore = false ][, CCrmPerms $permissions = null ][, array<string|int, mixed> $params = [] ]) : Result

Parameters

$ids : array<string|int, mixed>
$isIgnore : bool = false
$permissions : CCrmPerms = null
$params : array<string|int, mixed> = []

Return values

Result

fillStageTotalSums()

Fills 'count', 'total' and 'total_format' keys in $stages.


    public
                    fillStageTotalSums(array<string|int, mixed> $filter, array<string|int, mixed> $runtime, array<string|int, mixed> &$stages) : void

Parameters

$filter : array<string|int, mixed>
$runtime : array<string|int, mixed>
$stages : array<string|int, mixed>

getAdditionalEditFields()

Returns fields for edit in quick form.


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

Return values

array<string|int, mixed>

getAdditionalSelectFields()

Returns additional fields that should be selected to view them in the kanban card.


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

Return values

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

getAllowStages()


    public
                    getAllowStages([array<string|int, mixed> $filter = [] ]) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed>

getAssignedByFieldName()

Returns field name for assigned.


    public
                    getAssignedByFieldName() : string

Return values

string

getBaseFields()


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

Return values

array<string|int, mixed>

getCategories()

Returns categories to which user with $permissions has access.


    public
                    getCategories(CCrmPerms $permissions) : array<string|int, mixed>

Parameters

$permissions : CCrmPerms

Return values

array<string|int, mixed>

getCategoriesWithAddPermissions()


    public
                    getCategoriesWithAddPermissions(CCrmPerms $permissions) : array<string|int, mixed>

Parameters

$permissions : CCrmPerms

Return values

array<string|int, mixed>

getCategoryId()

Get current category id.


    public
                    getCategoryId() : int

Return values

int

getCloseDateFieldName()

Returns field name of the close date.


    public
                    getCloseDateFieldName() : string|null

Return values

string|null

getColumnId()


    public
                    getColumnId(array<string|int, mixed> $data) : string

Parameters

$data : array<string|int, mixed>

Return values

string

getConfigurationPlacementUrlCode()


    public
                    getConfigurationPlacementUrlCode() : string

Return values

string

getCurrency()


    public
                    getCurrency() : string|null

Return values

string|null

getCustomPriceFieldName()

Returns custom field name for price if it is customized.


    public
                    getCustomPriceFieldName() : string|null

Return values

string|null

getCustomSectionCode()


    public
                    getCustomSectionCode() : string|null

Return values

string|null

getDbStageFieldName()


    public
                    getDbStageFieldName() : string

Return values

string

getDefaultAdditionalFields()


    public
                    getDefaultAdditionalFields(string $viewType) : array<string|int, mixed>

Parameters

$viewType : string

Return values

array<string|int, mixed>

getDisplayedFieldsList()


    public
                    getDisplayedFieldsList([bool $clearCache = false ][, string|null $context = null ]) : array<string|int, Field>

Parameters

$clearCache : bool = false: Clear static cache.
$context : string|null = null

Return values

array<string|int, Field>

getEditorConfigId()

Returns string identifier for


    public
                    getEditorConfigId() : string

Return values

string

getField()


    public
                    getField(string $fieldName) : Field|null

Parameters

$fieldName : string

Return values

Field|null

getFieldsRestrictions()


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

Return values

array<string|int, mixed>

getFieldsRestrictionsEngine()


    public
                    getFieldsRestrictionsEngine() : string

Return values

string

getFilterFieldNameByEntityTypeName()

Returns field name for the filter of this entity by $typeName.


    public
                    getFilterFieldNameByEntityTypeName(string $typeName) : string

Parameters

$typeName : string

Return values

string

getFilterLazyLoadParams()


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

Return values

array<string|int, mixed>|null

getFilterOptions()


    public
                    getFilterOptions() : Options

Return values

Options

getFilterPresets()


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

Return values

array<string|int, mixed>

getGridFilter()


    public
                    getGridFilter([string|null $filterId = null ]) : array<string|int, mixed>

Parameters

$filterId : string|null = null

Return values

array<string|int, mixed>

getGridId()


    public
                    getGridId() : string

Return values

string

getHiddenPriceFormattedText()


    public
                    getHiddenPriceFormattedText(string $currencyFormat) : string

Parameters

$currencyFormat : string

Return values

string

getInlineEditorParameters()

Returns parameters for inline editor in quick form.


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

Return values

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

getInstance()


    public
            static        getInstance(string $entityTypeName[, string $viewMode = ViewMode::MODE_STAGES ]) : Entity|null

Parameters

$entityTypeName : string
$viewMode : string = ViewMode::MODE_STAGES

Return values

Entity|null

getItem()

Returns data of item by $id.


    public
                    getItem(int $id[, array<string|int, mixed> $fieldsToSelect = [] ]) : array<string|int, mixed>|null

Parameters

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

Return values

array<string|int, mixed>|null

getItemLastId()

Returns last item identifier.


    public
                    getItemLastId() : int

Return values

int

getItems()

Returns result of query for items by $parameters.


    public
                    getItems(array<string|int, mixed> $parameters) : CDBResult

Parameters

$parameters : array<string|int, mixed>

Return values

CDBResult

getItemsSelect()

Returns full select by $additionalFields.


    public
                    getItemsSelect(array<string|int, mixed> $additionalFields) : array<string|int, mixed>

Parameters

$additionalFields : array<string|int, mixed>

Return values

array<string|int, mixed>

getItemsSelectPreset()

Get initial fields to select items


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

Return values

array<string|int, mixed>

getOwnMultiFieldsClientType()

Returns type of this entity for multi fields


    public
                    getOwnMultiFieldsClientType() : string|null

Return values

string|null

getPathMarkers()


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

Return values

array<string|int, mixed>

getPermissionParameters()

Returns additional permission parameters for the crm.kanban component.


    public
                    getPermissionParameters(CCrmPerms $permissions) : array<string|int, mixed>

Parameters

$permissions : CCrmPerms

Return values

array<string|int, mixed>

getPopupFields()


    public
                    getPopupFields(string $viewType) : array<string|int, mixed>

Parameters

$viewType : string

Return values

array<string|int, mixed>

getPreparedCustomFieldsConfig()


    public
                    getPreparedCustomFieldsConfig(string $viewType[, array<string|int, mixed> $selectedFields = [] ]) : array<string|int, mixed>

Parameters

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

Return values

array<string|int, mixed>

getRequiredFieldsByStages()

Returns array where key is field name and value - list of stages where this field is required.


    public
                    getRequiredFieldsByStages(array<string|int, mixed> $stages) : array<string|int, mixed>

Parameters

$stages : array<string|int, mixed>

Return values

array<string|int, mixed>

getSemanticIds()


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

Return values

array<string|int, mixed>

getSortSettings()


    public
                    getSortSettings() : Settings

Return values

Settings

getStageFieldName()

Returns field name in which status id is stored.


    public
                    getStageFieldName() : string

Return values

string

getStagesList()


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

Return values

array<string|int, mixed>

getStatusEntityId()

Get ENTITY_ID identifier to StatusTable.


    public
                    getStatusEntityId() : null|string

Return values

null|string

getTableAlias()

Returns table alias.


    public
                    getTableAlias() : string

Return values

string

getTitle()


    public
                    getTitle() : string

Return values

string

getTypeId()

Get integer identifier of the entity.


    public
                    getTypeId() : int

Return values

int

getTypeInfo()

Settings for JS of the kanban


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

Return values

array<string|int, mixed>

getTypeName()

Get string identifier of the entity.


    public
                    getTypeName() : string

Return values

string

getUrlTemplate()


    public
                    getUrlTemplate() : string

Return values

string

getUserFields()

Returns user fields of this entity and their description.


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

Return values

array<string|int, mixed>

hasClientFields()

Returns true if this entity supports clients fields.


    public
                    hasClientFields() : bool

Return values

bool

hasOpenedField()

Returns true if items of this entity has "OPENED" field.


    public
                    hasOpenedField() : bool

Return values

bool

hasOwnMultiFields()

Returns true if this entity has own multi fields.


    public
                    hasOwnMultiFields() : bool

Return values

bool

havePermissionToDisplayColumnSum()


    public
                    havePermissionToDisplayColumnSum(string $stageId, CCrmPerms $userPermissions) : bool

Parameters

$stageId : string
$userPermissions : CCrmPerms

Return values

bool

initFactory()


    public
                    initFactory() : void

initFactoryByEntityTypeId()


    public
                    initFactoryByEntityTypeId(int $entityTypeId) : self

Parameters

$entityTypeId : int

Return values

self

isActivityCountersFilterSupported()

Returns true if this entity has counters field in the filter.


    public
                    isActivityCountersFilterSupported() : bool

Return values

bool

isActivityCountersSupported()

Returns true if this entity has counters.


    public
                    isActivityCountersSupported() : bool

Return values

bool

isCategoriesSupported()

Return true if this entity supports categories


    public
                    isCategoriesSupported() : bool

Return values

bool

isContactCenterSupported()


    public
                    isContactCenterSupported() : bool

Return values

bool

isCustomPriceFieldsSupported()

Returns true if this entity supports custom field for price.


    public
                    isCustomPriceFieldsSupported() : bool

Return values

bool

isCustomSectionSupported()


    public
                    isCustomSectionSupported() : bool

Return values

bool

isDeleteAfterExclusion()

Returns true if item of this entity should be deleted after exclusion.


    public
                    isDeleteAfterExclusion() : bool

Return values

bool

isEditorConfigScopeCommon()

Returns true if scope of current editor configuration is common.


    public
                    isEditorConfigScopeCommon() : bool

Return values

bool

isEntitiesLinksInFilterSupported()

Returns true if this entity has entity links in the filter.


    public
                    isEntitiesLinksInFilterSupported() : bool

Return values

bool

isExclusionSupported()

Returns true if this entity supports exclusion.


    public
                    isExclusionSupported() : bool

Return values

bool

isInlineEditorSupported()

Returns true if this entity supports quick inline editor in the kanban.


    public
                    isInlineEditorSupported() : bool

Return values

bool

isKanbanSupported()

Return true if this entity supports kanban at all.


    public
                    isKanbanSupported() : bool

Return values

bool

isLastActivityEnabled()


    public
                    isLastActivityEnabled() : bool

Return values

bool

isNeedToRunAutomation()

Returns true if automation should be started after updating items of this entity.


    public
                    isNeedToRunAutomation() : bool

Return values

bool

isOverdueFilterSupported()

Returns true if this entity has overdue field in the filter.


    public
                    isOverdueFilterSupported() : bool

Return values

bool

isRecurringSupported()

Returns true if this entity supports recurring.


    public
                    isRecurringSupported() : bool

Return values

bool

isRestPlacementSupported()

Returns true if this entity supports rest placement to kanban.


    public
                    isRestPlacementSupported() : bool

Return values

bool

isSmartActivityNotificationEnabled()


    public
                    isSmartActivityNotificationEnabled() : bool

Return values

bool

isSmartActivityNotificationSupported()


    public
                    isSmartActivityNotificationSupported() : bool

Return values

bool

isStageEmpty()

Returns true if there are no items on the stage.


    public
                    isStageEmpty(string $stageId) : bool

Parameters

$stageId : string

Return values

bool

isTotalPriceSupported()

Returns true if this entity supports a total sum in the kanban columns.


    public
                    isTotalPriceSupported() : bool

Return values

bool

prepareFilter()


    public
                    prepareFilter(array<string|int, mixed> &$filter[, string|null $viewMode = null ]) : void

Parameters

$filter : array<string|int, mixed>
$viewMode : string|null = null

prepareFilterField()

Prepare field name to filter items of this entity.


    public
                    prepareFilterField(string $field) : string

Parameters

$field : string

Return values

string

prepareItemCommonFields()

Reformat some entity-specific field names to common names.


    public
                    prepareItemCommonFields(array<string|int, mixed> $item) : array<string|int, mixed>

Parameters

$item : array<string|int, mixed>

Return values

array<string|int, mixed>

prepareItemLastActivity()


    public
        final            prepareItemLastActivity(array<string, mixed> $rawRow) : array<string, mixed>|null

Parameters

$rawRow : array<string, mixed>

Return values

array<string, mixed>|null

prepareItemSort()


    public
        final            prepareItemSort(array<string|int, mixed> $rawRow) : array<string|int, mixed>

Parameters

$rawRow : array<string|int, mixed>

Return values

array<string|int, mixed>

prepareMultipleItemsLastActivity()


    public
        final            prepareMultipleItemsLastActivity(array<string|int, array<string, mixed>> $rawRows) : array<int, array<string, mixed>>

Parameters

$rawRows : array<string|int, array<string, mixed>>

Return values

array<int, array<string, mixed>>

prepareMultipleItemsPingSettings()


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

Parameters

$entityTypeId : int

Return values

array<string|int, mixed>

removeUserAdditionalSelectFields()

Clears settings of current user additional fields for view in kanban card.


    public
                    removeUserAdditionalSelectFields() : void

resetAdditionalSelectFields()

Resets settings of additional fields for view in kanban card.


    public
                    resetAdditionalSelectFields(bool $canEditCommon) : array<string|int, mixed>|array<string|int, string>

Parameters

$canEditCommon : bool

Return values

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

saveAdditionalFields()

Save field settings


    public
                    saveAdditionalFields(array<string|int, mixed> $fields, string $type, bool $canEditCommon) : array<string|int, mixed>

Parameters

$fields : array<string|int, mixed>

$type : string

type of fields, either "view" or "edit"

$canEditCommon : bool

Return values

array<string|int, mixed>

setCanEditCommonSettings()

Mark that current user can or not edit common settings.


    public
                    setCanEditCommonSettings(bool $canEditCommonSettings) : $this

Parameters

$canEditCommonSettings : bool

Return values

$this

setCategoryId()

Set current category id to work with.


    public
                    setCategoryId(int $categoryId) : $this

Parameters

$categoryId : int

Return values

$this

setCompanyDataProvider()


    public
                    setCompanyDataProvider(ClientDataProvider $dataProvider) : self

Parameters

$dataProvider : ClientDataProvider

Return values

self

setContactDataProvider()


    public
                    setContactDataProvider(ClientDataProvider $dataProvider) : self

Parameters

$dataProvider : ClientDataProvider

Return values

self

setCurrentSortType()


    public
        final            setCurrentSortType(string $sortType) : Result

Parameters

$sortType : string

Return values

Result

setCustomSectionCode()


    public
                    setCustomSectionCode(string|null $customSectionCode) : void

Parameters

$customSectionCode : string|null

setFactory()


    public
                    setFactory(Factory $factory) : self

Parameters

$factory : Factory

Return values

self

setGridIdInstance()


    public
                    setGridIdInstance(GridId $gridId, int $typeId) : self

Parameters

$gridId : GridId
$typeId : int

Return values

self

setItemsAssigned()

Set assigned of items with $ids.


    public
                    setItemsAssigned(array<string|int, mixed> $ids, int $assignedId, CCrmPerms $permissions) : Result

Parameters

$ids : array<string|int, mixed>
$assignedId : int
$permissions : CCrmPerms

Return values

Result

skipClientField()


    public
                    skipClientField(array<string|int, mixed> $row, string $code) : bool

Parameters

$row : array<string|int, mixed>
$code : string

Return values

bool

updateItemsCategory()

Moves items with $ids to the $categoryId.


    public
                    updateItemsCategory(array<string|int, mixed> $ids, int $categoryId, CCrmPerms $permissions) : Result

Parameters

$ids : array<string|int, mixed>
$categoryId : int
$permissions : CCrmPerms

Return values

Result

updateItemsOpened()

Set opened field of items with $ids.


    public
                    updateItemsOpened(array<string|int, mixed> $ids, bool $isOpened) : Result

Parameters

$ids : array<string|int, mixed>
$isOpened : bool

Return values

Result

updateItemStage()

Moves item with $id to stage with id $stageId.


    public
                    updateItemStage(int $id, string $stageId, array<string|int, mixed> $newStateParams, array<string|int, mixed> $stages) : Result

Parameters

$id : int
$stageId : string
$newStateParams : array<string|int, mixed>
$stages : array<string|int, mixed>

Return values

Result

Deal extends Entity

Table of Contents

Constants

Methods

Constants

VIEW_TYPE_EDIT

VIEW_TYPE_VIEW

Methods

__construct()

appendAdditionalData()

Parameters

appendClientData()

Parameters

appendMultiFieldData()

Parameters

appendRelatedEntitiesValues()

Parameters

Return values

applyCountersFilter()

Parameters

applySubQueryBasedFilters()

Parameters

Tags

canAddItemToStage()

Parameters

Return values

canUseAllCategories()

Return values

checkReadPermissions()

Parameters

Return values

checkUpdatePermissions()

Parameters

Return values

createPullItem()

Parameters

Return values

createPullStage()

Parameters

Return values

deleteItems()

Parameters

deleteItemsV2()

Parameters

Return values

fillStageTotalSums()

Parameters

getAdditionalEditFields()

Return values

getAdditionalSelectFields()

Return values

getAllowStages()

Parameters

Return values

getAssignedByFieldName()

Return values

getBaseFields()

Return values

getCategories()

Parameters

Return values

getCategoriesWithAddPermissions()

Parameters

Return values

getCategoryId()

Return values

getCloseDateFieldName()

Return values

getColumnId()

Parameters

Return values

getConfigurationPlacementUrlCode()

Return values

getCurrency()

Return values

getCustomPriceFieldName()

Return values

getCustomSectionCode()

Return values

getDbStageFieldName()