Bitrix API

Lead extends BaseFilter implements IncrementallyConnector

Class Lead

Table of Contents

Interfaces

IncrementallyConnector
Interface IncrementallyConnector

Constants

FIELD_FOR_PRESET_ALL  = 'SENDER_SELECT_ALL'
FIELD_PRESET_ID  = 'BX_PRESET_ID'

Methods

buildData()  : mixed
getCode()  : string
Get code.
getContactDataLead()  : array<string|int, mixed>|null
getCurrentPresetId()  : mixed
getCustomForm()  : string
Get form html.
getData()  : array<string|int, mixed>|Result
Get data.
getDataCount()  : int
Get data count.
getDataCounter()  : DataCounter
Get data counter.
getDataTypeId()  : int
Get data type ID.
getEntityLimitInfo()  : array<string|int, mixed>
getFieldFormName()  : string
getFieldId()  : string
getFieldName()  : string
getFieldPrefix()  : string
getFieldPrefixExtended()  : string
getFieldValue()  : null
getFieldValues()  : array<string|int, mixed>
Get field values.
getForm()  : string
Get form html.
getId()  : string
getLimitedData()  : Result
getLimitedQueries()  : array<string|int, mixed>|array<string|int, Query>|array<string|int, null>
getModuleId()  : mixed
getName()  : string
Get name.
getPersonalizeList()  : array<string|int, mixed>
Get personalize field list.
getQuery()  : null|Query
Get query.
getResult()  : Result
Get result.
getResultView()  : ResultView
Get result view.
getStatFields()  : array<string|int, mixed>
Get fields for statistic
getUiFilterData()  : array<string|int, mixed>
Get Ui filter data.
getUiFilterField()  : array<string|int, mixed>|null
Get UI filter fields.
getUiFilterFields()  : array<string|int, mixed>
Get filter fields.
getUiFilterId()  : mixed
getUiFilterPresets()  : array<string|int, mixed>
Get filter presets.
hasFieldValues()  : bool
Return true if it has field values.
isCheckAccessRights()  : bool
isResultViewable()  : bool
Return true if support view of result.
requireConfigure()  : bool
setCheckAccessRights()  : $this
setDataTypeId()  : void
Set data type ID.
setFieldFormName()  : void
setFieldPrefix()  : void
setFieldPrefixExtended()  : void
setFieldValues()  : void
Set field values.
setModuleId()  : void
setResultView()  : void
Set result view.

Constants

FIELD_FOR_PRESET_ALL

public mixed FIELD_FOR_PRESET_ALL = 'SENDER_SELECT_ALL'

FIELD_PRESET_ID

public mixed FIELD_PRESET_ID = 'BX_PRESET_ID'

Methods

buildData()

public buildData() : mixed

getCode()

Get code.

public getCode() : string
Return values
string

getContactDataLead()

public getContactDataLead(int $leadId) : array<string|int, mixed>|null
Parameters
$leadId : int
Return values
array<string|int, mixed>|null

getCurrentPresetId()

public getCurrentPresetId() : mixed

getCustomForm()

Get form html.

public final getCustomForm(array<string|int, mixed> $params) : string
Parameters
$params : array<string|int, mixed>
Return values
string

getData()

Get data.

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

getDataCount()

Get data count.

public getDataCount() : int
Return values
int

getDataTypeId()

Get data type ID.

public getDataTypeId() : int
Return values
int

getEntityLimitInfo()

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

getFieldFormName()

public getFieldFormName() : string
Return values
string

getFieldId()

public getFieldId(mixed $id) : string
Parameters
$id : mixed
Return values
string

getFieldName()

public getFieldName(mixed $name) : string
Parameters
$name : mixed
Return values
string

getFieldPrefix()

public getFieldPrefix() : string
Return values
string

getFieldPrefixExtended()

public getFieldPrefixExtended() : string
Return values
string

getFieldValue()

public getFieldValue(mixed $name[, mixed $defaultValue = null ]) : null
Parameters
$name : mixed
$defaultValue : mixed = null
Return values
null

getFieldValues()

Get field values.

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

getForm()

Get form html.

public final getForm() : string
Return values
string

getId()

public getId() : string
Return values
string

getLimitedData()

public getLimitedData(int $offset, int $limit) : Result
Parameters
$offset : int
$limit : int
Return values
Result

getLimitedQueries()

public getLimitedQueries(int $offset, int $limit[, string|null $excludeType = null ]) : array<string|int, mixed>|array<string|int, Query>|array<string|int, null>
Parameters
$offset : int
$limit : int
$excludeType : string|null = null
Return values
array<string|int, mixed>|array<string|int, Query>|array<string|int, null>

getModuleId()

public getModuleId() : mixed

getName()

Get name.

public getName() : string
Return values
string

getPersonalizeList()

Get personalize field list.

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

getQuery()

Get query.

public getQuery([mixed $selectList = [] ]) : null|Query
Parameters
$selectList : mixed = []
Return values
null|Query

getStatFields()

Get fields for statistic

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

getUiFilterData()

Get Ui filter data.

public static getUiFilterData(string $filterId) : array<string|int, mixed>
Parameters
$filterId : string

Filter ID.

Return values
array<string|int, mixed>

getUiFilterField()

Get UI filter fields.

public static getUiFilterField(string $id) : array<string|int, mixed>|null
Parameters
$id : string

ID.

Return values
array<string|int, mixed>|null

getUiFilterFields()

Get filter fields.

public static getUiFilterFields([bool $checkAccessRights = true ]) : array<string|int, mixed>
Parameters
$checkAccessRights : bool = true
Tags
throws
NotSupportedException
Return values
array<string|int, mixed>

getUiFilterId()

public getUiFilterId() : mixed

getUiFilterPresets()

Get filter presets.

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

hasFieldValues()

Return true if it has field values.

public hasFieldValues() : bool
Return values
bool

isCheckAccessRights()

public isCheckAccessRights() : bool
Return values
bool

isResultViewable()

Return true if support view of result.

public isResultViewable() : bool
Return values
bool

requireConfigure()

public requireConfigure() : bool
Return values
bool

setCheckAccessRights()

public setCheckAccessRights(bool $checkAccessRights) : $this
Parameters
$checkAccessRights : bool
Return values
$this

setDataTypeId()

Set data type ID.

public setDataTypeId(int $dataTypeId) : void
Parameters
$dataTypeId : int

Data type ID.

setFieldFormName()

public setFieldFormName(string $fieldFormName) : void
Parameters
$fieldFormName : string

setFieldPrefix()

public setFieldPrefix(string $fieldPrefix) : void
Parameters
$fieldPrefix : string

setFieldPrefixExtended()

public setFieldPrefixExtended(string $fieldPrefixExtended) : void
Parameters
$fieldPrefixExtended : string

setFieldValues()

Set field values.

public setFieldValues([array<string|int, mixed> $fieldValues = null ]) : void
Parameters
$fieldValues : array<string|int, mixed> = null

Values.

setModuleId()

public setModuleId(string $moduleId) : void
Parameters
$moduleId : string

setResultView()

Set result view.

public setResultView(ResultView $resultView) : void
Parameters
$resultView : ResultView

Result view.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results