The Request class represents a single HTTP request. More...

Inheritance diagram for Sabre\HTTP\Request:

Collaboration diagram for Sabre\HTTP\Request:

Public Member Functions
	__construct ($method=null, $url=null, array $headers=null, $body=null)
	Creates the request object. More...

	getMethod ()
	Returns the current HTTP method. More...

	setMethod ($method)
	Sets the HTTP method. More...

	getUrl ()
	Returns the request url. More...

	setUrl ($url)
	Sets the request url. More...

	getQueryParameters ()
	Returns the list of query parameters. More...

	setAbsoluteUrl ($url)
	Sets the absolute url. More...

	getAbsoluteUrl ()
	Returns the absolute url. More...

	setBaseUrl ($url)
	Sets a base url. More...

	getBaseUrl ()
	Returns the current base url. More...

	getPath ()
	Returns the relative path. More...

	setPostData (array $postData)
	Sets the post data. More...

	getPostData ()
	Returns the POST data. More...

	getRawServerValue ($valueName)
	Returns an item from the _SERVER array. More...

	setRawServerData (array $data)
	Sets the _SERVER array. More...

	__toString ()
	Serializes the request object as a string. More...

Public Member Functions inherited from Sabre\HTTP\Message
	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...

	getMethod ()
	Returns the current HTTP method. More...

	setMethod ($method)
	Sets the HTTP method. More...

	getUrl ()
	Returns the request url. More...

	setUrl ($url)
	Sets the request url. More...

	getAbsoluteUrl ()
	Returns the absolute url. More...

	setAbsoluteUrl ($url)
	Sets the absolute url. More...

	getBaseUrl ()
	Returns the current base url. More...

	setBaseUrl ($url)
	Sets a base url. More...

	getPath ()
	Returns the relative path. More...

	getQueryParameters ()
	Returns the list of query parameters. More...

	getPostData ()
	Returns the POST data. More...

	setPostData (array $postData)
	Sets the post data. More...

	getRawServerValue ($valueName)
	Returns an item from the _SERVER array. More...

	setRawServerData (array $data)
	Sets the _SERVER array. More...

Protected Attributes
	$method

	$url

	$baseUrl = '/'

	$postData = []

	$rawServerData

Protected Attributes inherited from Sabre\HTTP\Message
	$body

	$headers = []

	$httpVersion = '1.1'

Detailed Description

The Request class represents a single HTTP request.

You can either simply construct the object from scratch, or if you need access to the current HTTP request, use Sapi::getRequest.

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 18 of file Request.php.

Constructor & Destructor Documentation

◆ __construct()

Sabre\HTTP\Request::__construct	(		$method = `null`,
			$url = `null`,
		array	$headers = `null`,
			$body = `null`
	)

Creates the request object.

Parameters

string	$method
string	$url
array	$headers
resource	$body

Definition at line 42 of file Request.php.

                                                                                           {
 
        if (is_array($method)) {
            throw new InvalidArgumentException('The first argument for this constructor should be a string or null, not an array. Did you upgrade from sabre/http 1.0 to 2.0?');
        }
        if (!is_null($method))      $this->setMethod($method);
        if (!is_null($url))         $this->setUrl($url);
        if (!is_null($headers))     $this->setHeaders($headers);
        if (!is_null($body))        $this->setBody($body);
 
    }

References Sabre\HTTP\Message\$body, Sabre\HTTP\Message\$headers, Sabre\HTTP\Request\$method, Sabre\HTTP\Request\$url, Sabre\HTTP\Message\setBody(), Sabre\HTTP\Message\setHeaders(), Sabre\HTTP\Request\setMethod(), and Sabre\HTTP\Request\setUrl().

Here is the call graph for this function:

Member Function Documentation

◆ __toString()

Sabre\HTTP\Request::__toString ( )

Serializes the request object as a string.

This is useful for debugging purposes.

Returns: string

Definition at line 296 of file Request.php.

                          {
 
        $out = $this->getMethod() . ' ' . $this->getUrl() . ' HTTP/' . $this->getHTTPVersion() . "\r\n";
 
        foreach ($this->getHeaders() as $key => $value) {
            foreach ($value as $v) {
                if ($key === 'Authorization') {
                    list($v) = explode(' ', $v, 2);
                    $v .= ' REDACTED';
                }
                $out .= $key . ": " . $v . "\r\n";
            }
        }
        $out .= "\r\n";
        $out .= $this->getBodyAsString();
 
        return $out;
 
    }

