Message.php
inherited
Classes
RouterOS is the flag product of the company MikroTik and is a powerful router software. One of its many abilities is to allow control over it via an API. This package provides a client for that API, in turn allowing you to use PHP to control RouterOS hosts.
PHP version 5
- Author
- Vasil Rangelov
- Category
- Net
- Copyright
- 2011 Vasil Rangelov
- License
- LGPL License 2.1
- Link
- http://pear2.php.net/PEAR2_Net_RouterOS
- Package
- PEAR2_Net_RouterOS
- Version
- 1.0.0b3
\PEAR2\Net\RouterOS\Message
- Children
- \PEAR2\Net\RouterOS\Request
- \PEAR2\Net\RouterOS\Response
- Author
- Vasil Rangelov
- Category
- Net
- License
- LGPL License 2.1
- Link
- http://pear2.php.net/PEAR2_Net_RouterOS
Properties
string $_tag = nullAn optional tag to associate the message with.
nullDetails- Type
- string
array $arguments = array()An array with message arguments. Keys are the names of the arguments, array values are values for the corresponding argument.
array()Details- Type
- array
Methods
__invoke(string $name = null) : string | arrayA shorthand gateway.
This is a magic PHP method that allows you to call the object as a function. Depending on the argument given, one of the other functions in the class is invoked and its returned value is returned by this function.
| Name | Type | Description |
|---|---|---|
| $name | string | The name of an argument to get the value of, or NULL to get all arguments as an array. |
| Type | Description |
|---|---|
| string | array | The value of the specified argument, or an array of all arguments if NULL is provided. |
getAllArguments() : arrayGets all arguments in an array.
| Type | Description |
|---|---|
| array | An array with the keys as argument names, and the array values as argument values. |
- See
- \PEAR2\Net\RouterOS\getArgument()
- See
- \PEAR2\Net\RouterOS\setArgument()
getArgument(string $name) : string | resourceGets the value of an argument.
| Name | Type | Description |
|---|---|---|
| $name | string | The name of the argument. |
| Type | Description |
|---|---|
| string | resource | The value of the specified argument. Returns NULL if such an argument is not set. |
- See
- \PEAR2\Net\RouterOS\setArgument()
getTag() : stringGets the tag that the message is associated with.
| Type | Description |
|---|---|
| string | The current tag or NULL if there isn't a tag. |
- See
- \PEAR2\Net\RouterOS\setTag()
removeAllArguments() : \PEAR2\Net\RouterOS\self | \PEAR2\Net\RouterOS\MessageRemoves all arguments from the message.
| Type | Description |
|---|---|
| \PEAR2\Net\RouterOS\self | \PEAR2\Net\RouterOS\Message | The message object. |
sanitizeArgumentName(mixed $name) : stringSanitizes a name of an argument (message or query one).
| Name | Type | Description |
|---|---|---|
| $name | mixed | The name to sanitize. |
| Type | Description |
|---|---|
| string | The sanitized name. |
sanitizeArgumentValue(mixed $value) : stringSanitizes a value of an argument (message or query one).
| Name | Type | Description |
|---|---|---|
| $value | mixed | The value to sanitize. |
| Type | Description |
|---|---|
| string | The sanitized value. |
setArgument(string $name, string $value = '') : \PEAR2\Net\RouterOS\self | \PEAR2\Net\RouterOS\MessageSets an argument for the message.
| Name | Type | Description |
|---|---|---|
| $name | string | Name of the argument. |
| $value | string | Value of the argument. Setting the value to NULL removes an argument of this name. |
| Type | Description |
|---|---|
| \PEAR2\Net\RouterOS\self | \PEAR2\Net\RouterOS\Message | The message object. |
- See
- \PEAR2\Net\RouterOS\getArgument()
setTag(string $tag) : \PEAR2\Net\RouterOS\self | \PEAR2\Net\RouterOS\MessageSets the tag to associate the request with.
Sets the tag to associate the message with. Setting NULL erases the currently set tag.
| Name | Type | Description |
|---|---|---|
| $tag | string | The tag to set. |
| Type | Description |
|---|---|
| \PEAR2\Net\RouterOS\self | \PEAR2\Net\RouterOS\Message | The message object. |
- See
- \PEAR2\Net\RouterOS\getTag()