Bitrix API

DealSettings uses EnableFactory

Table of Contents

Constants

VIEW_CALENDAR  = \Bitrix\Crm\Settings\EntityViewSettings::CALENDAR_VIEW
VIEW_KANBAN  = \Bitrix\Crm\Settings\EntityViewSettings::KANBAN_VIEW
VIEW_LIST  = \Bitrix\Crm\Settings\EntityViewSettings::LIST_VIEW

Methods

__construct()  : mixed
enableCloseDateSync()  : void
Enable synchronization of the 'CLOSEDATE' field
enableDeferredCleaning()  : void
Enable enable deferred cleaning of related entities during deletion operation.
enableProductRowExport()  : void
Enable export of the product rows
enableRecycleBin()  : void
Enable deletion to recycle bin.
getCurrent()  : DealSettings
Get current instance
getCurrentListViewID()  : int
Get current list view ID
getDefaultListViewID()  : int
Get default list view ID
getOpenedFlag()  : bool
Get value of flag 'OPENED'
getViewDescriptions()  : array<string|int, mixed>
Get descriptions of views supported in current context
isCloseDateSyncEnabled()  : bool
Check if synchronization of the 'CLOSEDATE' field is enabled.
isDeferredCleaningEnabled()  : bool
Return true if deferred cleaning of related entities during deletion operation is enabled.
isFactoryEnabled()  : bool
Return true if new interface and api through Service\Factory is used to process this entity type.
isProductRowExportEnabled()  : bool
Check if export of the product rows is enabled
isRecycleBinEnabled()  : bool
Return true if deletion to recycle bin is enabled.
prepareViewListItems()  : array<string|int, mixed>
Prepare list items for view selector
setDefaultListViewID()  : void
Set default list view ID
setFactoryEnabled()  : void
Set state of isFactoryEnabled setting.
setOpenedFlag()  : void
Set value of flag 'OPENED'

Constants

VIEW_CALENDAR

public mixed VIEW_CALENDAR = \Bitrix\Crm\Settings\EntityViewSettings::CALENDAR_VIEW

VIEW_KANBAN

public mixed VIEW_KANBAN = \Bitrix\Crm\Settings\EntityViewSettings::KANBAN_VIEW

VIEW_LIST

public mixed VIEW_LIST = \Bitrix\Crm\Settings\EntityViewSettings::LIST_VIEW

Methods

enableCloseDateSync()

Enable synchronization of the 'CLOSEDATE' field

public enableCloseDateSync(bool $enabled) : void
Parameters
$enabled : bool

Enabled Flag.

enableDeferredCleaning()

Enable enable deferred cleaning of related entities during deletion operation.

public enableDeferredCleaning(bool $enabled) : void
Parameters
$enabled : bool

Enabled Flag.

enableProductRowExport()

Enable export of the product rows

public enableProductRowExport(bool $enabled) : void
Parameters
$enabled : bool

Enabled Flag.

enableRecycleBin()

Enable deletion to recycle bin.

public enableRecycleBin(bool $enabled) : void
Parameters
$enabled : bool

Enabled Flag.

getCurrentListViewID()

Get current list view ID

public getCurrentListViewID() : int
Return values
int

getDefaultListViewID()

Get default list view ID

public getDefaultListViewID() : int
Return values
int

getOpenedFlag()

Get value of flag 'OPENED'

public getOpenedFlag() : bool
Return values
bool

getViewDescriptions()

Get descriptions of views supported in current context

public static getViewDescriptions() : array<string|int, mixed>
Return values
array<string|int, mixed>

isCloseDateSyncEnabled()

Check if synchronization of the 'CLOSEDATE' field is enabled.

public isCloseDateSyncEnabled() : bool
Return values
bool

isDeferredCleaningEnabled()

Return true if deferred cleaning of related entities during deletion operation is enabled.

public isDeferredCleaningEnabled() : bool
Return values
bool

isFactoryEnabled()

Return true if new interface and api through Service\Factory is used to process this entity type.

public isFactoryEnabled() : bool
Return values
bool

isProductRowExportEnabled()

Check if export of the product rows is enabled

public isProductRowExportEnabled() : bool
Return values
bool

isRecycleBinEnabled()

Return true if deletion to recycle bin is enabled.

public isRecycleBinEnabled() : bool
Return values
bool

prepareViewListItems()

Prepare list items for view selector

public static prepareViewListItems() : array<string|int, mixed>
Return values
array<string|int, mixed>

setDefaultListViewID()

Set default list view ID

public setDefaultListViewID(int $viewID) : void
Parameters
$viewID : int

View ID.

setFactoryEnabled()

Set state of isFactoryEnabled setting.

public setFactoryEnabled(bool $isEnabled) : void
Parameters
$isEnabled : bool

setOpenedFlag()

Set value of flag 'OPENED'

public setOpenedFlag(bool $opened) : void
Parameters
$opened : bool

Opened Flag.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results