This is the abstract base class for both the Request and Response objects. More...

Inheritance diagram for Sabre\HTTP\Message:

Collaboration diagram for Sabre\HTTP\Message:

Public Member Functions
	getBodyAsStream ()
	Returns the body as a readable stream resource. More...

	getBodyAsString ()
	Returns the body as a string. More...

	getBody ()
	Returns the message body, as it's internal representation. More...

	setBody ($body)
	Replaces the body resource with a new stream or string. More...

	getHeaders ()
	Returns all the HTTP headers as an array. More...

	hasHeader ($name)
	Will return true or false, depending on if a HTTP header exists. More...

	getHeader ($name)
	Returns a specific HTTP header, based on it's name. More...

	getHeaderAsArray ($name)
	Returns a HTTP header as an array. More...

	setHeader ($name, $value)
	Updates a HTTP header. More...

	setHeaders (array $headers)
	Sets a new set of HTTP headers. More...

	addHeader ($name, $value)
	Adds a HTTP header. More...

	addHeaders (array $headers)
	Adds a new set of HTTP headers. More...

	removeHeader ($name)
	Removes a HTTP header. More...

	setHttpVersion ($version)
	Sets the HTTP version. More...

	getHttpVersion ()
	Returns the HTTP version. More...

	getBodyAsStream ()
	Returns the body as a readable stream resource. More...

	getBodyAsString ()
	Returns the body as a string. More...

	getBody ()
	Returns the message body, as it's internal representation. More...

	setBody ($body)
	Updates the body resource with a new stream. More...

	getHeaders ()
	Returns all the HTTP headers as an array. More...

	hasHeader ($name)
	Will return true or false, depending on if a HTTP header exists. More...

	getHeader ($name)
	Returns a specific HTTP header, based on it's name. More...

	getHeaderAsArray ($name)
	Returns a HTTP header as an array. More...

	setHeader ($name, $value)
	Updates a HTTP header. More...

	setHeaders (array $headers)
	Sets a new set of HTTP headers. More...

	addHeader ($name, $value)
	Adds a HTTP header. More...

	addHeaders (array $headers)
	Adds a new set of HTTP headers. More...

	removeHeader ($name)
	Removes a HTTP header. More...

	setHttpVersion ($version)
	Sets the HTTP version. More...

	getHttpVersion ()
	Returns the HTTP version. More...

Protected Attributes
	$body

	$headers = []

	$httpVersion = '1.1'

Detailed Description

This is the abstract base class for both the Request and Response objects.

This object contains a few simple methods that are shared by both.

