Public Member Functions | |
| __construct (array $query=array(), array $request=array(), array $attributes=array(), array $cookies=array(), array $files=array(), array $server=array(), $content=null, array $headers=null) | |
| initialize (array $query=array(), array $request=array(), array $attributes=array(), array $cookies=array(), array $files=array(), array $server=array(), $content=null, array $headers=null) | |
| query ($name, $default=null) | |
| request ($name, $default=null) | |
| server ($name, $default=null) | |
| headers ($name, $default=null) | |
| getAllQueryParameters () | |
| getContent ($asResource=false) | |
Static Public Member Functions | |
| static | createFromGlobals () |
Public Attributes | |
| $attributes | |
| $request | |
| $query | |
| $server | |
| $files | |
| $cookies | |
| $headers | |
| $content | |
Detailed Description
OAuth2\Request This class is taken from the Symfony2 Framework and is part of the Symfony package. See Symfony\Component\HttpFoundation\Request (https://github.com/symfony/symfony)
Definition at line 10 of file Request.php.
Constructor & Destructor Documentation
◆ __construct()
| OAuth2\Request::__construct | ( | array | $query = array(), |
| array | $request = array(), |
||
| array | $attributes = array(), |
||
| array | $cookies = array(), |
||
| array | $files = array(), |
||
| array | $server = array(), |
||
$content = null, |
|||
| array | $headers = null |
||
| ) |
Constructor.
- Parameters
-
array $query The GET parameters array $request The POST parameters array $attributes The request attributes (parameters parsed from the PATH_INFO, ...) array $cookies The COOKIE parameters array $files The FILES parameters array $server The SERVER parameters string $content The raw body data
@api
Definition at line 34 of file Request.php.
Member Function Documentation
◆ createFromGlobals()
|
static |
Creates a new request with values from PHP's super globals.
- Returns
- Request A new request
@api
Definition at line 192 of file Request.php.
◆ getAllQueryParameters()
| OAuth2\Request::getAllQueryParameters | ( | ) |
Implements OAuth2\RequestInterface.
Definition at line 89 of file Request.php.
◆ getContent()
| OAuth2\Request::getContent | ( | $asResource = false | ) |
Returns the request body content.
- Parameters
-
Boolean $asResource If true, a resource will be returned
- Returns
- string|resource The request body content or a resource to read the body stream.
Definition at line 101 of file Request.php.
◆ headers()
| OAuth2\Request::headers | ( | $name, | |
$default = null |
|||
| ) |
Implements OAuth2\RequestInterface.
Definition at line 81 of file Request.php.
◆ initialize()
| OAuth2\Request::initialize | ( | array | $query = array(), |
| array | $request = array(), |
||
| array | $attributes = array(), |
||
| array | $cookies = array(), |
||
| array | $files = array(), |
||
| array | $server = array(), |
||
$content = null, |
|||
| array | $headers = null |
||
| ) |
Sets the parameters for this request.
This method also re-initializes all properties.
- Parameters
-
array $query The GET parameters array $request The POST parameters array $attributes The request attributes (parameters parsed from the PATH_INFO, ...) array $cookies The COOKIE parameters array $files The FILES parameters array $server The SERVER parameters string $content The raw body data
@api
Definition at line 54 of file Request.php.
◆ query()
| OAuth2\Request::query | ( | $name, | |
$default = null |
|||
| ) |
Implements OAuth2\RequestInterface.
Definition at line 66 of file Request.php.
◆ request()
| OAuth2\Request::request | ( | $name, | |
$default = null |
|||
| ) |
Implements OAuth2\RequestInterface.
Definition at line 71 of file Request.php.
◆ server()
| OAuth2\Request::server | ( | $name, | |
$default = null |
|||
| ) |
Implements OAuth2\RequestInterface.
Definition at line 76 of file Request.php.
Member Data Documentation
◆ $attributes
| OAuth2\Request::$attributes |
Definition at line 12 of file Request.php.
◆ $content
| OAuth2\Request::$content |
Definition at line 19 of file Request.php.
◆ $cookies
| OAuth2\Request::$cookies |
Definition at line 17 of file Request.php.
◆ $files
| OAuth2\Request::$files |
Definition at line 16 of file Request.php.
◆ $headers
| OAuth2\Request::$headers |
Definition at line 18 of file Request.php.
◆ $query
| OAuth2\Request::$query |
Definition at line 14 of file Request.php.
◆ $request
| OAuth2\Request::$request |
Definition at line 13 of file Request.php.
◆ $server
| OAuth2\Request::$server |
Definition at line 15 of file Request.php.
The documentation for this class was generated from the following file:
- plugins/OAuth2/Request.php
