PHP Class lithium\net\Message

See link: http://tools.ietf.org/html/rfc3986#section-1.1.1
See link: http://en.wikipedia.org/wiki/URI_scheme#Generic_syntax
Inheritance: extends lithium\core\Object
Datei anzeigen Open project: unionofrad/lithium Class Usage Examples

Public Properties

Property Type Description
$body mixed The body of the message.
$host string The hostname for this endpoint.
$password string The password for this endpoint.
$path string Absolute path of the request.
$port string The port for this endpoint.
$scheme string The URI scheme.
$username string The username for this endpoint.

Public Methods

Method Description
__construct ( array $config = [] ) : void Constructor Adds config values to the public properties when a new object is created.
__toString ( ) : string Magic method to convert object to string.
body ( mixed $data = null, array $options = [] ) : array Add body parts and compile the message body.
to ( string $format, array $options = [] ) : mixed Converts the data in the record set to a different format, i.e. an array. Available options: array, url, context, or string.

Method Details

__construct() public method

Constructor Adds config values to the public properties when a new object is created.
public __construct ( array $config = [] ) : void
$config array Available configuration options are: - `'scheme'` _string_: 'tcp' - `'host'` _string_: 'localhost' - `'port'` _integer_: null - `'username'` _string_: null - `'password'` _string_: null - `'path'` _string_: null - `'body'` _mixed_: null
return void

__toString() public method

Magic method to convert object to string.
public __toString ( ) : string
return string

body() public method

Add body parts and compile the message body.
public body ( mixed $data = null, array $options = [] ) : array
$data mixed
$options array - `'buffer'` _integer_: split the body string
return array

to() public method

Converts the data in the record set to a different format, i.e. an array. Available options: array, url, context, or string.
public to ( string $format, array $options = [] ) : mixed
$format string Format to convert to.
$options array
return mixed

Property Details

$body public_oe property

The body of the message.
public mixed $body
return mixed

$host public_oe property

The hostname for this endpoint.
public string $host
return string

$password public_oe property

The password for this endpoint.
public string $password
return string

$path public_oe property

Absolute path of the request.
public string $path
return string

$port public_oe property

The port for this endpoint.
public string $port
return string

$scheme public_oe property

The URI scheme.
public string $scheme
return string

$username public_oe property

The username for this endpoint.
public string $username
return string