Bitrix API

ActualEntitySelector

Class ActualEntitySelector

Table of Contents

Constants

SEARCH_PARAM_EMAIL  = 'FM.EMAIL'
SEARCH_PARAM_ORGANIZATION  = 'ORGANIZATION'
SEARCH_PARAM_PERSON  = 'PERSON'
SEARCH_PARAM_PHONE  = 'FM.PHONE'

Methods

__call()  : mixed
Magic method __call.
__construct()  : mixed
Constructor.
appendCommunicationCriterion()  : $this
Append email criterion.
appendEmailCriterion()  : $this
Append email criterion.
appendOrganizationCriterion()  : $this
Append person criterion.
appendPersonCriterion()  : $this
Append person criterion.
appendPhoneCriterion()  : $this
Append phone number criterion.
canCreateDeal()  : bool
Return true if deal can be created.
canCreateLead()  : bool
Return true if lead(return customer lead) can be created.
canCreatePrimaryEntity()  : bool
Return true if primary entity can be created.
canCreateReturnCustomerLead()  : bool
Return true if lead(return customer lead) can be created.
clear()  : $this
Clear.
create()  : static
Create instance of class.
createDuplicateCriteria()  : array<string|int, DuplicateCriterion>
Create duplicate criteria from entity fields.
disableExclusionChecking()  : $this
Disable exclusion checking.
enableFullSearch()  : $this
Enable searching of all entity types.
getCompanies()  : array<string|int, int>
getCompanyDealId()  : int|null
getCompanyDeals()  : array<string|int, int>
getCompanyDynamicId()  : int|null
getCompanyDynamics()  : array<string|int, int>
getCompanyId()  : int|null
getCompanyOrders()  : array<string|int, int>
getCompanyReturnCustomerLeadId()  : int|null
getCompanyReturnCustomerLeads()  : array<string|int, int>
getContactCompanyId()  : int|null
getContactDealId()  : int|null
getContactDeals()  : array<string|int, int>
getContactDynamicId()  : int|null
getContactDynamics()  : array<string|int, int>
getContactId()  : int|null
getContactOrders()  : array<string|int, int>
getContactReturnCustomerLeadId()  : int|null
getContactReturnCustomerLeads()  : array<string|int, int>
getContacts()  : array<string|int, int>
getCriteria()  : array<string|int, DuplicateCriterion>
Get criteria.
getDealId()  : int|null
getDeals()  : array<string|int, int>
getDuplicates()  : array<string|int, Duplicate>
Get duplicate list.
getDynamicId()  : int|null
getDynamics()  : array<string|int, int>
getDynamicTypeId()  : int
Get dynamic type ID.
getEntities()  : array<string|int, mixed>
Get actual entity list.
getLeadId()  : int|null
getLeads()  : array<string|int, int>
getOrders()  : array<string|int, int>
getPrimaryAssignedById()  : int|null
Get id of responsible person of primary entity.
getPrimaryId()  : int|null
Get primary actual entity id.
getPrimaryTypeId()  : int|null
Get primary actual entity type id.
getRanking()  : ActualRanking
Get ranking.
getReturnCustomerLeadId()  : int|null
getReturnCustomerLeads()  : array<string|int, int>
hasEntities()  : bool
Return true if entities are found.
hasExclusions()  : bool
Return true if has exclusions.
search()  : $this
Search actual entity list.
setCompanies()  : void
setCompanyDealId()  : void
setCompanyDeals()  : void
setCompanyDynamicId()  : void
setCompanyDynamics()  : void
setCompanyId()  : void
setCompanyOrders()  : void
setCompanyReturnCustomerLeadId()  : void
setCompanyReturnCustomerLeads()  : void
setContactCompanyId()  : void
setContactDealId()  : void
setContactDeals()  : void
setContactDynamicId()  : void
setContactDynamics()  : void
setContactId()  : void
setContactOrders()  : void
setContactReturnCustomerLeadId()  : void
setContactReturnCustomerLeads()  : void
setContacts()  : void
setCriteria()  : $this
Set criteria.
setDealId()  : void
setDeals()  : void
setDynamicId()  : void
setDynamics()  : void
setDynamicTypeId()  : $this
Set dynamic type ID.
setEntities()  : $this
Set actual entity instead of using duplicate search.
setEntity()  : $this
Set actual entity instead of using duplicate search.
setLeadId()  : void
setLeads()  : void
setOrders()  : void
setReturnCustomerLeadId()  : void
setReturnCustomerLeads()  : void
useFinishedLead()  : $this
Use finished lead.

Constants

Methods

__call()

Magic method __call.

public __call(string $name, array<string|int, mixed> $arguments) : mixed
Parameters
$name : string

Method name.

$arguments : array<string|int, mixed>

Arguments.

appendCommunicationCriterion()

Append email criterion.

public appendCommunicationCriterion(string $communicationType, string $value) : $this
Parameters
$communicationType : string

Type defined at Communication\Type class.

$value : string

Value.

Return values
$this

appendEmailCriterion()

Append email criterion.

public appendEmailCriterion(string $email) : $this
Parameters
$email : string

Email.

