Bitrix API

Deal extends Base

Table of Contents

Constants

CALCULATED_FIELD_VALUE  = 1
LIMITED_BY_DATE  = 'D'
LIMITED_BY_TIMES  = 'T'
NO_LIMITED  = 'N'
SETTED_FIELD_VALUE  = 0

Methods

__construct()  : mixed
activate()  : Result
add()  : Result
cancel()  : mixed
createEntity()  : mixed
deactivate()  : Result
delete()  : Result
expose()  : Result
getInstance()  : Deal
getList()  : mixed
getNextDate()  : Date
Return calculated date by recurring params
getParameterMapper()  : DealMap
getRuntimeTemplateField()  : array<string|int, mixed>
isAllowedExpose()  : bool
update()  : Result

Constants

CALCULATED_FIELD_VALUE

public mixed CALCULATED_FIELD_VALUE = 1

LIMITED_BY_DATE

public mixed LIMITED_BY_DATE = 'D'

LIMITED_BY_TIMES

public mixed LIMITED_BY_TIMES = 'T'

NO_LIMITED

public mixed NO_LIMITED = 'N'

SETTED_FIELD_VALUE

public mixed SETTED_FIELD_VALUE = 0

Methods

__construct()

public __construct() : mixed

activate()

public activate(mixed $primary) : Result
Parameters
$primary : mixed
Tags
throws
ArgumentException
Return values
Result

add()

public add(array<string|int, mixed> $fields) : Result
Parameters
$fields : array<string|int, mixed>
Tags
throws
ArgumentException
Return values
Result

cancel()

public cancel(mixed $dealId[, string $reason = "" ]) : mixed
Parameters
$dealId : mixed
$reason : string = ""
Tags
throws
ArgumentException

createEntity()

public createEntity(array<string|int, mixed> $dealFields, array<string|int, mixed> $recurringParams) : mixed
Parameters
$dealFields : array<string|int, mixed>
$recurringParams : array<string|int, mixed>

deactivate()

public deactivate(mixed $primary) : Result
Parameters
$primary : mixed
Tags
throws
ArgumentException
Return values
Result

delete()

public delete(mixed $primary) : Result
Parameters
$primary : mixed
Tags
throws
Exception
Return values
Result

expose()

public expose(array<string|int, mixed> $filter[, null $limit = null ][, bool $recalculate = true ]) : Result
Parameters
$filter : array<string|int, mixed>
$limit : null = null
$recalculate : bool = true
Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
Result

getInstance()

public static getInstance() : Deal
Return values
Deal

getList()

public getList([array<string|int, mixed> $parameters = array() ]) : mixed
Parameters
$parameters : array<string|int, mixed> = array()

getNextDate()

Return calculated date by recurring params

public static getNextDate(array<string|int, mixed> $params[, null $startDate = null ]) : Date
Parameters
$params : array<string|int, mixed>
$startDate : null = null
Return values
Date

getParameterMapper()

public static getParameterMapper([array<string|int, mixed> $params = [] ]) : DealMap
Parameters
$params : array<string|int, mixed> = []
Return values
DealMap

getRuntimeTemplateField()

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

isAllowedExpose()

public isAllowedExpose() : bool
Return values
bool

update()

public update(mixed $primary, array<string|int, mixed> $data) : Result
Parameters
$primary : mixed
$data : array<string|int, mixed>
Tags
throws
ArgumentException
Return values
Result 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results