minor #9928 [HttpFoundation] Documented public properties (jakzal)

This PR was merged into the 2.3 branch.

Discussion
----------

[HttpFoundation] Documented public properties

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #9670
| License       | MIT
| Doc PR        | -

`$request` and `$query` parameter bags could be hard to get for a newcommer, who's used to `$_POST` and `$_GET` variables. Some people claim naming makes no sense (see #9671).

For consistency I documented all public properties.

Commits
-------

1b79831 [HttpFoundation] Documented public properties.
This commit is contained in:
Fabien Potencier 2014-01-03 08:25:18 +01:00
commit b4a35ed119

View File

@ -64,6 +64,8 @@ class Request
protected static $httpMethodParameterOverride = false;
/**
* Custom parameters
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*
* @api
@ -71,6 +73,8 @@ class Request
public $attributes;
/**
* Request body parameters ($_POST)
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*
* @api
@ -78,6 +82,8 @@ class Request
public $request;
/**
* Query string parameters ($_GET)
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*
* @api
@ -85,6 +91,8 @@ class Request
public $query;
/**
* Server and execution environment parameters ($_SERVER)
*
* @var \Symfony\Component\HttpFoundation\ServerBag
*
* @api
@ -92,6 +100,8 @@ class Request
public $server;
/**
* Uploaded files ($_FILES)
*
* @var \Symfony\Component\HttpFoundation\FileBag
*
* @api
@ -99,6 +109,8 @@ class Request
public $files;
/**
* Cookies ($_COOKIE)
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*
* @api
@ -106,6 +118,8 @@ class Request
public $cookies;
/**
* Headers (taken from the $_SERVER)
*
* @var \Symfony\Component\HttpFoundation\HeaderBag
*
* @api