Return values
$this

appendOrganizationCriterion()

Append person criterion.

public appendOrganizationCriterion(string $title) : $this
Parameters
$title : string

Organization title.

Return values
$this

appendPersonCriterion()

Append person criterion.

public appendPersonCriterion(string $lastName[, string $name = '' ][, string $secondName = '' ]) : $this
Parameters
$lastName : string

Last name.

$name : string = ''

Name.

$secondName : string = ''

Second name.

Return values
$this

appendPhoneCriterion()

Append phone number criterion.

public appendPhoneCriterion(string $phone) : $this
Parameters
$phone : string

Phone number.

Return values
$this

canCreateDeal()

Return true if deal can be created.

public canCreateDeal() : bool
Return values
bool

canCreateLead()

Return true if lead(return customer lead) can be created.

public canCreateLead() : bool
Return values
bool

canCreatePrimaryEntity()

Return true if primary entity can be created.

public canCreatePrimaryEntity() : bool
Return values
bool

canCreateReturnCustomerLead()

Return true if lead(return customer lead) can be created.

public canCreateReturnCustomerLead() : bool
Return values
bool

clear()

Clear.

public clear() : $this

Remove criteria, founded duplicates, entity data.

Return values
$this

create()

Create instance of class.

public static create(array<string|int, mixed> $fields, array<string|int, mixed> $searchParameters) : static

$fields = array( 'NAME' => 'Mike', 'SECOND_NAME' => 'Julio', 'LAST_NAME' => 'Johnson', 'COMPANY_TITLE' => 'Example company name', 'FM' => array( 'EMAIL' => array(array('VALUE' => 'name@example.com')), 'PHONE' => array(array('VALUE' => '+98765432100')), ) ).

Parameters
$fields : array<string|int, mixed>

Entity fields.

$searchParameters : array<string|int, mixed>

Search parameters for searching duplicates.

Tags
throws
ArgumentException
Return values
static

createDuplicateCriteria()

Create duplicate criteria from entity fields.

public static createDuplicateCriteria(array<string|int, mixed> $fields, array<string|int, mixed> $searchParameters) : array<string|int, DuplicateCriterion>
Parameters
$fields : array<string|int, mixed>

Entity fields.

$searchParameters : array<string|int, mixed>

List of search parameters.

Tags
throws
ArgumentException
Return values
array<string|int, DuplicateCriterion>

disableExclusionChecking()

Disable exclusion checking.

public disableExclusionChecking() : $this
Return values
$this

enableFullSearch()

Enable searching of all entity types.

public enableFullSearch() : $this
Return values
$this

getCompanies()

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

Get companies.

Return values
array<string|int, int>

getCompanyDealId()

public getCompanyDealId() : int|null

Get company deal ID.

Return values
int|null

getCompanyDeals()

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

Get company deals.

Return values
array<string|int, int>

getCompanyDynamicId()

public getCompanyDynamicId() : int|null

Get company dynamic ID.

Return values
int|null

getCompanyDynamics()

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

Get company dynamics.

Return values
array<string|int, int>

getCompanyOrders()

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

Get company orders.

Return values
array<string|int, int>

getCompanyReturnCustomerLeadId()

public getCompanyReturnCustomerLeadId() : int|null

Get company return customer lead ID.

Return values
int|null

getCompanyReturnCustomerLeads()

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

Get company return customer leads.

Return values
array<string|int, int>

getContactCompanyId()

public getContactCompanyId() : int|null

Get contact company ID.

Return values
int|null

getContactDealId()

public getContactDealId() : int|null

Get contact deal ID.

Return values
int|null

getContactDeals()

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

Get contact deals.

Return values
array<string|int, int>

getContactDynamicId()

public getContactDynamicId() : int|null

Get contact dynamic ID.

Return values
int|null

getContactDynamics()

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

Get contact dynamics.

Return values
array<string|int, int>

getContactOrders()

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

Get contact orders.

Return values
array<string|int, int>

getContactReturnCustomerLeadId()

public getContactReturnCustomerLeadId() : int|null

Get contact return customer lead ID.

Return values
int|null

getContactReturnCustomerLeads()

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

Get contact return customer leads.

Return values
array<string|int, int>

getContacts()

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

Get contacts.

Return values
array<string|int, int>

getDeals()

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

Get deals.

Return values
array<string|int, int>

getDynamics()

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

Get dynamics.

Return values
array<string|int, int>

getDynamicTypeId()

Get dynamic type ID.

public getDynamicTypeId() : int
Return values
int

getEntities()

Get actual entity list.

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

getLeads()

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

Get leads.

Return values
array<string|int, int>

getOrders()

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

Get orders.

Return values
array<string|int, int>

getPrimaryAssignedById()

Get id of responsible person of primary entity.

public getPrimaryAssignedById() : int|null
Return values
int|null

getPrimaryId()

Get primary actual entity id.

public getPrimaryId() : int|null
Return values
int|null

getPrimaryTypeId()

Get primary actual entity type id.

public getPrimaryTypeId() : int|null
Return values
int|null

getReturnCustomerLeadId()

public getReturnCustomerLeadId() : int|null

