Bitrix API

ContactCompanyTable extends DataManager

Class ContactCompanyTable

DO NOT WRITE ANYTHING BELOW THIS

<<< ORMENTITYANNOTATION

Table of Contents

Methods

bindCompanies()  : void
Bind contact to companies.
bindCompanyIDs()  : void
Bind contact to companies are specified by ID.
bindContactIDs()  : void
Bind company to contacts specified by ID.
bindContacts()  : void
Bind company to contacts.
createCollection()  : EO_ContactCompany_Collection
createObject()  : EO_ContactCompany
getBulkCompanyBindings()  : array<string|int, mixed>
Get binding map for company's collection.
getBulkContactBindings()  : array<string|int, mixed>
Get binding map for contact's collection.
getById()  : EO_ContactCompany_Result
getByPrimary()  : EO_ContactCompany_Result
getCompanyBindings()  : array<string|int, mixed>
Get company's bindings.
getCompanyContactIDs()  : array<string|int, mixed>
Get contact IDs are bound to specified company.
getContactBindingCount()  : int
Get contact's binding count.
getContactBindings()  : array<string|int, mixed>
Get contacts's bindings.
getContactCompanyIDs()  : array<string|int, mixed>
Get company IDs are bound to specified contact.
getEntity()  : EO_ContactCompany_Entity
getList()  : EO_ContactCompany_Result
getMap()  : array<string|int, mixed>
Get table fields map.
getTableName()  : string
Get table name.
hasCompanies()  : bool
Check if contact has companies.
prepareFilterJoinSql()  : string
Prepare SQL join filter condition for specified entity.
prepareFilterJoinSqlByTitle()  : string
Prepare SQL join filter condition for specified entity by entity title.
query()  : EO_ContactCompany_Query
rebindAllCompanies()  : mixed
Unbind all companies from seed contact and bind to target contact
rebindAllContacts()  : mixed
Unbind all contacts from seed company and bind to target company
unbindAllCompanies()  : mixed
Unbind specified contact from all companies.
unbindAllContacts()  : void
Unbind specified company from all contacts.
unbindCompanies()  : void
Unbind specified contact from specified companies.
unbindCompanyIDs()  : void
Unbind specified contact from specified companies.
unbindContactIDs()  : void
Unbind specified company from specified contacts.
unbindContacts()  : void
Unbind specified company from specified contacts.
upsert()  : void
Execute UPSERT operation.
wakeUpCollection()  : EO_ContactCompany_Collection
wakeUpObject()  : EO_ContactCompany

Methods

bindCompanies()

Bind contact to companies.

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

Contact ID.

$bindings : array<string|int, mixed>

Array of company bindings.

Tags
throws
ArgumentException

bindCompanyIDs()

Bind contact to companies are specified by ID.

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

Contact ID.

$companyIDs : array<string|int, mixed>

Array of company IDs.

bindContactIDs()

Bind company to contacts specified by ID.

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

Company ID.

$contactIDs : array<string|int, mixed>

Array of contact IDs.

bindContacts()

Bind company to contacts.

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

Company ID.

$bindings : array<string|int, mixed>

Array of company bindings.

Tags
throws
ArgumentException

createCollection()

public static createCollection() : EO_ContactCompany_Collection
Return values
EO_ContactCompany_Collection

createObject()

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

getBulkCompanyBindings()

Get binding map for company's collection.

public static getBulkCompanyBindings(array<string|int, mixed> $companyIDs) : array<string|int, mixed>
Parameters
$companyIDs : array<string|int, mixed>

Array of Company IDs.

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

getBulkContactBindings()

Get binding map for contact's collection.

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

Array of Contact IDs.

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

getById()

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

getByPrimary()

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

getCompanyBindings()

Get company's bindings.

public static getCompanyBindings(int $companyID) : array<string|int, mixed>
Parameters
$companyID : int

Company ID.

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

getCompanyContactIDs()

Get contact IDs are bound to specified company.

public static getCompanyContactIDs(int $companyID) : array<string|int, mixed>
Parameters
$companyID : int

Company ID.

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

getContactBindingCount()

Get contact's binding count.

public static getContactBindingCount(int $contactID) : int
Parameters
$contactID : int

Contact ID.

Tags
throws
ArgumentException
Return values
int

getContactBindings()

Get contacts's bindings.

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

Contact ID.

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

getContactCompanyIDs()

Get company IDs are bound to specified contact.

public static getContactCompanyIDs(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_ContactCompany_Entity
Return values
EO_ContactCompany_Entity

getList()

public static getList([array<string|int, mixed> $parameters = = '[]' ]) : EO_ContactCompany_Result
Parameters
$parameters : array<string|int, mixed> = = '[]'
Return values
EO_ContactCompany_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

hasCompanies()

Check if contact has companies.

public static hasCompanies(int $contactID) : bool
Parameters
$contactID : int

Contact 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

prepareFilterJoinSqlByTitle()

Prepare SQL join filter condition for specified entity by entity title.

public static prepareFilterJoinSqlByTitle(int $entityTypeID, string $entityTitle, string $tableAlias) : string
Parameters
$entityTypeID : int

Entity type ID for filter.

$entityTitle : string

Entity Title for filter.

$tableAlias : string

Alias of primary table.

Tags
throws
ArgumentOutOfRangeException
throws
NotSupportedException
Return values
string

query()

public static query() : EO_ContactCompany_Query
Return values
EO_ContactCompany_Query

rebindAllCompanies()

Unbind all companies from seed contact and bind to target contact

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

Seed contact ID.

$targContactID : int

Target contact ID.

Tags
throws
ArgumentException

rebindAllContacts()

Unbind all contacts from seed company and bind to target company

public static rebindAllContacts(int $seedCompanyID, int $targCompanyID) : mixed
Parameters
$seedCompanyID : int

Seed company ID.

$targCompanyID : int

Target company ID.

Tags
throws
ArgumentException

unbindAllCompanies()

Unbind specified contact from all companies.

public static unbindAllCompanies(int $contactID) : mixed
Parameters
$contactID : int

Contact ID.

Tags
throws
ArgumentException
throws
NotSupportedException

unbindAllContacts()

Unbind specified company from all contacts.

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

Company ID.

Tags
throws
ArgumentException

unbindCompanies()

Unbind specified contact from specified companies.

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

Contact ID.

$bindings : array<string|int, mixed>

Array of bindings.

Tags
throws
ArgumentException

unbindCompanyIDs()

Unbind specified contact from specified companies.

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

Contact ID.

$companyIDs : array<string|int, mixed>

Array of company IDs.

Tags
throws
ArgumentException

unbindContactIDs()

Unbind specified company from specified contacts.

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

Company ID.

$contactIDs : array<string|int, mixed>

Array of contact IDs.

Tags
throws
ArgumentException

unbindContacts()

Unbind specified company from specified contacts.

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

Company 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_ContactCompany_Collection
Parameters
$rows : mixed
Return values
EO_ContactCompany_Collection

wakeUpObject()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results