Класс PullManager

Открытые члены
	__construct ()
	isEnabled ()
	sendDocumentAddedEvent (array $items, ?array $params=null)
	sendDocumentsUpdatedEvent (array $items, ?array $params=null)
	sendDocumentDeletedEvent (array $items, ?array $params=null)

Открытые статические члены
static	getInstance ()
static	onGetDependentModule ()

Открытые атрибуты
const	MODULE_ID = 'catalog'
const	EVENT_DOCUMENTS_LIST_UPDATED = 'CATALOG_DOCUMENTS_LIST_UPDATED'

Защищенные члены
	includeModule ()
	sendItemEvent (string $eventName, array $items, ?array $params=null)
	getTag (?array $params=null)
	prepareItems (array &$items, string $action=self::EVENT_DOCUMENT_UPDATED)
	sendEvent (array $items, string $eventId, array $params=[])
	prepareItemEventParams (array $items, string $eventName='')
	getSubscribedUserIdsWithItemPermissions (array $items, string $eventName)
	filterUserIdsWhoCanViewItem (array $items, array $userIds)
	subscribeOnEvent (string $tag, bool $immediate=true)
	sendUserEvent (string $tag, array $params=[], ?array $userIds=null)

Защищенные статические члены
static	getEventName (string $eventName, $entityType='')
static	getItemEventName (string $eventName, string $entityType, int $itemId)

Защищенные данные
const	EVENT_DOCUMENT_ADDED = 'ADDED'
const	EVENT_DOCUMENT_UPDATED = 'UPDATED'
const	EVENT_DOCUMENT_DELETED = 'DELETED'
	$eventIds = []
	$isEnabled = false
	$isMobileIncluded = false

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

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

Конструктор(ы)

__construct()

__construct

(

)

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

Методы

filterUserIdsWhoCanViewItem()

filterUserIdsWhoCanViewItem ( array  $items, array  $userIds  )

protected

Аргументы

array	$items
array	$userIds

Возвращает

array

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

getEventName()

static getEventName ( string  $eventName,   $entityType = ''  )

staticprotected

Аргументы

string	$eventName
string	$entityType

Возвращает

string

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

getInstance()

static getInstance ( )

static

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

getItemEventName()

static getItemEventName ( string  $eventName, string  $entityType, int  $itemId  )

staticprotected

Аргументы

string	$eventName
string	$entityType
int	$itemId

Возвращает

string|null

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

getSubscribedUserIdsWithItemPermissions()

getSubscribedUserIdsWithItemPermissions ( array  $items, string  $eventName  )

protected

Аргументы

array	$items
string	$eventName

Возвращает

array

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

getTag()

getTag ( ?array  $params = null )

protected

Аргументы

array | null

$params

Возвращает

string

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

includeModule()

includeModule ( )

protected

Возвращает

bool

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

isEnabled()

isEnabled

(

)

Возвращает

bool

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

onGetDependentModule()

static onGetDependentModule ( )

static

Возвращает

array

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

prepareItemEventParams()

prepareItemEventParams ( array  $items, string  $eventName = ''  )

protected

Аргументы

array	$items
string	$eventName

Возвращает

array

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

prepareItems()

prepareItems ( array &  $items, string  $action = self::EVENT_DOCUMENT_UPDATED  )

protected

Аргументы

array	$items
string	$action

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

sendDocumentAddedEvent()

sendDocumentAddedEvent	(	array	$items,
		?array	$params = null
	)

Аргументы

array	$items
array | null	$params

Возвращает

bool

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

sendDocumentDeletedEvent()

sendDocumentDeletedEvent	(	array	$items,
		?array	$params = null
	)

Аргументы

array	$items
array | null	$params

Возвращает

bool

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

sendDocumentsUpdatedEvent()

sendDocumentsUpdatedEvent	(	array	$items,
		?array	$params = null
	)

Аргументы

array	$items
array | null	$params

Возвращает

bool

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

sendEvent()

sendEvent ( array  $items, string  $eventId, array  $params = []  )

protected

Аргументы

array	$items
string	$eventId
array	$params

Возвращает

bool

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

sendItemEvent()

sendItemEvent ( string  $eventName, array  $items, ?array  $params = null  )

protected

Аргументы

string	$eventName
array	$items
array | null	$params

Возвращает

bool

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

sendUserEvent()

sendUserEvent ( string  $tag, array  $params = [], ?array  $userIds = null  )

protected

Аргументы

string	$tag
array	$params
array | null	$userIds

Возвращает

bool

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

subscribeOnEvent()

subscribeOnEvent ( string  $tag, bool  $immediate = true  )

protected

Аргументы

string	$tag
bool	$immediate

Возвращает

string|null

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

Данные класса

$eventIds

$eventIds = []

protected

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

$isEnabled

$isEnabled = false

protected

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

$isMobileIncluded

$isMobileIncluded = false

protected

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

EVENT_DOCUMENT_ADDED

const EVENT_DOCUMENT_ADDED = 'ADDED'

protected

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

EVENT_DOCUMENT_DELETED

const EVENT_DOCUMENT_DELETED = 'DELETED'

protected

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

EVENT_DOCUMENT_UPDATED

const EVENT_DOCUMENT_UPDATED = 'UPDATED'

protected

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

EVENT_DOCUMENTS_LIST_UPDATED

const EVENT_DOCUMENTS_LIST_UPDATED = 'CATALOG_DOCUMENTS_LIST_UPDATED'

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

MODULE_ID

const MODULE_ID = 'catalog'

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