Get return customer lead ID.

Return values
int|null

getReturnCustomerLeads()

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

Get return customer leads.

Return values
array<string|int, int>

hasEntities()

Return true if entities are found.

public hasEntities() : bool
Return values
bool

hasExclusions()

Return true if has exclusions.

public hasExclusions() : bool
Return values
bool

setCompanies()

public setCompanies(array<string|int, mixed> $list) : void

Set companies.

Parameters
$list : array<string|int, mixed>

setCompanyDealId()

public setCompanyDealId(mixed $id) : void

Set company deal ID.

Parameters
$id : mixed

setCompanyDeals()

public setCompanyDeals(array<string|int, mixed> $list) : void

Set company deals.

Parameters
$list : array<string|int, mixed>

setCompanyDynamicId()

public setCompanyDynamicId(mixed $id) : void

Set company dynamic ID.

Parameters
$id : mixed

setCompanyDynamics()

public setCompanyDynamics(array<string|int, mixed> $list) : void

Set company dynamics.

Parameters
$list : array<string|int, mixed>

setCompanyId()

public setCompanyId(mixed $id) : void

Set company ID.

Parameters
$id : mixed

setCompanyOrders()

public setCompanyOrders(array<string|int, mixed> $list) : void

Set company orders.

Parameters
$list : array<string|int, mixed>

setCompanyReturnCustomerLeadId()

public setCompanyReturnCustomerLeadId(mixed $id) : void

Set company return customer lead ID.

Parameters
$id : mixed

setCompanyReturnCustomerLeads()

public setCompanyReturnCustomerLeads(array<string|int, mixed> $list) : void

Set company return customer leads.

Parameters
$list : array<string|int, mixed>

setContactCompanyId()

public setContactCompanyId(mixed $id) : void

Set contact company ID.

Parameters
$id : mixed

setContactDealId()

public setContactDealId(mixed $id) : void

Set contact deal ID.

Parameters
$id : mixed

setContactDeals()

public setContactDeals(array<string|int, mixed> $list) : void

Set contact deals.

Parameters
$list : array<string|int, mixed>

setContactDynamicId()

public setContactDynamicId(mixed $id) : void

Set contact dynamic ID.

Parameters
$id : mixed

setContactDynamics()

public setContactDynamics(array<string|int, mixed> $list) : void

Set contact dynamics.

Parameters
$list : array<string|int, mixed>

setContactId()

public setContactId(mixed $id) : void

Set contact ID.

Parameters
$id : mixed

setContactOrders()

public setContactOrders(array<string|int, mixed> $list) : void

Set contact orders.

Parameters
$list : array<string|int, mixed>

setContactReturnCustomerLeadId()

public setContactReturnCustomerLeadId(mixed $id) : void

Set contact return customer lead ID.

Parameters
$id : mixed

setContactReturnCustomerLeads()

public setContactReturnCustomerLeads(array<string|int, mixed> $list) : void

Set contact return customer leads.

Parameters
$list : array<string|int, mixed>

setContacts()

public setContacts(array<string|int, mixed> $list) : void

Set contacts.

Parameters
$list : array<string|int, mixed>

setDeals()

public setDeals(array<string|int, mixed> $list) : void

Set deals.

Parameters
$list : array<string|int, mixed>

setDynamicId()

public setDynamicId(mixed $id) : void

Set dynamic ID.

Parameters
$id : mixed

setDynamics()

public setDynamics(array<string|int, mixed> $list) : void

Set dynamics.

Parameters
$list : array<string|int, mixed>

setDynamicTypeId()

Set dynamic type ID.

public setDynamicTypeId(int $entityTypeId) : $this
Parameters
$entityTypeId : int

Entity type ID.

Return values
$this

setEntities()

Set actual entity instead of using duplicate search.

public setEntities(ComplexCollection $entities[, bool $skipRanking = false ]) : $this
Parameters
$entities : ComplexCollection

Entities.

$skipRanking : bool = false

Skip ranking.

Return values
$this

setEntity()

Set actual entity instead of using duplicate search.

public setEntity(int $entityTypeId, int|array<string|int, int> $entityId[, bool $skipRanking = false ]) : $this
Parameters
$entityTypeId : int

Entity type ID.

$entityId : int|array<string|int, int>

Entity ID.

$skipRanking : bool = false

Skip ranking.

Return values
$this

setLeads()

public setLeads(array<string|int, mixed> $list) : void

Set leads.

Parameters
$list : array<string|int, mixed>

setOrders()

public setOrders(array<string|int, mixed> $list) : void

Set orders.

Parameters
$list : array<string|int, mixed>

setReturnCustomerLeadId()

public setReturnCustomerLeadId(mixed $id) : void

Set return customer lead ID.

Parameters
$id : mixed

setReturnCustomerLeads()

public setReturnCustomerLeads(array<string|int, mixed> $list) : void

Set return customer leads.

Parameters
$list : array<string|int, mixed>

useFinishedLead()

Use finished lead.

public useFinishedLead([bool|null $mode = null ]) : $this
Parameters
$mode : bool|null = null

Mode.

Return values
$this 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results