Класс MessageParam

Открытые члены
	__construct ()
	getParams (int $messageId, bool $withDefault=false)
	getParam (int $messageId, string $name, bool $withDefault=false)
	setParams (int $messageId, array $values, bool $sendPull=true)
	setParam (int $messageId, string $name, $value, bool $sendPull=true)

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

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

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

__construct()

__construct

(

)

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

Методы

getParam()

getParam	(	int	$messageId,
		string	$name,
		bool	$withDefault = false )

Returns message param and its value.

Аргументы

int	$messageId	Message Id.
string	$name	Parameter name.
bool	$withDefault	Supply default value.

Возвращает

mixed|array|null

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

getParams()

getParams	(	int	$messageId,
		bool	$withDefault = false )

Returns message param list and their values.

Аргументы

int	$messageId	Message Id.
bool	$withDefault	Supply default value.

Возвращает

array|null

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

setParam()

setParam	(	int	$messageId,
		string	$name,
			$value,
		bool	$sendPull = true )

Sets new param value and sends pull.

Аргументы

int	$messageId	Message Id.
string	$name	Parameter name.
mixed	$value	Parameter value.
bool	$sendPull	Allow to send pull.

Возвращает

bool

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

setParams()

setParams	(	int	$messageId,
		array	$values,
		bool	$sendPull = true )

Sets new params values and sends pull.

Аргументы

int	$messageId	Message Id.
array	$values	Key - value pairs of parameter's value.
bool	$sendPull	Allow to send pull.

Возвращает

bool

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