MessageParam
Message param service.
Table of Contents
Methods
- __construct() : mixed
- getParam() : mixed|array<string|int, mixed>|null
- Returns message param and its value.
- getParams() : array<string|int, mixed>|null
- Returns message param list and their values.
- setParam() : bool
- Sets new param value and sends pull.
- setParams() : bool
- Sets new params values and sends pull.
Methods
__construct()
public
__construct() : mixed
getParam()
Returns message param and its value.
public
getParam(int $messageId, string $name[, bool $withDefault = false ]) : mixed|array<string|int, mixed>|null
Parameters
- $messageId : int
-
Message Id.
- $name : string
-
Parameter name.
- $withDefault : bool = false
-
Supply default value.
Return values
mixed|array<string|int, mixed>|nullgetParams()
Returns message param list and their values.
public
getParams(int $messageId[, bool $withDefault = false ]) : array<string|int, mixed>|null
Parameters
- $messageId : int
-
Message Id.
- $withDefault : bool = false
-
Supply default value.
Return values
array<string|int, mixed>|nullsetParam()
Sets new param value and sends pull.
public
setParam(int $messageId, string $name, mixed $value[, bool $sendPull = true ]) : bool
Parameters
- $messageId : int
-
Message Id.
- $name : string
-
Parameter name.
- $value : mixed
-
Parameter value.
- $sendPull : bool = true
-
Allow to send pull.
Return values
boolsetParams()
Sets new params values and sends pull.
public
setParams(int $messageId, array<string|int, mixed> $values[, bool $sendPull = true ]) : bool
Parameters
- $messageId : int
-
Message Id.
- $values : array<string|int, mixed>
-
Key - value pairs of parameter's value.
- $sendPull : bool = true
-
Allow to send pull.