merged branch Tobion/phpdoc (PR #4539)
Commits -------680e732
[Routing] fix phpDoc Discussion ---------- [Routing] fix phpDoc using inheritdoc where possible and removing api tag when parent interface has one as requested by stof and fabpot --------------------------------------------------------------------------- by travisbot at 2012-06-09T16:14:53Z This pull request [passes](http://travis-ci.org/symfony/symfony/builds/1577508) (merged 0a44632a intof8a09db5
). --------------------------------------------------------------------------- by travisbot at 2012-06-10T19:36:25Z This pull request [passes](http://travis-ci.org/symfony/symfony/builds/1585766) (merged680e732a
into7bec0786
).
This commit is contained in:
commit
ef41e308cc
@ -53,12 +53,7 @@ class DelegatingLoader extends Loader
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if this class supports the given resource.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param mixed $resource A resource
|
|
||||||
* @param string $type The resource type
|
|
||||||
*
|
|
||||||
* @return Boolean true if this class supports the given resource, false otherwise
|
|
||||||
*/
|
*/
|
||||||
public function supports($resource, $type = null)
|
public function supports($resource, $type = null)
|
||||||
{
|
{
|
||||||
|
@ -32,6 +32,9 @@ abstract class GeneratorDumper implements GeneratorDumperInterface
|
|||||||
$this->routes = $routes;
|
$this->routes = $routes;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* {@inheritdoc}
|
||||||
|
*/
|
||||||
public function getRoutes()
|
public function getRoutes()
|
||||||
{
|
{
|
||||||
return $this->routes;
|
return $this->routes;
|
||||||
|
@ -23,16 +23,12 @@ use Symfony\Component\Routing\RouteCollection;
|
|||||||
interface GeneratorDumperInterface
|
interface GeneratorDumperInterface
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Dumps a set of routes to a PHP class.
|
* Dumps a set of routes to a string representation of executable code
|
||||||
*
|
* that can then be used to generate a URL of such a route.
|
||||||
* Available options:
|
|
||||||
*
|
|
||||||
* * class: The class name
|
|
||||||
* * base_class: The base class name
|
|
||||||
*
|
*
|
||||||
* @param array $options An array of options
|
* @param array $options An array of options
|
||||||
*
|
*
|
||||||
* @return string A PHP class representing the generator class
|
* @return string Executable code
|
||||||
*/
|
*/
|
||||||
function dump(array $options = array());
|
function dump(array $options = array());
|
||||||
|
|
||||||
|
@ -50,11 +50,7 @@ class UrlGenerator implements UrlGeneratorInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the request context.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param RequestContext $context The context
|
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
public function setContext(RequestContext $context)
|
public function setContext(RequestContext $context)
|
||||||
{
|
{
|
||||||
@ -62,9 +58,7 @@ class UrlGenerator implements UrlGeneratorInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the request context.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return RequestContext The context
|
|
||||||
*/
|
*/
|
||||||
public function getContext()
|
public function getContext()
|
||||||
{
|
{
|
||||||
@ -72,9 +66,7 @@ class UrlGenerator implements UrlGeneratorInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* {@inheritDoc}
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
public function generate($name, $parameters = array(), $absolute = false)
|
public function generate($name, $parameters = array(), $absolute = false)
|
||||||
{
|
{
|
||||||
|
@ -160,12 +160,7 @@ abstract class AnnotationClassLoader implements LoaderInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if this class supports the given resource.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param mixed $resource A resource
|
|
||||||
* @param string $type The resource type
|
|
||||||
*
|
|
||||||
* @return Boolean True if this class supports the given resource, false otherwise
|
|
||||||
*/
|
*/
|
||||||
public function supports($resource, $type = null)
|
public function supports($resource, $type = null)
|
||||||
{
|
{
|
||||||
@ -173,18 +168,14 @@ abstract class AnnotationClassLoader implements LoaderInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the loader resolver.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param LoaderResolverInterface $resolver A LoaderResolverInterface instance
|
|
||||||
*/
|
*/
|
||||||
public function setResolver(LoaderResolverInterface $resolver)
|
public function setResolver(LoaderResolverInterface $resolver)
|
||||||
{
|
{
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the loader resolver.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return LoaderResolverInterface A LoaderResolverInterface instance
|
|
||||||
*/
|
*/
|
||||||
public function getResolver()
|
public function getResolver()
|
||||||
{
|
{
|
||||||
|
@ -62,12 +62,7 @@ class AnnotationDirectoryLoader extends AnnotationFileLoader
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if this class supports the given resource.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param mixed $resource A resource
|
|
||||||
* @param string $type The resource type
|
|
||||||
*
|
|
||||||
* @return Boolean True if this class supports the given resource, false otherwise
|
|
||||||
*/
|
*/
|
||||||
public function supports($resource, $type = null)
|
public function supports($resource, $type = null)
|
||||||
{
|
{
|
||||||
|
@ -68,12 +68,7 @@ class AnnotationFileLoader extends FileLoader
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if this class supports the given resource.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param mixed $resource A resource
|
|
||||||
* @param string $type The resource type
|
|
||||||
*
|
|
||||||
* @return Boolean True if this class supports the given resource, false otherwise
|
|
||||||
*/
|
*/
|
||||||
public function supports($resource, $type = null)
|
public function supports($resource, $type = null)
|
||||||
{
|
{
|
||||||
|
@ -38,12 +38,7 @@ class ClosureLoader extends Loader
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if this class supports the given resource.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param mixed $resource A resource
|
|
||||||
* @param string $type The resource type
|
|
||||||
*
|
|
||||||
* @return Boolean True if this class supports the given resource, false otherwise
|
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
@ -48,12 +48,7 @@ class PhpFileLoader extends FileLoader
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if this class supports the given resource.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param mixed $resource A resource
|
|
||||||
* @param string $type The resource type
|
|
||||||
*
|
|
||||||
* @return Boolean True if this class supports the given resource, false otherwise
|
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
@ -110,12 +110,7 @@ class XmlFileLoader extends FileLoader
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if this class supports the given resource.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param mixed $resource A resource
|
|
||||||
* @param string $type The resource type
|
|
||||||
*
|
|
||||||
* @return Boolean True if this class supports the given resource, false otherwise
|
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
@ -82,12 +82,7 @@ class YamlFileLoader extends FileLoader
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns true if this class supports the given resource.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param mixed $resource A resource
|
|
||||||
* @param string $type The resource type
|
|
||||||
*
|
|
||||||
* @return Boolean True if this class supports the given resource, false otherwise
|
|
||||||
*
|
*
|
||||||
* @api
|
* @api
|
||||||
*/
|
*/
|
||||||
|
@ -33,9 +33,7 @@ abstract class MatcherDumper implements MatcherDumperInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the routes to dump.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return RouteCollection A RouteCollection instance
|
|
||||||
*/
|
*/
|
||||||
public function getRoutes()
|
public function getRoutes()
|
||||||
{
|
{
|
||||||
|
@ -19,21 +19,17 @@ namespace Symfony\Component\Routing\Matcher\Dumper;
|
|||||||
interface MatcherDumperInterface
|
interface MatcherDumperInterface
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Dumps a set of routes to a PHP class.
|
* Dumps a set of routes to a string representation of executable code
|
||||||
*
|
* that can then be used to match a request against these routes.
|
||||||
* Available options:
|
|
||||||
*
|
|
||||||
* * class: The class name
|
|
||||||
* * base_class: The base class name
|
|
||||||
*
|
*
|
||||||
* @param array $options An array of options
|
* @param array $options An array of options
|
||||||
*
|
*
|
||||||
* @return string A PHP class representing the matcher class
|
* @return string Executable code
|
||||||
*/
|
*/
|
||||||
function dump(array $options = array());
|
function dump(array $options = array());
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the routes to match.
|
* Gets the routes to dump.
|
||||||
*
|
*
|
||||||
* @return RouteCollection A RouteCollection instance
|
* @return RouteCollection A RouteCollection instance
|
||||||
*/
|
*/
|
||||||
|
@ -22,9 +22,7 @@ use Symfony\Component\Routing\Route;
|
|||||||
abstract class RedirectableUrlMatcher extends UrlMatcher implements RedirectableUrlMatcherInterface
|
abstract class RedirectableUrlMatcher extends UrlMatcher implements RedirectableUrlMatcherInterface
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @see UrlMatcher::match()
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
public function match($pathinfo)
|
public function match($pathinfo)
|
||||||
{
|
{
|
||||||
|
@ -50,11 +50,7 @@ class UrlMatcher implements UrlMatcherInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the request context.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param RequestContext $context The context
|
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
public function setContext(RequestContext $context)
|
public function setContext(RequestContext $context)
|
||||||
{
|
{
|
||||||
@ -62,9 +58,7 @@ class UrlMatcher implements UrlMatcherInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the request context.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return RequestContext The context
|
|
||||||
*/
|
*/
|
||||||
public function getContext()
|
public function getContext()
|
||||||
{
|
{
|
||||||
@ -72,16 +66,7 @@ class UrlMatcher implements UrlMatcherInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Tries to match a URL with a set of routes.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param string $pathinfo The path info to be parsed (raw format, i.e. not urldecoded)
|
|
||||||
*
|
|
||||||
* @return array An array of parameters
|
|
||||||
*
|
|
||||||
* @throws ResourceNotFoundException If the resource could not be found
|
|
||||||
* @throws MethodNotAllowedException If the resource was found but the request method is not allowed
|
|
||||||
*
|
|
||||||
* @api
|
|
||||||
*/
|
*/
|
||||||
public function match($pathinfo)
|
public function match($pathinfo)
|
||||||
{
|
{
|
||||||
|
@ -21,11 +21,7 @@ class RouteCompiler implements RouteCompilerInterface
|
|||||||
const REGEX_DELIMITER = '#';
|
const REGEX_DELIMITER = '#';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Compiles the current route instance.
|
* {@inheritDoc}
|
||||||
*
|
|
||||||
* @param Route $route A Route instance
|
|
||||||
*
|
|
||||||
* @return CompiledRoute A CompiledRoute instance
|
|
||||||
*
|
*
|
||||||
* @throws \LogicException If a variable is referenced more than once
|
* @throws \LogicException If a variable is referenced more than once
|
||||||
*/
|
*/
|
||||||
|
@ -128,9 +128,7 @@ class Router implements RouterInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the RouteCollection instance associated with this Router.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return RouteCollection A RouteCollection instance
|
|
||||||
*/
|
*/
|
||||||
public function getRouteCollection()
|
public function getRouteCollection()
|
||||||
{
|
{
|
||||||
@ -142,9 +140,7 @@ class Router implements RouterInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Sets the request context.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @param RequestContext $context The context
|
|
||||||
*/
|
*/
|
||||||
public function setContext(RequestContext $context)
|
public function setContext(RequestContext $context)
|
||||||
{
|
{
|
||||||
@ -155,9 +151,7 @@ class Router implements RouterInterface
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Gets the request context.
|
* {@inheritdoc}
|
||||||
*
|
|
||||||
* @return RequestContext The context
|
|
||||||
*/
|
*/
|
||||||
public function getContext()
|
public function getContext()
|
||||||
{
|
{
|
||||||
|
Reference in New Issue
Block a user