Класс Sender

Открытые статические члены
static	parseEventName ($name)
static	bind ($moduleId, $eventName)
static	unbind ($moduleId, $eventName)
static	getDefaultEventParams ()
static	getAuth ($appId, $userId, array $additionalData=array(), array $additional=array())
static	call ($handlersList)
static	send ()
static	queueEvent ($queryItem)
static	getProvider ()
static	setProvider (ProviderInterface $provider)
static	getProviderOffline ()
static	setProviderOffline (ProviderOfflineInterface $providerOffline)

Защищенные статические члены
static	getDefaultProvider ()
static	enqueueBackgroundJob ()
static	getDefaultProviderOffline ()
static	initialize ()
static	getHandlerName ($moduleId, $eventName)

Статические защищенные данные
static	$initialized = false
static	$forkSet = false
static	$queryData = array()
static	$provider
static	$providerOffline
static	$defaultEventParams
static array	$appData = []

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

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

Методы

bind()

bind ( $moduleId, $eventName )

static

Binds REST event handler on PHP event.

Аргументы

string	$moduleId	Event owner module.
string	$eventName	Event name.

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

call()

call ( $handlersList )

static

Calls or schedules the query to SQS.

Аргументы

array

$handlersList

Event handlers to call.

Исключения

Bitrix\Main\ArgumentException

Исключения

Bitrix\Main\ObjectPropertyException

Исключения

Bitrix\Main\SystemException

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

enqueueBackgroundJob()

enqueueBackgroundJob ( )

staticprotected

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

getAuth()

getAuth ( $appId, $userId, array $additionalData = array(), array $additional = array() )

static

Returns authorization array for event handlers and BP activities.

Аргументы

string | int	$appId	Application ID or CODE.
int	$userId	User ID which will be the owner of access_token.
array	$additionalData	Additional data which will be stored with access_token.
array	$additional	Event parameters. Keys sendAuth and sendRefreshToken supported.

Возвращает

array|bool|null

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

getDefaultEventParams()

getDefaultEventParams ( )

static

Getter for default event params array.

Возвращает

array

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

getDefaultProvider()

getDefaultProvider ( )

staticprotected

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

getDefaultProviderOffline()

getDefaultProviderOffline ( )

staticprotected

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

getHandlerName()

getHandlerName ( $moduleId, $eventName )

staticprotected

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

getProvider()

getProvider ( )

static

Возвращает

ProviderInterface

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

getProviderOffline()

getProviderOffline ( )

static

Возвращает

ProviderOfflineInterface

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

initialize()

initialize ( )

staticprotected

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

parseEventName()

parseEventName ( $name )

static

Utility function to parse pseudo-method name

Аргументы

string

$name

Pseudo-method name.

Возвращает

array

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

queueEvent()

queueEvent ( $queryItem )

static

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

send()

send ( )

static

Sends all scheduled handlers to SQS.

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

setProvider()

setProvider ( ProviderInterface $provider )

static

Аргументы

ProviderInterface

$provider

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

setProviderOffline()

setProviderOffline ( ProviderOfflineInterface $providerOffline )

static

Аргументы

ProviderOfflineInterface

$providerOffline

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

unbind()

unbind ( $moduleId, $eventName )

static

Unbinds REST event handler on PHP event.

Аргументы

string	$moduleId	Event owner module.
string	$eventName	Event name.

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

Поля

$appData

array $appData = []

staticprotected

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

$defaultEventParams

$defaultEventParams

staticprotected

Инициализатор

= array(
        "category" => Sqs::CATEGORY_DEFAULT,
        "sendAuth" => true,
        "sendRefreshToken" => false,
    )

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

$forkSet

$forkSet = false

staticprotected

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

$initialized

$initialized = false

staticprotected

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

$provider

$provider

staticprotected

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

$providerOffline

$providerOffline

staticprotected

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

$queryData

$queryData = array()

staticprotected

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

---

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

• C:/bitrix/modules/rest/lib/event/sender.php