References $key, $out, Sabre\HTTP\Message\getBodyAsString(), Sabre\HTTP\Message\getHeaders(), Sabre\HTTP\Request\getMethod(), and Sabre\HTTP\Request\getUrl().

Here is the call graph for this function:

◆ getAbsoluteUrl()

Sabre\HTTP\Request::getAbsoluteUrl ( )

Returns the absolute url.

Returns: string

Implements Sabre\HTTP\RequestInterface.

Definition at line 136 of file Request.php.

                              {
 
        return $this->absoluteUrl;
 
    }

◆ getBaseUrl()

Sabre\HTTP\Request::getBaseUrl ( )

Returns the current base url.

Returns: string

Implements Sabre\HTTP\RequestInterface.

Definition at line 168 of file Request.php.

                          {
 
        return $this->baseUrl;
 
    }

References Sabre\HTTP\Request\$baseUrl.

Referenced by Sabre\HTTP\Request\getPath().

Here is the caller graph for this function:

◆ getMethod()

Sabre\HTTP\Request::getMethod ( )

Returns the current HTTP method.

Returns: string

Implements Sabre\HTTP\RequestInterface.

Definition at line 59 of file Request.php.

                         {
 
        return $this->method;
 
    }

References Sabre\HTTP\Request\$method.

Referenced by Sabre\HTTP\Request\__toString().

Here is the caller graph for this function:

◆ getPath()

Sabre\HTTP\Request::getPath ( )

Returns the relative path.

This is being calculated using the base url. This path will not start with a slash, so it will always return something like 'example/path.html'.

If the full path is equal to the base url, this method will return an empty string.

This method will also urldecode the path, and if the url was incoded as ISO-8859-1, it will convert it to UTF-8.

If the path is outside of the base url, a LogicException will be thrown.

Returns: string

Implements Sabre\HTTP\RequestInterface.

Definition at line 191 of file Request.php.

                       {
 
        // Removing duplicated slashes.
        $uri = str_replace('//', '/', $this->getUrl());
 
        $uri = Uri\normalize($uri);
        $baseUri = Uri\normalize($this->getBaseUrl());
 
        if (strpos($uri, $baseUri) === 0) {
 
            // We're not interested in the query part (everything after the ?).
            list($uri) = explode('?', $uri);
            return trim(URLUtil::decodePath(substr($uri, strlen($baseUri))), '/');
 
        }
        // A special case, if the baseUri was accessed without a trailing
        // slash, we'll accept it as well.
        elseif ($uri . '/' === $baseUri) {
 
            return '';
 
        }
 
        throw new \LogicException('Requested uri (' . $this->getUrl() . ') is out of base uri (' . $this->getBaseUrl() . ')');
    }

References $baseUri, Sabre\HTTP\URLUtil\decodePath(), Sabre\HTTP\Request\getBaseUrl(), Sabre\HTTP\Request\getUrl(), and Sabre\Uri\normalize().

Here is the call graph for this function:

◆ getPostData()

Sabre\HTTP\Request::getPostData ( )

Returns the POST data.

This is equivalent to PHP's $_POST superglobal.

Returns: array

Implements Sabre\HTTP\RequestInterface.

Definition at line 248 of file Request.php.

                           {
 
        return $this->postData;
 
    }

References Sabre\HTTP\Request\$postData.

◆ getQueryParameters()

Sabre\HTTP\Request::getQueryParameters ( )

Returns the list of query parameters.

This is equivalent to PHP's $_GET superglobal.

Returns: array

Implements Sabre\HTTP\RequestInterface.

Definition at line 107 of file Request.php.

                                  {
 
        $url = $this->getUrl();
        if (($index = strpos($url, '?')) === false) {
            return [];
        } else {
            parse_str(substr($url, $index + 1), $queryParams);
            return $queryParams;
        }
 
    }

References $index, Sabre\HTTP\Request\$url, and Sabre\HTTP\Request\getUrl().

Here is the call graph for this function:

◆ getRawServerValue()

Sabre\HTTP\Request::getRawServerValue ( $valueName )

Returns an item from the _SERVER array.

If the value does not exist in the array, null is returned.

Parameters

string $valueName

Returns: string|null

Implements Sabre\HTTP\RequestInterface.

Definition at line 269 of file Request.php.

                                           {
 
        if (isset($this->rawServerData[$valueName])) {
            return $this->rawServerData[$valueName];
        }
 
    }

