#class http\Message
 implements Countable, Serializable, Iterator

The message class builds the foundation for any request and response message.

See http\Client\Request and http\Client\Response, as well as http\Env\Request and http\Env\Response.

Constants:#

• TYPE_NONE#
  No specific type of message.
• TYPE_REQUEST#
  A request message.
• TYPE_RESPONSE#
  A response message.

Properties:#

• protected int $type# = http\Message::TYPE_NONE
  The message type. See http\Message::TYPE_* constants.
• protected http\Message\Body $body# = NULL
  The message's body.
• protected string $requestMethod# = ""
  The request method if the message is of type request.
• protected string $requestUrl# = ""
  The request url if the message is of type request.
• protected string $responseStatus# = ""
  The response status phrase if the message is of type response.
• protected int $responseCode# = 0
  The response code if the message is of type response.
• protected string $httpVersion# = NULL
  A custom HTTP protocol version.
• protected array $headers# = NULL
  Any message headers.
• protected http\Message $parentMessage#
  Any parent message.

Functions:#

• Message::__construct#

  Create a new HTTP message.

  void http\Message::__construct([mixed $message = NULL[, bool $greedy = true])

• Message::__toString#

  Retrieve the message serialized to a string.

  string http\Message::__toString()

• Message::addBody#

  Append the data of $body to the message's body.

  http\Message http\Message::addBody(http\Message\Body $body)

• Message::addHeader#

  Add an header, appending to already existing headers.

  http\Message http\Message::addHeader(string $name, mixed $value)

• Message::addHeaders#

  Add headers, optionally appending values, if header keys already exist.

  http\Message http\Message::addHeaders(array $headers[, bool $append = false])

• Message::count#

  Implements Countable.

  int http\Message::count()

• Message::current#

  Implements iterator.

  http\Message http\Message::current()

• Message::detach#

  Detach a clone of this message from any message chain.

  http\Message http\Message::detach()

• Message::getBody#

  Retrieve the message's body.

  http\Message\Body http\Message::getBody()

• Message::getHeader#

  Retrieve a single header, optionally hydrated into a http\Header extending class.

  mixed http\Message::getHeader(string $header[, string $into_class = NULL])

• Message::getHeaders#

  Retrieve all message headers.

  array http\Message::getHeaders()

• Message::getHttpVersion#

  Retrieve the HTTP protocol version of the message.

  string http\Message::getHttpVersion()

• Message::getInfo#

  Retrieve the first line of a request or response message.

  string http\Message::getInfo()

• Message::getParentMessage#

  Retrieve any parent message.

  http\Message http\Message::getParentMessage()

• Message::getRequestMethod#

  Retrieve the request method of the message.

  string http\Message::getRequestMethod()

• Message::getRequestUrl#

  Retrieve the request URL of the message.

  string http\Message::getRequestUrl()

• Message::getResponseCode#

  Retrieve the response code of the message.

  int http\Message::getResponseCode()

• Message::getResponseStatus#

  Retrieve the response status of the message.

  string http\Message::getResponseStatus()

• Message::getType#

  Retrieve the type of the message.

  int http\Message::getType()

• Message::isMultipart#

  Check whether this message is a multipart message based on it's content type.

  bool http\Message::isMultipart([string &$boundary = NULL])

• Message::key#

  Implements Iterator.

  int http\Message::key()

• Message::next#

  Implements Iterator.

  void http\Message::next()

• Message::prepend#

  Prepend message(s) $message to this message, or the top most message of this message chain.

  http\Message http\Message::prepend(http\Message $message[, bool $top = true])

• Message::reverse#

  Reverse the message chain and return the former top-most message.

  http\Message http\Messae::reverse()

• Message::rewind#

  Implements Iterator.

  void http\Message::rewind()

• Message::serialize#

  Implements Serializable.

  string http\Message::serialize()

• Message::setBody#

  Set the message's body.

  http\Message http\Message::setBody(http\Message\Body $body)

• Message::setHeader#

  Set a single header.

  http\Message http\Message::setHeader(string $header[, mixed $value = NULL])

• Message::setHeaders#

  Set the message headers.

  http\Message http\Message::setHeaders(array $headers = NULL)

• Message::setHttpVersion#

  Set the HTTP protocol version of the message.

  http\Message http\Message::setHttpVersion(string $http_version)

• Message::setInfo#

  Set the complete message info, i.e. type and response resp. request information, at once.

  http\Message http\Message::setInfo(string $http_info)

• Message::setRequestMethod#

  Set the request method of the message.

  http\Message http\Message::setRequestMethod(string $method)

• Message::setRequestUrl#

  Set the request URL of the message.

  http\Message http\Message::setRequestUrl(string $url)

• Message::setResponseCode#

  Set the response status code.

  http\Message http\Message::setResponseCode(int $response_code[, bool $strict = true])

• Message::setResponseStatus#

  Set the response status phrase.

  http\Message http\Message::setResponseStatus(string $response_status)

• Message::setType#

  Set the message type and reset the message info.

  http\Message http\Message::setType(int $type)

• Message::splitMultipartBody#

  Splits the body of a multipart message.

  http\Message http\Message::splitMultipartBody()

• Message::toCallback#

  Stream the message through a callback.

  http\Message http\Message::toCallback(callable $callback)

• Message::toStream#

  Stream the message into stream $stream, starting from $offset, streaming $maxlen at most.

  http\Message http\Message::toStream(resource $stream)

• Message::toString#

  Retrieve the message serialized to a string.

  string http\Message::toString([bool $include_parent = false])

• Message::unserialize#

  Implements Serializable.

  void http\Message::unserualize(string $data)

• Message::valid#

  Implements Iterator.

  bool http\Message::valid()

Namespaces, Interfaces and Classes:#

• Body#

  The message body, represented as a PHP (temporary) stream.

  class http\Message\Body implements Serializable

• Parser#

  The parser which is underlying http\Message.

  class http\Message\Parser