Класс Notification

Граф наследования:Notification:

Открытые члены
	__construct (string $module, string $name)
	setModule (string $module)
	setName (string $name)
	isAllowed (int $userId, string $type)
	filterAllowedUsers (array $userList, string $type)
	checkDisableFeature (string $feature)
	getDefaultFeature (string $feature)
	getLifetime ()
	getValue (int $userId, string $type)

Открытые статические члены
static	getDefaultSettings ()
static	getSimpleNotifySettings (array $generalSettings)
static	getUserSettings (int $userId)
static	getGroupSettings (int $groupId)
static	updateGroupSettings (int $groupId, array $settings)
static	setSettings (int $groupId, array $settings=[], bool $forInitialize=false)
static	getEventNames ()
static	decodeSettings (array $rowSettings)
static	encodeSettings (array $settings)
Открытые статические члены унаследованные от Base
static	setSettings (int $groupId, array $settings)

Открытые атрибуты
const	SITE = 'site'
const	MAIL = 'mail'
const	XMPP = 'xmpp'
const	PUSH = 'push'

Защищенные данные
const	ENTITY = 'no'
const	MODULE = 1
const	NAME = 2
const	TYPE = 3
Защищенные данные унаследованные от Base
const	ENTITY = 'ba'
const	SEPARATOR = '|'
const	CHUNK_LENGTH = 1000

Статические защищенные данные
static	$defaultSettings = []

Дополнительные унаследованные члены

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

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

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

__construct()

__construct	(	string	$module,
		string	$name )

Аргументы

string	$module
string	$name

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

Методы

checkDisableFeature()

checkDisableFeature

(

string

$feature

)

Аргументы

string

$feature

Возвращает

bool

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

decodeSettings()

static decodeSettings ( array $rowSettings )

static

Converts a flat array of templates into an array of notification schemes

Аргументы

array

$rowSettings

Возвращает

array

Переопределяет метод предка Base.

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

encodeSettings()

static encodeSettings ( array $settings )

static

Converts notification settings into a flat array, in which the key is a template, and the value is the value of the setting

Аргументы

array

$settings

Возвращает

array

Переопределяет метод предка Base.

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

filterAllowedUsers()

filterAllowedUsers	(	array	$userList,
		string	$type )

Filters the list of users to whom can send a notification

Исключения

SqlQueryException
ArgumentException
SystemException

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

getDefaultFeature()

getDefaultFeature

(

string

$feature

)

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

getDefaultSettings()

static getDefaultSettings ( )

static

The method get the full notification scheme (from all modules)

Возвращает

array

Переопределяет метод предка Base.

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

getEventNames()

static getEventNames ( )

static

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

getGroupSettings()

static getGroupSettings ( int $groupId )

static

Gets the group's notification settings

Исключения

ObjectPropertyException
SystemException
ArgumentException

Переопределяет метод предка Base.

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

getLifetime()

getLifetime

(

)

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

getSimpleNotifySettings()

static getSimpleNotifySettings ( array $generalSettings )

static

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

getUserSettings()

static getUserSettings ( int $userId )

static

Gets the user's notification settings

Исключения

ArgumentException
ObjectPropertyException
SystemException

Переопределяет метод предка Base.

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

getValue()

getValue	(	int	$userId,
		string	$type )

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

isAllowed()

isAllowed	(	int	$userId,
		string	$type )

Determines whether a notification can be sent to the user

Исключения

SqlQueryException

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

setModule()

setModule

(

string

$module

)

Аргументы

string

$module

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

setName()

setName

(

string

$name

)

Аргументы

string

$name

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

setSettings()

static setSettings ( int $groupId, array $settings = [], bool $forInitialize = false )

static

Sets the group's notification settings

Исключения

SystemException
ArgumentException

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

updateGroupSettings()

static updateGroupSettings ( int $groupId, array $settings )

static

Updates the group's notification settings

Исключения

SystemException
ArgumentException

Переопределяет метод предка Base.

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

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

$defaultSettings

$defaultSettings = []

staticprotected

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

ENTITY

const ENTITY = 'no'

protected

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

MAIL

const MAIL = 'mail'

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

MODULE

const MODULE = 1

protected

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

NAME

const NAME = 2

protected

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

PUSH

const PUSH = 'push'

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

SITE

const SITE = 'site'

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

TYPE

const TYPE = 3

protected

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

XMPP

const XMPP = 'xmpp'

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