Bitrix API

Adapter implements iBase

Class Adapter

Table of Contents

Interfaces

iBase
Interface iMessage

Constants

PATTERN_STATUS_ITEM  = 'ENTITY_ID_'

Methods

__construct()  : mixed
Message constructor.
copyConfiguration()  : Result|null
Copy configuration.
create()  : static
Create instance.
getAudioValue()  : bool|string
Check value of audio field and prepare it for DB
getCharset()  : string
Get charset.
getClickTracker()  : Tracker
Get click tracker.
getCode()  : string
Get code.
getConfiguration()  : Configuration
Get configuration.
getEntityCode()  : mixed
getField()  : mixed|string|null
Get field.
getFields()  : array<string|int, mixed>
Get fields.
getId()  : string
Get ID.
getInstance()  : static
Get instance.
getName()  : string
Get name.
getReadTracker()  : Tracker
Get read tracker.
getRecipientCode()  : string
Get recipient code.
getRecipientData()  : array<string|int, mixed>
Get recipient data.
getRecipientId()  : string
Get recipient ID.
getRecipientType()  : string
Get recipient type.
getSendDuration()  : int
Get send duration.
getSiteId()  : string
Get site ID.
getSiteName()  : string
Get site ID.
getSiteServerName()  : string
Get site server name.
getSupportedRecipientTypes()  : array<string|int, int>
Get supported recipient types.
getSupportedTransports()  : array<string|int, mixed>
Get supported transports.
getTester()  : Tester
Is support testing.
getTo()  : string
Get to.
getTransport()  : Adapter
Get transport.
getUnsubTracker()  : Tracker
Get unsub tracker.
hasStatistics()  : bool
Return true if it has statistics.
isAds()  : bool
Is ads.
isAvailable()  : bool
Is available.
isHidden()  : bool
Return true if is hidden.
isMailing()  : bool
Is mailing.
isMarketing()  : bool
Is ads.
isMasterYandex()  : bool
Is master yandex.
isReturnCustomer()  : bool
Is return customer.
loadConfiguration()  : Configuration
Load configuration.
onAfterEnd()  : mixed
onBeforeStart()  : mixed
preHandleReaplaceValue()  : mixed
preHandleReplaceCode()  : mixed
replaceFields()  : string
Replace fields in content.
saveConfiguration()  : Result
Save configuration.
send()  : bool
Send.
setConfigurationData()  : void
Set configuration data.
setFields()  : void
Set fields.
setRecipientCode()  : void
Set recipient code.
setRecipientData()  : void
Set recipient data.
setRecipientId()  : void
Set recipient ID.
setRecipientType()  : void
Set recipient type.
setSiteId()  : void
Set site ID.
setTransport()  : void
Set transport.

Constants

PATTERN_STATUS_ITEM

public mixed PATTERN_STATUS_ITEM = 'ENTITY_ID_'

Methods

__construct()

Message constructor.

public __construct(iBase $message) : mixed
Parameters
$message : iBase

Message.

copyConfiguration()

Copy configuration.

public copyConfiguration(int|string|null $id) : Result|null
Parameters
$id : int|string|null

ID.

Return values
Result|null

create()

Create instance.

public static create(string $code) : static
Parameters
$code : string

Code.

Tags
throws
ArgumentException
Return values
static

getAudioValue()

Check value of audio field and prepare it for DB

public getAudioValue(string $optionCode, string $newValue) : bool|string
Parameters
$optionCode : string

Field code.

$newValue : string

New field value.

Return values
bool|string

getCharset()

Get charset.

public getCharset() : string
Return values
string

getCode()

Get code.

public getCode() : string
Return values
string

getEntityCode()

public getEntityCode() : mixed
Tags
inheritDoc

getField()

Get field.

public getField(string $key) : mixed|string|null
Parameters
$key : string

Key.

Return values
mixed|string|null

getFields()

Get fields.

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

getId()

Get ID.

public getId() : string
Return values
string

getInstance()

Get instance.

public static getInstance(string $code) : static
Parameters
$code : string

Message code.

Tags
throws
ArgumentException
Return values
static

getName()

Get name.

public getName() : string
Return values
string

getRecipientCode()

Get recipient code.

public getRecipientCode() : string
Return values
string

getRecipientData()

Get recipient data.

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

getRecipientId()

Get recipient ID.

public getRecipientId() : string
Return values
string

getRecipientType()

Get recipient type.

public getRecipientType() : string
Return values
string

getSendDuration()

Get send duration.

public getSendDuration() : int
Return values
int

getSiteId()

Get site ID.

public getSiteId() : string
Return values
string

getSiteName()

Get site ID.

public getSiteName() : string
Return values
string

getSiteServerName()

Get site server name.

public getSiteServerName() : string
Return values
string

getSupportedRecipientTypes()

Get supported recipient types.

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

getSupportedTransports()

Get supported transports.

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

getTo()

Get to.

public getTo() : string
Return values
string

hasStatistics()

Return true if it has statistics.

public hasStatistics() : bool
Return values
bool

isAds()

Is ads.

public isAds() : bool
Return values
bool

isAvailable()

Is available.

public isAvailable() : bool
Return values
bool

isHidden()

Return true if is hidden.

public isHidden() : bool
Return values
bool

isMailing()

Is mailing.

public isMailing() : bool
Return values
bool

isMarketing()

Is ads.

public isMarketing() : bool
Return values
bool

isMasterYandex()

Is master yandex.

public isMasterYandex() : bool
Return values
bool

isReturnCustomer()

Is return customer.

public isReturnCustomer() : bool
Return values
bool

loadConfiguration()

Load configuration.

public loadConfiguration([string|null $id = null ]) : Configuration
Parameters
$id : string|null = null

ID.

Return values
Configuration

onAfterEnd()

public onAfterEnd() : mixed

onBeforeStart()

public onBeforeStart() : mixed

preHandleReaplaceValue()

public preHandleReaplaceValue(mixed $code, mixed $value) : mixed
Parameters
$code : mixed
$value : mixed

preHandleReplaceCode()

public preHandleReplaceCode(mixed $code, mixed $crmEntityTypeId) : mixed
Parameters
$code : mixed
$crmEntityTypeId : mixed

replaceFields()

Replace fields in content.

public replaceFields([string $content = "" ][, string $replaceChar = '#' ][, mixed $crmEntityTypeId = null ]) : string
Parameters
$content : string = ""

Content.

$replaceChar : string = '#'

Replace char.

$crmEntityTypeId : mixed = null
Return values
string

send()

Send.

public send() : bool
Return values
bool

setConfigurationData()

Set configuration data.

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

Data.

setFields()

Set fields.

public setFields(array<string|int, mixed> $fields) : void
Parameters
$fields : array<string|int, mixed>

Fields.

setRecipientCode()

Set recipient code.

public setRecipientCode(string $code) : void
Parameters
$code : string

Code.

setRecipientData()

Set recipient data.

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

Data.

setRecipientId()

Set recipient ID.

public setRecipientId(string $id) : void
Parameters
$id : string

Recipient ID.

setRecipientType()

Set recipient type.

public setRecipientType(string $type) : void
Parameters
$type : string

Type.

setSiteId()

Set site ID.

public setSiteId([string $id = null ]) : void
Parameters
$id : string = null

ID.

setTransport()

Set transport.

public setTransport(Adapter $transport) : void
Parameters
$transport : Adapter

Transport.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results