Commit 4e02c5b0 authored by Fabien Potencier's avatar Fabien Potencier

merged branch stof/phpdoc (PR #358)

Commits
-------

70da9e1e Removed unused property
a1a7306f Added a missing property
5c48a20f Fixed the phpdoc

Discussion
----------

Phpdoc

This fixes a bunch of phpdoc to make the autocompletion work in IDEs.
parents b355becd 70da9e1e
...@@ -50,6 +50,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe ...@@ -50,6 +50,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
private $providers = array(); private $providers = array();
private $booted = false; private $booted = false;
private $beforeDispatched = false;
/** /**
* Constructor. * Constructor.
...@@ -178,7 +179,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe ...@@ -178,7 +179,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
* @param string $pattern Matched route pattern * @param string $pattern Matched route pattern
* @param mixed $to Callback that returns the response when matched * @param mixed $to Callback that returns the response when matched
* *
* @return Silex\Controller * @return Controller
*/ */
public function match($pattern, $to) public function match($pattern, $to)
{ {
...@@ -191,7 +192,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe ...@@ -191,7 +192,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
* @param string $pattern Matched route pattern * @param string $pattern Matched route pattern
* @param mixed $to Callback that returns the response when matched * @param mixed $to Callback that returns the response when matched
* *
* @return Silex\Controller * @return Controller
*/ */
public function get($pattern, $to) public function get($pattern, $to)
{ {
...@@ -204,7 +205,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe ...@@ -204,7 +205,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
* @param string $pattern Matched route pattern * @param string $pattern Matched route pattern
* @param mixed $to Callback that returns the response when matched * @param mixed $to Callback that returns the response when matched
* *
* @return Silex\Controller * @return Controller
*/ */
public function post($pattern, $to) public function post($pattern, $to)
{ {
...@@ -217,7 +218,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe ...@@ -217,7 +218,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
* @param string $pattern Matched route pattern * @param string $pattern Matched route pattern
* @param mixed $to Callback that returns the response when matched * @param mixed $to Callback that returns the response when matched
* *
* @return Silex\Controller * @return Controller
*/ */
public function put($pattern, $to) public function put($pattern, $to)
{ {
...@@ -230,7 +231,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe ...@@ -230,7 +231,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
* @param string $pattern Matched route pattern * @param string $pattern Matched route pattern
* @param mixed $to Callback that returns the response when matched * @param mixed $to Callback that returns the response when matched
* *
* @return Silex\Controller * @return Controller
*/ */
public function delete($pattern, $to) public function delete($pattern, $to)
{ {
...@@ -366,7 +367,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe ...@@ -366,7 +367,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
* @param string $url The URL to redirect to * @param string $url The URL to redirect to
* @param integer $status The status code (302 by default) * @param integer $status The status code (302 by default)
* *
* @see Symfony\Component\HttpFoundation\RedirectResponse * @see RedirectResponse
*/ */
public function redirect($url, $status = 302) public function redirect($url, $status = 302)
{ {
...@@ -380,7 +381,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe ...@@ -380,7 +381,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
* @param integer $status The response status code * @param integer $status The response status code
* @param array $headers An array of response headers * @param array $headers An array of response headers
* *
* @see Symfony\Component\HttpFoundation\StreamedResponse * @see StreamedResponse
*/ */
public function stream($callback = null, $status = 200, $headers = array()) public function stream($callback = null, $status = 200, $headers = array())
{ {
...@@ -409,7 +410,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe ...@@ -409,7 +410,7 @@ class Application extends \Pimple implements HttpKernelInterface, EventSubscribe
* @param integer $status The response status code * @param integer $status The response status code
* @param array $headers An array of response headers * @param array $headers An array of response headers
* *
* @see Symfony\Component\HttpFoundation\JsonResponse * @see JsonResponse
*/ */
public function json($data = array(), $status = 200, $headers = array()) public function json($data = array(), $status = 200, $headers = array())
{ {
......
...@@ -31,8 +31,6 @@ class ControllerCollection ...@@ -31,8 +31,6 @@ class ControllerCollection
/** /**
* Constructor. * Constructor.
*
* @param Route $route
*/ */
public function __construct() public function __construct()
{ {
...@@ -47,7 +45,7 @@ class ControllerCollection ...@@ -47,7 +45,7 @@ class ControllerCollection
* @param string $pattern Matched route pattern * @param string $pattern Matched route pattern
* @param mixed $to Callback that returns the response when matched * @param mixed $to Callback that returns the response when matched
* *
* @return Silex\Controller * @return Controller
*/ */
public function match($pattern, $to) public function match($pattern, $to)
{ {
...@@ -66,7 +64,7 @@ class ControllerCollection ...@@ -66,7 +64,7 @@ class ControllerCollection
* @param string $pattern Matched route pattern * @param string $pattern Matched route pattern
* @param mixed $to Callback that returns the response when matched * @param mixed $to Callback that returns the response when matched
* *
* @return Silex\Controller * @return Controller
*/ */
public function get($pattern, $to) public function get($pattern, $to)
{ {
...@@ -79,7 +77,7 @@ class ControllerCollection ...@@ -79,7 +77,7 @@ class ControllerCollection
* @param string $pattern Matched route pattern * @param string $pattern Matched route pattern
* @param mixed $to Callback that returns the response when matched * @param mixed $to Callback that returns the response when matched
* *
* @return Silex\Controller * @return Controller
*/ */
public function post($pattern, $to) public function post($pattern, $to)
{ {
...@@ -92,7 +90,7 @@ class ControllerCollection ...@@ -92,7 +90,7 @@ class ControllerCollection
* @param string $pattern Matched route pattern * @param string $pattern Matched route pattern
* @param mixed $to Callback that returns the response when matched * @param mixed $to Callback that returns the response when matched
* *
* @return Silex\Controller * @return Controller
*/ */
public function put($pattern, $to) public function put($pattern, $to)
{ {
...@@ -105,7 +103,7 @@ class ControllerCollection ...@@ -105,7 +103,7 @@ class ControllerCollection
* @param string $pattern Matched route pattern * @param string $pattern Matched route pattern
* @param mixed $to Callback that returns the response when matched * @param mixed $to Callback that returns the response when matched
* *
* @return Silex\Controller * @return Controller
*/ */
public function delete($pattern, $to) public function delete($pattern, $to)
{ {
...@@ -118,7 +116,7 @@ class ControllerCollection ...@@ -118,7 +116,7 @@ class ControllerCollection
* @param string $variable The variable name * @param string $variable The variable name
* @param string $regexp The regexp to apply * @param string $regexp The regexp to apply
* *
* @return Controller $this The current Controller instance * @return ControllerCollection $this The current Controller instance
*/ */
public function assert($variable, $regexp) public function assert($variable, $regexp)
{ {
...@@ -137,7 +135,7 @@ class ControllerCollection ...@@ -137,7 +135,7 @@ class ControllerCollection
* @param string $variable The variable name * @param string $variable The variable name
* @param mixed $default The default value * @param mixed $default The default value
* *
* @return Controller $this The current Controller instance * @return ControllerCollection $this The current Controller instance
*/ */
public function value($variable, $default) public function value($variable, $default)
{ {
...@@ -156,7 +154,7 @@ class ControllerCollection ...@@ -156,7 +154,7 @@ class ControllerCollection
* @param string $variable The variable name * @param string $variable The variable name
* @param mixed $callback A PHP callback that converts the original value * @param mixed $callback A PHP callback that converts the original value
* *
* @return Controller $this The current Controller instance * @return ControllerCollection $this The current Controller instance
*/ */
public function convert($variable, $callback) public function convert($variable, $callback)
{ {
...@@ -174,7 +172,7 @@ class ControllerCollection ...@@ -174,7 +172,7 @@ class ControllerCollection
* *
* @param string $method The HTTP method name. Multiple methods can be supplied, delimited by a pipe character '|', eg. 'GET|POST' * @param string $method The HTTP method name. Multiple methods can be supplied, delimited by a pipe character '|', eg. 'GET|POST'
* *
* @return Controller $this The current Controller instance * @return ControllerCollection $this The current Controller instance
*/ */
public function method($method) public function method($method)
{ {
...@@ -190,7 +188,7 @@ class ControllerCollection ...@@ -190,7 +188,7 @@ class ControllerCollection
/** /**
* Sets the requirement of HTTP (no HTTPS) on this controller. * Sets the requirement of HTTP (no HTTPS) on this controller.
* *
* @return Controller $this The current Controller instance * @return ControllerCollection $this The current Controller instance
*/ */
public function requireHttp() public function requireHttp()
{ {
...@@ -206,7 +204,7 @@ class ControllerCollection ...@@ -206,7 +204,7 @@ class ControllerCollection
/** /**
* Sets the requirement of HTTPS on this controller. * Sets the requirement of HTTPS on this controller.
* *
* @return Controller $this The current Controller instance * @return ControllerCollection $this The current Controller instance
*/ */
public function requireHttps() public function requireHttps()
{ {
...@@ -225,7 +223,7 @@ class ControllerCollection ...@@ -225,7 +223,7 @@ class ControllerCollection
* *
* @param mixed $callback A PHP callback to be triggered when the Route is matched, just before the route callback * @param mixed $callback A PHP callback to be triggered when the Route is matched, just before the route callback
* *
* @return Controller $this The current Controller instance * @return ControllerCollection $this The current Controller instance
*/ */
public function middleware($callback) public function middleware($callback)
{ {
...@@ -241,6 +239,8 @@ class ControllerCollection ...@@ -241,6 +239,8 @@ class ControllerCollection
/** /**
* Persists and freezes staged controllers. * Persists and freezes staged controllers.
* *
* @param string $prefix
*
* @return RouteCollection A RouteCollection instance * @return RouteCollection A RouteCollection instance
*/ */
public function flush($prefix = '') public function flush($prefix = '')
......
...@@ -22,7 +22,6 @@ use Symfony\Component\Routing\Matcher\UrlMatcherInterface; ...@@ -22,7 +22,6 @@ use Symfony\Component\Routing\Matcher\UrlMatcherInterface;
class LazyUrlMatcher implements UrlMatcherInterface class LazyUrlMatcher implements UrlMatcherInterface
{ {
private $factory; private $factory;
private $urlMatcher;
public function __construct(\Closure $factory) public function __construct(\Closure $factory)
{ {
......
...@@ -25,7 +25,7 @@ class StringResponseConverter ...@@ -25,7 +25,7 @@ class StringResponseConverter
* *
* @param string $response The response string * @param string $response The response string
* *
* @return A Response object * @return Response A Response object
*/ */
public function convert($response) public function convert($response)
{ {
......
...@@ -36,7 +36,7 @@ abstract class WebTestCase extends \PHPUnit_Framework_TestCase ...@@ -36,7 +36,7 @@ abstract class WebTestCase extends \PHPUnit_Framework_TestCase
/** /**
* Creates the application. * Creates the application.
* *
* @return Symfony\Component\HttpKernel\HttpKernel * @return \Symfony\Component\HttpKernel\HttpKernel
*/ */
abstract public function createApplication(); abstract public function createApplication();
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment