Bitrix API

LeadContactTable extends DataManager

Class LeadContactTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION

Table of Contents

Methods

bindContactIDs()  : void
Bind Lead to Contacts are specified by ID.
bindContacts()  : void
Bind Lead to Contacts.
createCollection()  : EO_LeadContact_Collection
createObject()  : EO_LeadContact
getBulkLeadBindings()  : array<string|int, mixed>
Get binding map for lead's collection.
getById()  : EO_LeadContact_Result
getByPrimary()  : EO_LeadContact_Result
getContactLeadIDs()  : array<string|int, mixed>
Get Lead IDs are bound to specified contact.
getEntity()  : EO_LeadContact_Entity
getLeadBindingCount()  : int
Get Lead's binding count.
getLeadBindings()  : array<string|int, mixed>
Get Lead's bindings.
getLeadContactIDs()  : array<string|int, mixed>
Get Contact IDs are bound to specified Lead.
getList()  : EO_LeadContact_Result
getMap()  : array<string|int, mixed>
Get table fields map.
getTableName()  : string
Get table name.
hasContacts()  : bool
Check if Lead has Contacts.
prepareFilterJoinSql()  : string
Prepare SQL join filter condition for specified entity.
query()  : EO_LeadContact_Query
rebindAllLeads()  : mixed
Unbind all Leads from seed Contact and bind to target Contact
unbindAllContacts()  : void
Unbind specified Lead from all contacts.
unbindAllLeads()  : void
Unbind specified Contact from all Leads.
unbindContactIDs()  : void
Unbind specified Lead from specified contacts.
unbindContacts()  : void
Unbind specified Lead from specified Contacts.
upsert()  : void
Execute UPSERT operation.
wakeUpCollection()  : EO_LeadContact_Collection
wakeUpObject()  : EO_LeadContact

Methods

bindContactIDs()

Bind Lead to Contacts are specified by ID.

public static bindContactIDs(int $leadID, array<string|int, mixed> $contactIDs) : void
Parameters
$leadID : int

Lead ID.

$contactIDs : array<string|int, mixed>

Array of contact IDs.

bindContacts()

Bind Lead to Contacts.

public static bindContacts(int $leadID, array<string|int, mixed> $bindings) : void
Parameters
$leadID : int

Lead ID.

$bindings : array<string|int, mixed>

Array of contact bindings.

Tags
throws
ArgumentException

createCollection()

public static createCollection() : EO_LeadContact_Collection
Return values
EO_LeadContact_Collection

createObject()

public static createObject([mixed $setDefaultValues = = 'true' ]) : EO_LeadContact
Parameters
$setDefaultValues : mixed = = 'true'
Return values
EO_LeadContact

getBulkLeadBindings()

Get binding map for lead's collection.

public static getBulkLeadBindings(array<string|int, mixed> $leadsIDs) : array<string|int, mixed>
Parameters
$leadsIDs : array<string|int, mixed>

Array of Lead IDs.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
array<string|int, mixed>

getById()

public static getById(mixed $id) : EO_LeadContact_Result
Parameters
$id : mixed
Return values
EO_LeadContact_Result

getByPrimary()

public static getByPrimary(mixed $primary[, array<string|int, mixed> $parameters = = '[]' ]) : EO_LeadContact_Result
Parameters
$primary : mixed
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_LeadContact_Result

getContactLeadIDs()

Get Lead IDs are bound to specified contact.

public static getContactLeadIDs(int $contactID) : array<string|int, mixed>
Parameters
$contactID : int

Contact ID.

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

getEntity()

public static getEntity() : EO_LeadContact_Entity
Return values
EO_LeadContact_Entity

getLeadBindingCount()

Get Lead's binding count.

public static getLeadBindingCount(mixed $leadID) : int
Parameters
$leadID : mixed
Tags
throws
ArgumentException
Return values
int

getLeadBindings()

Get Lead's bindings.

public static getLeadBindings(int $leadID) : array<string|int, mixed>
Parameters
$leadID : int

Lead ID.

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

getLeadContactIDs()

Get Contact IDs are bound to specified Lead.

public static getLeadContactIDs(int $leadID) : array<string|int, mixed>
Parameters
$leadID : int

Lead ID.

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

getList()

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_LeadContact_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_LeadContact_Result

getMap()

Get table fields map.

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

getTableName()

Get table name.

public static getTableName() : string
Return values
string

hasContacts()

Check if Lead has Contacts.

public static hasContacts(int $leadID) : bool
Parameters
$leadID : int

Lead ID.

Tags
throws
ArgumentException
Return values
bool

prepareFilterJoinSql()

Prepare SQL join filter condition for specified entity.

public static prepareFilterJoinSql(int $entityTypeID, int $entityID, string $tableAlias) : string
Parameters
$entityTypeID : int

Entity type ID for filter.

$entityID : int

Entity ID for filter.

$tableAlias : string

Alias of primary table.

Tags
throws
ArgumentException
throws
ArgumentOutOfRangeException
throws
NotSupportedException
Return values
string

query()

public static query() : EO_LeadContact_Query
Return values
EO_LeadContact_Query

rebindAllLeads()

Unbind all Leads from seed Contact and bind to target Contact

public static rebindAllLeads(int $seedContactID, int $targContactID) : mixed
Parameters
$seedContactID : int

Seed contact ID.

$targContactID : int

Target contact ID.

Tags
throws
ArgumentException

unbindAllContacts()

Unbind specified Lead from all contacts.

public static unbindAllContacts(int $leadID) : void
Parameters
$leadID : int

Lead ID.

Tags
throws
ArgumentException

unbindAllLeads()

Unbind specified Contact from all Leads.

public static unbindAllLeads(int $contactID) : void
Parameters
$contactID : int

Contact ID.

Tags
throws
ArgumentException

unbindContactIDs()

Unbind specified Lead from specified contacts.

public static unbindContactIDs(int $leadID, array<string|int, mixed> $contactIDs) : void
Parameters
$leadID : int

Lead ID.

$contactIDs : array<string|int, mixed>

Array of contact IDs.

Tags
throws
ArgumentException

unbindContacts()

Unbind specified Lead from specified Contacts.

public static unbindContacts(int $leadID, array<string|int, mixed> $bindings) : void
Parameters
$leadID : int

Lead ID.

$bindings : array<string|int, mixed>

Array of bindings.

Tags
throws
ArgumentException

upsert()

Execute UPSERT operation.

public static upsert(array<string|int, mixed> $data) : void
Parameters
$data : array<string|int, mixed>

Field data.

wakeUpCollection()

public static wakeUpCollection(mixed $rows) : EO_LeadContact_Collection
Parameters
$rows : mixed
Return values
EO_LeadContact_Collection

wakeUpObject()

public static wakeUpObject(mixed $row) : EO_LeadContact
Parameters
$row : mixed
Return values
EO_LeadContact 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results