\Message.php

• Global
• Classes
  • \PEAR2\Net\RouterOS\Message

Show: inherited

Author

Vasil Rangelov  

Category

Net  

Copyright

2011 Vasil Rangelov  

License

LGPL License 2.1  

Link

http://netrouteros.sourceforge.net/  

Package

PEAR2_Net_RouterOS  

Version

1.0.0b1  

\PEAR2\Net\RouterOS\Message

jump to top

Package: PEAR2\Net\RouterOS

Represents a RouterOS message.

Children

\PEAR2\Net\RouterOS\Request

\PEAR2\Net\RouterOS\Response

Author

Vasil Rangelov  

Category

Net  

License

LGPL License 2.1  

Link

http://netrouteros.sourceforge.net/  

Properties

string  $_tag= 'null'

An optional tag to associate the message with.

Default valuenullDetails

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.

Default valuearray(Details

Type

array

Methods

getAllArguments( ) : array

Gets all arguments in an array.

Returns

Type	Description
array	An array with the keys as argument names, and the array values as argument values.

Details

See

\PEAR2\Net\RouterOS\getArgument()  

See

\PEAR2\Net\RouterOS\setArgument()  

getArgument( string $name ) : string|resource

Gets the value of an argument.

Parameters

Name	Type	Description
$name	string	The name of the argument.

Returns

Type	Description
string|resource	The value of the specified argument. Returns NULL if such an argument is not set.

Details

See

\PEAR2\Net\RouterOS\setArgument()  

getTag( ) : string

Gets the tag that the message is associated with.

Returns

Type	Description
string	The current tag or NULL if there isn't a tag.

Details

See

\PEAR2\Net\RouterOS\setTag()  

removeAllArguments( ) : \PEAR2\Net\RouterOS\Message

Removes all arguments from the message.

Returns

Type	Description
\PEAR2\Net\RouterOS\Message	The message object.

sanitizeArgumentName( mixed $name ) : string

static

Sanitizes a name of an argument (message or query one).

Parameters

Name	Type	Description
$name	mixed	The name to sanitize.

Returns

Type	Description
string	The sanitized name.

sanitizeArgumentValue( mixed $value ) : string

static

Sanitizes a value of an argument (message or query one).

Parameters

Name	Type	Description
$value	mixed	The value to sanitize.

Returns

Type	Description
string	The sanitized value.

setArgument( string $name, string $value = null ) : \PEAR2\Net\RouterOS\Message

Sets an argument for the message.

Parameters

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.

Returns

Type	Description
\PEAR2\Net\RouterOS\Message	The message object.

Details

See

\PEAR2\Net\RouterOS\getArgument()  

setTag( string $tag ) : \PEAR2\Net\RouterOS\Message

Sets the tag to associate the request with.

Sets the tag to associate the message with. Setting NULL erases the currently set tag.

Parameters

Name	Type	Description
$tag	string	The tag to set.

Returns

Type	Description
\PEAR2\Net\RouterOS\Message	The message object.

Details

See

\PEAR2\Net\RouterOS\getTag()