Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Already on GitHub? Sign in to your account

[Routing] added more phpdoc and replaced 'array of type' by 'Type[]' #5994

Merged
merged 3 commits into from Nov 13, 2012
Jump to file or symbol
Failed to load files and symbols.
+194 −59
Split
@@ -22,7 +22,10 @@
*/
class MethodNotAllowedException extends \RuntimeException implements ExceptionInterface
{
- protected $allowedMethods;
+ /**
+ * @var array
+ */
+ protected $allowedMethods = array();
public function __construct(array $allowedMethods, $message = null, $code = 0, \Exception $previous = null)
{
@@ -31,6 +34,11 @@ public function __construct(array $allowedMethods, $message = null, $code = 0, \
parent::__construct($message, $code, $previous);
}
+ /**
+ * Gets the allowed HTTP methods.
+ *
+ * @return array
+ */
public function getAllowedMethods()
{
return $this->allowedMethods;
@@ -20,6 +20,9 @@
*/
abstract class GeneratorDumper implements GeneratorDumperInterface
{
+ /**
+ * @var RouteCollection
+ */
private $routes;
/**
@@ -28,8 +28,24 @@
*/
class UrlGenerator implements UrlGeneratorInterface, ConfigurableRequirementsInterface
{
+ /**
+ * @var RouteCollection
+ */
+ protected $routes;
+
+ /**
+ * @var RequestContext
+ */
protected $context;
+
+ /**
+ * @var Boolean|null
+ */
protected $strictRequirements = true;
+
+ /**
+ * @var LoggerInterface|null
+ */
protected $logger;
/**
@@ -60,14 +76,12 @@ class UrlGenerator implements UrlGeneratorInterface, ConfigurableRequirementsInt
'%7C' => '|',
);
- protected $routes;
-
/**
* Constructor.
*
- * @param RouteCollection $routes A RouteCollection instance
- * @param RequestContext $context The context
- * @param LoggerInterface $logger A logger instance
+ * @param RouteCollection $routes A RouteCollection instance
+ * @param RequestContext $context The context
+ * @param LoggerInterface|null $logger A logger instance
*
* @api
*/
@@ -56,9 +56,20 @@
*/
abstract class AnnotationClassLoader implements LoaderInterface
{
+ /**
+ * @var Reader
+ */
protected $reader;
+
+ /**
@fabpot

fabpot Nov 12, 2012

Owner

What's the benefit of adding this? I understand when it is an object, but here, this has little value.

@Tobion

Tobion Nov 12, 2012

Member

Just more "explicitness". And it looks bad, when one property is documented and the other not.

+ * @var string
+ */
protected $routeAnnotationClass = 'Symfony\\Component\\Routing\\Annotation\\Route';
- protected $defaultRouteIndex;
+
+ /**
+ * @var integer
+ */
+ protected $defaultRouteIndex = 0;
/**
* Constructor.
@@ -83,8 +94,8 @@ public function setRouteAnnotationClass($class)
/**
* Loads from annotations from a class.
*
- * @param string $class A class name
- * @param string $type The resource type
+ * @param string $class A class name
+ * @param string|null $type The resource type
*
* @return RouteCollection A RouteCollection instance
*
@@ -25,8 +25,8 @@ class AnnotationDirectoryLoader extends AnnotationFileLoader
/**
* Loads from annotations from a directory.
*
- * @param string $path A directory path
- * @param string $type The resource type
+ * @param string $path A directory path
+ * @param string|null $type The resource type
*
* @return RouteCollection A RouteCollection instance
*
@@ -14,7 +14,7 @@
use Symfony\Component\Routing\RouteCollection;
use Symfony\Component\Config\Resource\FileResource;
use Symfony\Component\Config\Loader\FileLoader;
-use Symfony\Component\Config\FileLocator;
+use Symfony\Component\Config\FileLocatorInterface;
/**
* AnnotationFileLoader loads routing information from annotations set
@@ -29,11 +29,11 @@ class AnnotationFileLoader extends FileLoader
/**
* Constructor.
*
- * @param FileLocator $locator A FileLocator instance
+ * @param FileLocatorInterface $locator A FileLocator instance
* @param AnnotationClassLoader $loader An AnnotationClassLoader instance
* @param string|array $paths A path or an array of paths where to look for resources
*/
- public function __construct(FileLocator $locator, AnnotationClassLoader $loader, $paths = array())
+ public function __construct(FileLocatorInterface $locator, AnnotationClassLoader $loader, $paths = array())
{
if (!function_exists('token_get_all')) {
throw new \RuntimeException('The Tokenizer extension is required for the routing annotation loaders.');
@@ -47,8 +47,8 @@ public function __construct(FileLocator $locator, AnnotationClassLoader $loader,
/**
* Loads from annotations from a file.
*
- * @param string $file A PHP file path
- * @param string $type The resource type
+ * @param string $file A PHP file path
+ * @param string|null $type The resource type
*
* @return RouteCollection A RouteCollection instance
*
@@ -27,8 +27,8 @@ class ClosureLoader extends Loader
/**
* Loads a Closure.
*
- * @param \Closure $closure A Closure
- * @param string $type The resource type
+ * @param \Closure $closure A Closure
+ * @param string|null $type The resource type
*
* @api
*/
@@ -28,8 +28,8 @@ class PhpFileLoader extends FileLoader
/**
* Loads a PHP file.
*
- * @param mixed $file A PHP file path
- * @param string $type The resource type
+ * @param string $file A PHP file path
+ * @param string|null $type The resource type
*
* @api
*/
@@ -28,8 +28,8 @@ class XmlFileLoader extends FileLoader
/**
* Loads an XML file.
*
- * @param string $file An XML file path
- * @param string $type The resource type
+ * @param string $file An XML file path
+ * @param string|null $type The resource type
*
* @return RouteCollection A RouteCollection instance
*
@@ -65,6 +65,8 @@ public function load($file, $type = null)
* @param \DOMElement $node the node to parse
* @param string $path the path of the XML file being processed
* @param string $file
+ *
+ * @throws \InvalidArgumentException When a tag can't be parsed
*/
protected function parseNode(RouteCollection $collection, \DOMElement $node, $path, $file)
{
@@ -33,8 +33,8 @@ class YamlFileLoader extends FileLoader
/**
* Loads a Yaml file.
*
- * @param string $file A Yaml file path
- * @param string $type The resource type
+ * @param string $file A Yaml file path
+ * @param string|null $type The resource type
*
* @return RouteCollection A RouteCollection instance
*
@@ -18,14 +18,25 @@
*/
class DumperCollection implements \IteratorAggregate
{
+ /**
+ * @var DumperCollection|null
+ */
private $parent;
+
+ /**
+ * @var (DumperCollection|DumperRoute)[]
@henrikbjorn

henrikbjorn Nov 12, 2012

Contributor

This looks wierd wouldnt the correct way be DumperCollection[]|DumperRoute[]

@Tobion

Tobion Nov 12, 2012

Member

No, its an array of DumperCollection and DumperRoute instances. Not an array of DumperCollection or an array of DumperRoute.
Its also in the spec: see http://www.phpdoc.org/docs/latest/for-users/types.html?highlight=array

+ */
private $children = array();
+
+ /**
+ * @var array
+ */
private $attributes = array();
/**
* Returns the children routes and collections.
*
- * @return array Array of DumperCollection|DumperRoute
+ * @return (DumperCollection|DumperRoute)[] Array of DumperCollection|DumperRoute
*/
public function all()
{
@@ -18,6 +18,9 @@
*/
class DumperPrefixCollection extends DumperCollection
{
+ /**
+ * @var string
+ */
private $prefix = '';
/**
@@ -20,7 +20,14 @@
*/
class DumperRoute
{
+ /**
+ * @var string
+ */
private $name;
+
+ /**
+ * @var Route
+ */
private $route;
/**
@@ -20,6 +20,9 @@
*/
abstract class MatcherDumper implements MatcherDumperInterface
{
+ /**
+ * @var RouteCollection
+ */
private $routes;
/**
@@ -324,8 +324,8 @@ private function compileRoute(Route $route, $name, $supportsRedirections, $paren
/**
* Flattens a tree of routes to a single collection.
*
- * @param RouteCollection $routes Collection of routes
- * @param DumperCollection $to A DumperCollection to add routes to
+ * @param RouteCollection $routes Collection of routes
+ * @param DumperCollection|null $to A DumperCollection to add routes to
*
* @return DumperCollection
*/
@@ -23,9 +23,9 @@
/**
* Redirects the user to another URL.
*
- * @param string $path The path info to redirect to.
- * @param string $route The route that matched
- * @param string $scheme The URL scheme (null to keep the current one)
+ * @param string $path The path info to redirect to.
+ * @param string $route The route name that matched
+ * @param string|null $scheme The URL scheme (null to keep the current one)
*
* @return array An array of parameters
*
@@ -30,9 +30,19 @@ class UrlMatcher implements UrlMatcherInterface
const REQUIREMENT_MISMATCH = 1;
const ROUTE_MATCH = 2;
+ /**
+ * @var RequestContext
+ */
protected $context;
- protected $allow;
+ /**
+ * @var array
+ */
+ protected $allow = array();
+
+ /**
+ * @var RouteCollection
+ */
private $routes;
/**
@@ -28,7 +28,11 @@ class RequestContext
private $scheme;
private $httpPort;
private $httpsPort;
- private $parameters;
+
+ /**
+ * @var array
+ */
+ private $parameters = array();
/**
* Constructor.
@@ -50,7 +54,6 @@ public function __construct($baseUrl = '', $method = 'GET', $host = 'localhost',
$this->scheme = strtolower($scheme);
$this->httpPort = $httpPort;
$this->httpsPort = $httpsPort;
- $this->parameters = array();
}
public function fromRequest(Request $request)
Oops, something went wrong.