◆ getUrl()

Sabre\HTTP\Request::getUrl ( )

Returns the request url.

Returns: string

Implements Sabre\HTTP\RequestInterface.

Definition at line 82 of file Request.php.

                      {
 
        return $this->url;
 
    }

References Sabre\HTTP\Request\$url.

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

Here is the caller graph for this function:

◆ setAbsoluteUrl()

Sabre\HTTP\Request::setAbsoluteUrl ( $url )

Sets the absolute url.

Parameters

string $url

Returns: void

Implements Sabre\HTTP\RequestInterface.

Definition at line 125 of file Request.php.

                                  {
 
        $this->absoluteUrl = $url;
 
    }

References Sabre\HTTP\Request\$url.

◆ setBaseUrl()

Sabre\HTTP\Request::setBaseUrl ( $url )

Sets a base url.

This url is used for relative path calculations.

Parameters

string $url

Returns: void

Implements Sabre\HTTP\RequestInterface.

Definition at line 157 of file Request.php.

                              {
 
        $this->baseUrl = $url;
 
    }

References Sabre\HTTP\Request\$url.

◆ setMethod()

Sabre\HTTP\Request::setMethod ( $method )

Sets the HTTP method.

Parameters

string $method

Returns: void

Implements Sabre\HTTP\RequestInterface.

Definition at line 71 of file Request.php.

                                {
 
        $this->method = $method;
 
    }

References Sabre\HTTP\Request\$method.

Referenced by Sabre\HTTP\Request\__construct().

Here is the caller graph for this function:

◆ setPostData()

Sabre\HTTP\Request::setPostData ( array $postData )

Sets the post data.

This is equivalent to PHP's $_POST superglobal.

This would not have been needed, if POST data was accessible as php://input, but unfortunately we need to special case it.

Parameters

array $postData

Returns: void

Implements Sabre\HTTP\RequestInterface.

Definition at line 235 of file Request.php.

                                          {
 
        $this->postData = $postData;
 
    }

References Sabre\HTTP\Request\$postData.

◆ setRawServerData()

Sabre\HTTP\Request::setRawServerData ( array $data )

Sets the _SERVER array.

Parameters

array $data

Returns: void

Implements Sabre\HTTP\RequestInterface.

Definition at line 283 of file Request.php.

                                           {
 
        $this->rawServerData = $data;
 
    }

References $data.

◆ setUrl()

Sabre\HTTP\Request::setUrl ( $url )

Sets the request url.

Parameters

string $url

Returns: void

Implements Sabre\HTTP\RequestInterface.

Definition at line 94 of file Request.php.

                          {
 
        $this->url = $url;
 
    }

References Sabre\HTTP\Request\$url.

Referenced by Sabre\HTTP\Request\__construct().

Here is the caller graph for this function:

Field Documentation

◆ $baseUrl

Sabre\HTTP\Request::$baseUrl = '/'

protected

Definition at line 147 of file Request.php.

Referenced by Sabre\HTTP\Request\getBaseUrl().

◆ $method

Sabre\HTTP\Request::$method

protected

Definition at line 25 of file Request.php.

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

◆ $postData

Sabre\HTTP\Request::$postData = []

protected

Definition at line 222 of file Request.php.

Referenced by Sabre\HTTP\Request\getPostData(), and Sabre\HTTP\Request\setPostData().

◆ $rawServerData

Sabre\HTTP\Request::$rawServerData

protected

Definition at line 259 of file Request.php.

◆ $url

Sabre\HTTP\Request::$url

protected

Definition at line 32 of file Request.php.

Referenced by Sabre\HTTP\Request\__construct(), Sabre\HTTP\Request\getQueryParameters(), Sabre\HTTP\Request\getUrl(), Sabre\HTTP\Request\setAbsoluteUrl(), Sabre\HTTP\Request\setBaseUrl(), and Sabre\HTTP\Request\setUrl().

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

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

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __toString()

◆ getAbsoluteUrl()

◆ getBaseUrl()

◆ getMethod()

◆ getPath()

◆ getPostData()

◆ getQueryParameters()

◆ getRawServerValue()

◆ getUrl()

◆ setAbsoluteUrl()

◆ setBaseUrl()

◆ setMethod()

◆ setPostData()

◆ setRawServerData()

◆ setUrl()

Field Documentation

◆ $baseUrl

◆ $method

◆ $postData

◆ $rawServerData

◆ $url