1C-Bitrix 25.700.0
Загрузка...
Поиск...
Не найдено
Класс Letter
Граф наследования:Letter:
Base Ad Rc Toloka

Открытые члены

 loadData ($id)
 hasStatistics ()
 canChangeSegments ()
 loadDataSegments ($id)
 canChangeTemplate ()
 getMessage ()
 isSupportHeatMap ()
 isSupportReiterate ()
 getCampaignId ()
 getDuration ()
 getState ()
 getMethod ()
 getCounter ()
 isReiterate ()
 isTrigger ()
 isSupportTesting ()
 remove ()
 copy ()
 test (array $codes, array $parameters=array())
 plan (Date $date)
 wait ()
 send ()
 sendErrors ()
 stop ()
 halt ()
 resume ()
 pause ()
 getLastPostingData ()
Открытые члены унаследованные от Base
 setModuleId ($moduleId)
 getModuleId ()
 getDataTypeId ()
 setDataTypeId ($dataTypeId)
 setFieldFormName ($fieldFormName)
 getFieldFormName ()
 setFieldPrefix ($fieldPrefix)
 getFieldPrefix ()
 setFieldPrefixExtended ($fieldPrefixExtended)
 getFieldPrefixExtended ()
 setFieldValues (array $fieldValues=null)
 getFieldValues ()
 hasFieldValues ()
 getFieldId ($id)
 getFieldName ($name)
 getFieldValue ($name, $defaultValue=null)
 getId ()
 getDataCount ()
 getDataCounter ()
 getResult ()
 isResultViewable ()
 getResultView ()
 setResultView ($resultView)
 requireConfigure ()
 getName ()
 getCode ()
 getData ()
 buildData ()
 getForm ()
 getStatFields ()
 isCheckAccessRights ()
 setCheckAccessRights (bool $checkAccessRights)

Открытые статические члены

static getDataClass ()
static getList (array $parameters=array())
static getDefaultSelectFields ()
static getListWithMessageFields (array $parameters=array())
static createInstanceById ($id=null, array $messageCodes=[])
static createInstanceByArray (array $data, array $messageCodes=[])
static createInstanceByPostingId ($postingId)
static createInstanceByContactId ($contactId, array $messageCodes=[])
static removeById ($id)
Открытые статические члены унаследованные от Base
static getPersonalizeList ()

Защищенные члены

 getDefaultData ()
 saveData ($id, array $data)
 prepareSearchContent ()
 saveDataSegments ($id, array $segmentsInclude, array $segmentsExclude)
 updateTemplateUseCount (array $data, array $previousData)
 getTester ()
Защищенные члены унаследованные от Base
 getDataCountByType ()
 onInitResultView ()

Защищенные статические члены

static getFilterFields ()
static createInstanceByCode ($code=null, array $messageCodes=[])

Защищенные данные

 $postingData = null
 $message
 $messagesCache = []
 $duration
 $method
 $state
 $counter
Защищенные данные унаследованные от Base
 $fieldPrefix
 $fieldPrefixExtended
 $fieldValues
 $fieldFormName
 $moduleId
 $resultView
 $dataTypeId = Recipient\Type::EMAIL
bool $checkAccessRights = true

Подробное описание

См. определение в файле letter.php строка 35

Методы

◆ canChangeSegments()

canChangeSegments ( )

Return true if can change segments.

Возвращает
bool

См. определение в файле letter.php строка 684

◆ canChangeTemplate()

canChangeTemplate ( )

Return true if can change template.

Возвращает
bool

См. определение в файле letter.php строка 726

◆ copy()

copy ( )

Copy.

Возвращает
integer|null

См. определение в файле letter.php строка 950

◆ createInstanceByArray()

createInstanceByArray ( array $data,
array $messageCodes = [] )
static

Create instance by array data.

Аргументы
array$dataData.
array$messageCodesMessage codes.
Возвращает
static|Letter|Ad|Rc|null

См. определение в файле letter.php строка 242

◆ createInstanceByCode()

createInstanceByCode ( $code = null,
array $messageCodes = [] )
staticprotected

См. определение в файле letter.php строка 304

◆ createInstanceByContactId()

createInstanceByContactId ( $contactId,
array $messageCodes = [] )
static

Create instance by contact ID.

Аргументы
integer$contactIdContact ID.
array$messageCodesMessage codes.
Возвращает
static|Ad|null

См. определение в файле letter.php строка 286

◆ createInstanceById()

createInstanceById ( $id = null,
array $messageCodes = [] )
static

Create instance by ID.

Аргументы
integer | null$idID.
array$messageCodesMessage codes.
Возвращает
static|Letter|Ad|Rc|null

См. определение в файле letter.php строка 198

◆ createInstanceByPostingId()

createInstanceByPostingId ( $postingId)
static

Create instance by posting ID.

Аргументы
integer$postingIdPosting ID.
Возвращает
static|Ad|null

См. определение в файле letter.php строка 257

◆ getCampaignId()

getCampaignId ( )

Get campaign ID.

Возвращает
mixed

См. определение в файле letter.php строка 811

◆ getCounter()

getCounter ( )

Get counter instance.

Возвращает
Posting\Counter

См. определение в файле letter.php строка 872

◆ getDataClass()

getDataClass ( )
static

Get data manager.

Возвращает
\Bitrix\Main\Entity\DataManager

См. определение в файле letter.php строка 80

◆ getDefaultData()

getDefaultData ( )
protected

Get default data.

Возвращает
array

См. определение в файле letter.php строка 359

