Bitrix API

ContactTable extends DataManager

Class ContactTable

Table of Contents

Constants

CONSENT_STATUS_ACCEPT  = 'A'
CONSENT_STATUS_DENY  = 'D'
CONSENT_STATUS_NEW  = 'N'
CONSENT_STATUS_WAIT  = 'W'

Methods

addFromConnector()  : array<string|int, mixed>
Add from connector.
addIfNotExist()  : bool|int
Add if not exist.
checkConnectors()  : void
Check connectors.
checkEmail()  : bool|string
Check email.
createCollection()  : EO_Contact_Collection
createObject()  : EO_Contact
deleteList()  : Result
getById()  : EO_Contact_Result
getByPrimary()  : EO_Contact_Result
getConflictFields()  : array<string|int, mixed>|array<string|int, string>
Get unique key index fields
getEntity()  : EO_Contact_Entity
getList()  : EO_Contact_Result
getMap()  : array<string|int, mixed>
Get map.
getTableName()  : string
Get table name.
onAfterDelete()  : EventResult
On after delete.
onBeforeAdd()  : EventResult
Handler of before add event.
onBeforeUpdate()  : EventResult
Handler of before update event.
query()  : EO_Contact_Query
updateConsentStatus()  : mixed
upload()  : bool|int
Upload contacts.
validateEmail()  : array<string|int, mixed>
Returns validators for EMAIL_FROM field.
wakeUpCollection()  : EO_Contact_Collection
wakeUpObject()  : EO_Contact

Constants

CONSENT_STATUS_ACCEPT

public mixed CONSENT_STATUS_ACCEPT = 'A'

CONSENT_STATUS_DENY

public mixed CONSENT_STATUS_DENY = 'D'

CONSENT_STATUS_NEW

public mixed CONSENT_STATUS_NEW = 'N'

CONSENT_STATUS_WAIT

public mixed CONSENT_STATUS_WAIT = 'W'

Methods

addFromConnector()

Add from connector.

public static addFromConnector(Base $connector[, null|int $pageNumber = null ][, int $timeout = 0 ]) : array<string|int, mixed>
Parameters
$connector : Base

Connector instance.

$pageNumber : null|int = null

Page number.

$timeout : int = 0

Timeout.

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

addIfNotExist()

Add if not exist.

public static addIfNotExist(array<string|int, mixed> $ar) : bool|int
Parameters
$ar : array<string|int, mixed>

Data.

Tags
throws
ArgumentException
throws
ObjectPropertyException
throws
SystemException
Return values
bool|int

checkConnectors()

Check connectors.

public static checkConnectors() : void
Tags
throws
ArgumentException

checkEmail()

Check email.

public static checkEmail(string|null $value) : bool|string
Parameters
$value : string|null
Return values
bool|string

createCollection()

public static createCollection() : EO_Contact_Collection
Return values
EO_Contact_Collection

createObject()

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

deleteList()

public static deleteList(array<string|int, mixed> $filter) : Result
Parameters
$filter : array<string|int, mixed>
Tags
throws
ArgumentException
throws
SqlQueryException
throws
SystemException
Return values
Result

getById()

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

getByPrimary()

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

getConflictFields()

Get unique key index fields

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

getEntity()

public static getEntity() : EO_Contact_Entity
Return values
EO_Contact_Entity

getList()

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

getMap()

Get 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

onAfterDelete()

On after delete.

public static onAfterDelete(Event $event) : EventResult
Parameters
$event : Event

Event.

Tags
throws
Exception
Return values
EventResult

onBeforeAdd()

Handler of before add event.

public static onBeforeAdd(Event $event) : EventResult
Parameters
$event : Event

Event object.

Return values
EventResult

onBeforeUpdate()

Handler of before update event.

public static onBeforeUpdate(Event $event) : EventResult
Parameters
$event : Event

Event object.

Return values
EventResult

query()

public static query() : EO_Contact_Query
Return values
EO_Contact_Query

updateConsentStatus()

public static updateConsentStatus(mixed $primary, string $contactStatus) : mixed
Parameters
$primary : mixed
$contactStatus : string
Tags
throws
Exception

upload()

Upload contacts.

public static upload(array<string|int, mixed> $list[, bool $isBlacklist = false ][, int|null $listId = null ]) : bool|int
Parameters
$list : array<string|int, mixed>

List of contacts.

$isBlacklist : bool = false

Is blacklist.

$listId : int|null = null

List ID.

Tags
throws
ArgumentException
throws
ArgumentTypeException
throws
SqlQueryException
throws
ObjectPropertyException
throws
SystemException
Return values
bool|int

validateEmail()

Returns validators for EMAIL_FROM field.

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

wakeUpCollection()

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

wakeUpObject()

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

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results