Copyright: Copyright (C) fruux GmbH (https://fruux.com/)

Author: Evert Pot (http://evertpot.com/) @license http://sabre.io/license/ Modified BSD License

Definition at line 14 of file Message.php.

Member Function Documentation

◆ addHeader()

Sabre\HTTP\Message::addHeader	(	$name,
		$value
	)

Adds a HTTP header.

This method will not overwrite any existing HTTP header, but instead add another value. Individual values can be retrieved with getHeadersAsArray.

Parameters

string	$name
string	$value

Returns: void

Implements Sabre\HTTP\MessageInterface.

Definition at line 235 of file Message.php.

                                      {
 
        $lName = strtolower($name);
        if (isset($this->headers[$lName])) {
            $this->headers[$lName][1] = array_merge(
                $this->headers[$lName][1],
                (array)$value
            );
        } else {
            $this->headers[$lName] = [
                $name,
                (array)$value
            ];
        }
 
    }

References $name.

Referenced by Sabre\HTTP\Message\addHeaders().

Here is the caller graph for this function:

◆ addHeaders()

Sabre\HTTP\Message::addHeaders ( array $headers )

Adds a new set of HTTP headers.

Any existing headers will not be overwritten.

Parameters

array $headers

Returns: void

Implements Sabre\HTTP\MessageInterface.

Definition at line 260 of file Message.php.

                                        {
 
        foreach ($headers as $name => $value) {
            $this->addHeader($name, $value);
        }
 
    }

References Sabre\HTTP\Message\$headers, $name, and Sabre\HTTP\Message\addHeader().

Here is the call graph for this function:

◆ getBody()

Sabre\HTTP\Message::getBody ( )

Returns the message body, as it's internal representation.

This could be either a string or a stream.

Returns: resource|string

Implements Sabre\HTTP\MessageInterface.

Definition at line 92 of file Message.php.

                       {
 
        return $this->body;
 
    }

References Sabre\HTTP\Message\$body.

Referenced by Sabre\HTTP\Message\getBodyAsStream(), and Sabre\HTTP\Message\getBodyAsString().

Here is the caller graph for this function:

◆ getBodyAsStream()

Sabre\HTTP\Message::getBodyAsStream ( )

Returns the body as a readable stream resource.

Note that the stream may not be rewindable, and therefore may only be read once.

Returns: resource

Implements Sabre\HTTP\MessageInterface.

Definition at line 47 of file Message.php.

                               {
 
        $body = $this->getBody();
        if (is_string($body) || is_null($body)) {
            $stream = fopen('php://temp', 'r+');
            fwrite($stream, $body);
            rewind($stream);
            return $stream;
        }
        return $body;
 
    }

References Sabre\HTTP\Message\$body, GuzzleHttp\Psr7\$stream, and Sabre\HTTP\Message\getBody().

Here is the call graph for this function:

◆ getBodyAsString()

Sabre\HTTP\Message::getBodyAsString ( )

Returns the body as a string.

Note that because the underlying data may be based on a stream, this method could only work correctly the first time.

Returns: string

Implements Sabre\HTTP\MessageInterface.

Definition at line 68 of file Message.php.

                               {
 
        $body = $this->getBody();
        if (is_string($body)) {
            return $body;
        }
        if (is_null($body)) {
            return '';
        }
        $contentLength = $this->getHeader('Content-Length');
        if (is_int($contentLength) || ctype_digit($contentLength)) {
            return stream_get_contents($body, $contentLength);
        } else {
            return stream_get_contents($body);
        }
    }

References Sabre\HTTP\Message\$body, $contentLength, Sabre\HTTP\Message\getBody(), and Sabre\HTTP\Message\getHeader().

Referenced by Sabre\HTTP\Request\__toString(), and Sabre\HTTP\Response\__toString().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getHeader()

Sabre\HTTP\Message::getHeader ( $name )

Returns a specific HTTP header, based on it's name.

The name must be treated as case-insensitive. If the header does not exist, this method must return null.

If a header appeared more than once in a HTTP request, this method will concatenate all the values with a comma.

Note that this not make sense for all headers. Some, such as Set-Cookie cannot be logically combined with a comma. In those cases you should use getHeaderAsArray().

Parameters

string $name

Returns: string|null

Implements Sabre\HTTP\MessageInterface.

Definition at line 154 of file Message.php.

                              {
 
        $name = strtolower($name);
 
        if (isset($this->headers[$name])) {
            return implode(',', $this->headers[$name][1]);
        }
        return null;
 
    }

References $name.

Referenced by Sabre\HTTP\Message\getBodyAsString().

Here is the caller graph for this function:

◆ getHeaderAsArray()

Sabre\HTTP\Message::getHeaderAsArray ( $name )

Returns a HTTP header as an array.

For every time the HTTP header appeared in the request or response, an item will appear in the array.

If the header did not exists, this method will return an empty array.

Parameters

string $name

Returns: string[]

Implements Sabre\HTTP\MessageInterface.

Definition at line 176 of file Message.php.

                                     {
 
        $name = strtolower($name);
 
        if (isset($this->headers[$name])) {
            return $this->headers[$name][1];
        }
 
        return [];
 
    }

References $name.

◆ getHeaders()

Sabre\HTTP\Message::getHeaders ( )

Returns all the HTTP headers as an array.

Every header is returned as an array, with one or more values.

Returns: array

Implements Sabre\HTTP\MessageInterface.

Definition at line 116 of file Message.php.

                          {
 
        $result = [];
        foreach ($this->headers as $headerInfo) {
            $result[$headerInfo[0]] = $headerInfo[1];
        }
        return $result;
 
    }

References $result.

Referenced by Sabre\HTTP\Request\__toString(), and Sabre\HTTP\Response\__toString().

Here is the caller graph for this function:

◆ getHttpVersion()

Sabre\HTTP\Message::getHttpVersion ( )

Returns the HTTP version.

Returns: string

Implements Sabre\HTTP\MessageInterface.

Definition at line 309 of file Message.php.

                              {
 
        return $this->httpVersion;
 
    }

References Sabre\HTTP\Message\$httpVersion.

◆ hasHeader()

Sabre\HTTP\Message::hasHeader ( $name )

Will return true or false, depending on if a HTTP header exists.

Parameters

string $name

Returns: bool

Implements Sabre\HTTP\MessageInterface.

Definition at line 132 of file Message.php.

                              {
 
        return isset($this->headers[strtolower($name)]);
 
    }

References $name.

◆ removeHeader()

Sabre\HTTP\Message::removeHeader ( $name )

Removes a HTTP header.

The specified header name must be treated as case-insensitive. This method should return true if the header was successfully deleted, and false if the header did not exist.

Parameters

string $name

Returns: bool

Implements Sabre\HTTP\MessageInterface.

Definition at line 279 of file Message.php.

                                 {
 
        $name = strtolower($name);
        if (!isset($this->headers[$name])) {
            return false;
        }
        unset($this->headers[$name]);
        return true;
 
    }

References $name.

◆ setBody()

Sabre\HTTP\Message::setBody ( $body )

Replaces the body resource with a new stream or string.

Parameters

resource | string $body

Implements Sabre\HTTP\MessageInterface.

Definition at line 103 of file Message.php.

                            {
 
        $this->body = $body;
 
    }

References Sabre\HTTP\Message\$body.

Referenced by Sabre\HTTP\Request\__construct(), and Sabre\HTTP\Response\__construct().

Here is the caller graph for this function:

◆ setHeader()

Sabre\HTTP\Message::setHeader	(	$name,
		$value
	)

Updates a HTTP header.

The case-sensitivity of the name value must be retained as-is.

If the header already existed, it will be overwritten.

Parameters

string	$name
string \| string[]	$value

Returns: void

Implements Sabre\HTTP\MessageInterface.

Definition at line 199 of file Message.php.

                                      {
 
        $this->headers[strtolower($name)] = [$name, (array)$value];
 
    }

References $name.

Referenced by Sabre\HTTP\Message\setHeaders().

Here is the caller graph for this function:

◆ setHeaders()

Sabre\HTTP\Message::setHeaders ( array $headers )

Sets a new set of HTTP headers.

The headers array should contain headernames for keys, and their value should be specified as either a string or an array.

Any header that already existed will be overwritten.

Parameters

array $headers

Returns: void

Implements Sabre\HTTP\MessageInterface.

Definition at line 216 of file Message.php.

                                        {
 
        foreach ($headers as $name => $value) {
            $this->setHeader($name, $value);
        }
 
    }

References Sabre\HTTP\Message\$headers, $name, and Sabre\HTTP\Message\setHeader().

Referenced by Sabre\HTTP\Request\__construct(), and Sabre\HTTP\Response\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setHttpVersion()

Sabre\HTTP\Message::setHttpVersion ( $version )

Sets the HTTP version.

Should be 1.0 or 1.1.

Parameters

string $version

Returns: void

Implements Sabre\HTTP\MessageInterface.

Definition at line 298 of file Message.php.

                                      {
 
        $this->httpVersion = $version;
 
    }

References $version.

Field Documentation

◆ $body

Sabre\HTTP\Message::$body

protected

Definition at line 23 of file Message.php.

Referenced by Sabre\HTTP\Request\__construct(), Sabre\HTTP\Response\__construct(), Sabre\HTTP\Message\getBody(), Sabre\HTTP\Message\getBodyAsStream(), Sabre\HTTP\Message\getBodyAsString(), and Sabre\HTTP\Message\setBody().

◆ $headers

Sabre\HTTP\Message::$headers = []

protected

Definition at line 30 of file Message.php.

Referenced by Sabre\HTTP\Request\__construct(), Sabre\HTTP\Response\__construct(), Sabre\HTTP\Message\addHeaders(), and Sabre\HTTP\Message\setHeaders().

◆ $httpVersion

Sabre\HTTP\Message::$httpVersion = '1.1'

protected

Definition at line 37 of file Message.php.

Referenced by Sabre\HTTP\Message\getHttpVersion().

The documentation for this class was generated from the following file:

libs/composer/vendor/sabre/http/lib/Message.php

Public Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ addHeader()

◆ addHeaders()

◆ getBody()

◆ getBodyAsStream()

◆ getBodyAsString()

◆ getHeader()

◆ getHeaderAsArray()

◆ getHeaders()

◆ getHttpVersion()

◆ hasHeader()

◆ removeHeader()

◆ setBody()

◆ setHeader()

◆ setHeaders()

◆ setHttpVersion()

Field Documentation

◆ $body

◆ $headers

◆ $httpVersion