◆ getDefaultSelectFields()

getDefaultSelectFields ( )
static

См. определение в файле letter.php строка 127

◆ getDuration()

getDuration ( )

Get duration instance.

Возвращает
Dispatch\Duration

См. определение в файле letter.php строка 821

◆ getFilterFields()

getFilterFields ( )
staticprotected

Get filter fields.

Возвращает
array

Переопределяется в Ad, Rc и Toloka.

См. определение в файле letter.php строка 64

◆ getLastPostingData()

getLastPostingData ( )

Get last posting data.

Возвращает
array

См. определение в файле letter.php строка 1188

◆ getList()

getList ( array $parameters = array())
static

Get list.

Аргументы
array$parametersParameters.
Возвращает
DB\Result

См. определение в файле letter.php строка 91

◆ getListWithMessageFields()

getListWithMessageFields ( array $parameters = array())
static

Get list with message fields

Аргументы
array$parametersGetlist params.
Возвращает
DB\ArrayResult
Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

См. определение в файле letter.php строка 157

◆ getMessage()

getMessage ( )

Get Message instance.

Возвращает
MainMessage\Adapter
Исключения

Bitrix\Main\ArgumentException

См. определение в файле letter.php строка 743

◆ getMethod()

getMethod ( )

Get method instance.

Возвращает
Dispatch\Method

См. определение в файле letter.php строка 855

◆ getState()

getState ( )

Get state instance.

Возвращает
Dispatch\State

См. определение в файле letter.php строка 838

◆ getTester()

getTester ( )
protected

Get Tester instance.

Возвращает
MainMessage\Tester

См. определение в файле letter.php строка 889

◆ halt()

halt ( )

Halt.

Возвращает
bool

См. определение в файле letter.php строка 1134

◆ hasStatistics()

hasStatistics ( )

Return true if it have statistics.

Возвращает
bool

См. определение в файле letter.php строка 668

◆ isReiterate()

isReiterate ( )

Is reiterate letter.

Возвращает
bool

См. определение в файле letter.php строка 899

◆ isSupportHeatMap()

isSupportHeatMap ( )

Is support heat map.

Возвращает
bool

См. определение в файле letter.php строка 786

◆ isSupportReiterate()

isSupportReiterate ( )

Is support reiterate run.

Возвращает
bool

См. определение в файле letter.php строка 796

◆ isSupportTesting()

isSupportTesting ( )

Is support testing.

Возвращает
bool

См. определение в файле letter.php строка 919

◆ isTrigger()

isTrigger ( )

Is trigger letter.

Возвращает
bool

См. определение в файле letter.php строка 909

◆ loadData()

loadData ( $id)

Load data.

Аргументы
integer$idID.
Возвращает
array|null

См. определение в файле letter.php строка 639

◆ loadDataSegments()

loadDataSegments ( $id)

Load segments data.

Аргументы
integer$idID.
Возвращает
array

См. определение в файле letter.php строка 695

◆ pause()

pause ( )

Pause.

Возвращает
bool

См. определение в файле letter.php строка 1170

◆ plan()

plan ( Date $date)

Plan sending.

Аргументы
Date$dateDate.
Возвращает
bool

См. определение в файле letter.php строка 1015

◆ prepareSearchContent()

prepareSearchContent ( )
protected

См. определение в файле letter.php строка 490

◆ remove()

remove ( )

Remove.

Возвращает
bool

См. определение в файле letter.php строка 929

◆ removeById()

removeById ( $id)
static

Remove by letter ID.

Аргументы
integer$idLetter ID.
Возвращает
bool

См. определение в файле letter.php строка 940

◆ resume()

resume ( )

Resume.

Возвращает
bool

См. определение в файле letter.php строка 1152

◆ saveData()

saveData ( $id,
array $data )
protected

Save data.

Аргументы
integer | null$idID.
array$dataData.
Возвращает
integer|null

Переопределяется в Ad, Rc и Toloka.

См. определение в файле letter.php строка 377

◆ saveDataSegments()

saveDataSegments ( $id,
array $segmentsInclude,
array $segmentsExclude )
protected

См. определение в файле letter.php строка 528

◆ send()

send ( )

Send.

Возвращает
bool

См. определение в файле letter.php строка 1080

◆ sendErrors()

sendErrors ( )

Send errors.

Возвращает
bool

См. определение в файле letter.php строка 1098

◆ stop()

stop ( )

Stop.

Возвращает
bool

См. определение в файле letter.php строка 1116

◆ test()

test ( array $codes,
array $parameters = array() )

Send test message to recipient.

Аргументы
array$codesRecipient codes.
array$parametersParameters.
Возвращает
Result

См. определение в файле letter.php строка 1004

◆ updateTemplateUseCount()

updateTemplateUseCount ( array $data,
array $previousData )
protected

См. определение в файле letter.php строка 610

◆ wait()

wait ( )

Wait sending.

Возвращает
bool

См. определение в файле letter.php строка 1033

Поля

◆ $counter

$counter
protected

См. определение в файле letter.php строка 57

◆ $duration

$duration
protected

См. определение в файле letter.php строка 48

◆ $message

$message
protected

См. определение в файле letter.php строка 41

◆ $messagesCache

$messagesCache = []
protected

См. определение в файле letter.php строка 45

◆ $method

$method
protected

См. определение в файле letter.php строка 51

◆ $postingData

$postingData = null
protected

См. определение в файле letter.php строка 38

◆ $state

$state
protected

См. определение в файле letter.php строка 54

Объявления и описания членов класса находятся в файле: