updated PHPDoc as the API tool knows about the current use statements

This commit is contained in:
Fabien Potencier 2010-07-27 15:33:28 +02:00
parent cf6885a0a9
commit 1a9f2ca755
61 changed files with 281 additions and 261 deletions

View File

@ -31,9 +31,9 @@ class DoctrineBundle extends Bundle
/**
* Customizes the Container instance.
*
* @param \Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface $parameterBag A ParameterBagInterface instance
* @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
*
* @return \Symfony\Components\DependencyInjection\ContainerBuilder A ContainerBuilder instance
* @return ContainerBuilder A ContainerBuilder instance
*/
public function buildContainer(ParameterBagInterface $parameterBag)
{

View File

@ -19,9 +19,9 @@ class DoctrineMongoDBBundle extends Bundle
/**
* Customizes the Container instance.
*
* @param \Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface $parameterBag A ParameterBagInterface instance
* @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
*
* @return \Symfony\Components\DependencyInjection\ContainerBuilder A ContainerBuilder instance
* @return ContainerBuilder A ContainerBuilder instance
*/
public function buildContainer(ParameterBagInterface $parameterBag)
{

View File

@ -31,7 +31,7 @@ class Controller
/**
* Constructor.
*
* @param \Symfony\Components\DependencyInjection\ContainerInterface $container A ContainerInterface instance
* @param ContainerInterface $container A ContainerInterface instance
*/
function __construct(ContainerInterface $container)
{
@ -42,7 +42,7 @@ class Controller
/**
* Gets the Request.
*
* @return \Symfony\Components\HttpFoundation\Request A Request instance
* @return Request A Request instance
*/
public function getRequest()
{
@ -56,7 +56,7 @@ class Controller
* @param integer $status The status code
* @param array $headers An array of HTTP headers
*
* @return \Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
public function createResponse($content = '', $status = 200, array $headers = array())
{
@ -91,7 +91,7 @@ class Controller
* @param array $path An array of path parameters
* @param array $query An array of query parameters
*
* @return \Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
public function forward($controller, array $path = array(), array $query = array())
{
@ -104,7 +104,7 @@ class Controller
/**
* Returns an HTTP redirect Response.
*
* @return \Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
public function redirect($url, $status = 302)
{
@ -131,11 +131,11 @@ class Controller
/**
* Renders a view.
*
* @param string $view The view name
* @param array $parameters An array of parameters to pass to the view
* @param \Symfony\Components\HttpFoundation\Response $response A response instance
* @param string $view The view name
* @param array $parameters An array of parameters to pass to the view
* @param Response $response A response instance
*
* @return \Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
public function render($view, array $parameters = array(), Response $response = null)
{

View File

@ -119,7 +119,7 @@ class ControllerResolver implements ControllerResolverInterface
* This method looks for a '_controller' request parameter that represents
* the controller name (a string like BlogBundle:Post:index).
*
* @param \Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return mixed|Boolean A PHP callable representing the Controller,
* or false if this resolver is not able to determine the controller
@ -184,8 +184,8 @@ class ControllerResolver implements ControllerResolverInterface
/**
* Returns the arguments to pass to the controller.
*
* @param \Symfony\Components\HttpFoundation\Request $request A Request instance
* @param mixed $controller A PHP callable
* @param Request $request A Request instance
* @param mixed $controller A PHP callable
*
* @throws \RuntimeException When value for argument given is not provided
*/

View File

@ -41,7 +41,7 @@ class ExceptionListener
/**
* Registers a core.exception listener.
*
* @param Symfony\Components\EventDispatcher\EventDispatcher $dispatcher An EventDispatcher instance
* @param EventDispatcher $dispatcher An EventDispatcher instance
*/
public function register(EventDispatcher $dispatcher)
{

View File

@ -48,8 +48,8 @@ class WebExtension extends Extension
/**
* Loads the web configuration.
*
* @param array $config An array of configuration settings
* @param \Symfony\Components\DependencyInjection\ContainerBuilder $container A ContainerBuilder instance
* @param array $config An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function configLoad($config, ContainerBuilder $container)
{
@ -179,8 +179,8 @@ class WebExtension extends Extension
/**
* Loads the templating configuration.
*
* @param array $config An array of configuration settings
* @param \Symfony\Components\DependencyInjection\ContainerBuilder $container A ContainerBuilder instance
* @param array $config An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function templatingLoad($config, ContainerBuilder $container)
{

View File

@ -30,9 +30,9 @@ class FrameworkBundle extends Bundle
/**
* Customizes the Container instance.
*
* @param \Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface $parameterBag A ParameterBagInterface instance
* @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
*
* @return \Symfony\Components\DependencyInjection\ContainerBuilder A ContainerBuilder instance
* @return ContainerBuilder A ContainerBuilder instance
*/
public function buildContainer(ParameterBagInterface $parameterBag)
{

View File

@ -4,6 +4,7 @@ namespace Symfony\Bundle\FrameworkBundle\Routing;
use Symfony\Components\Routing\Loader\LoaderResolver as BaseLoaderResolver;
use Symfony\Components\DependencyInjection\ContainerInterface;
use Symfony\Components\Routing\Loader\LoaderInterface;
/*
* This file is part of the Symfony package.
@ -32,8 +33,8 @@ class LoaderResolver extends BaseLoaderResolver
/**
* Constructor.
*
* @param \Symfony\Components\DependencyInjection\ContainerInterface $container A ContainerInterface instance
* @param \Symfony\Components\Routing\Loader\LoaderInterface[] $loaders An array of loaders
* @param ContainerInterface $container A ContainerInterface instance
* @param LoaderInterface[] $loaders An array of loaders
*/
public function __construct(ContainerInterface $container, array $loaders = array())
{
@ -50,7 +51,7 @@ class LoaderResolver extends BaseLoaderResolver
*
* @param mixed $resource A resource
*
* @return Symfony\Components\Routing\Loader\LoaderInterface A LoaderInterface instance
* @return LoaderInterface A LoaderInterface instance
*/
public function resolve($resource)
{

View File

@ -26,9 +26,9 @@ class AssetsHelper extends BaseAssetsHelper
/**
* Constructor.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param string|array $baseURLs The domain URL or an array of domain URLs
* @param string $version The version
* @param Request $request A Request instance
* @param string|array $baseURLs The domain URL or an array of domain URLs
* @param string $version The version
*/
public function __construct(Request $request, $baseURLs = array(), $version = null)
{

View File

@ -5,6 +5,7 @@ namespace Symfony\Bundle\FrameworkBundle\Test;
use Symfony\Framework\Test\WebTestCase as BaseWebTestCase;
use Symfony\Components\Finder\Finder;
use Symfony\Components\HttpFoundation\Response;
use Symfony\Components\HttpKernel\HttpKernelInterface;
/*
* This file is part of the Symfony package.
@ -37,7 +38,7 @@ abstract class WebTestCase extends BaseWebTestCase
*
* @param array $options An array of options
*
* @return Symfony\Components\HttpKernel\HttpKernelInterface A HttpKernelInterface instance
* @return HttpKernelInterface A HttpKernelInterface instance
*/
protected function createKernel(array $options = array())
{

View File

@ -17,8 +17,8 @@ class PropelExtension extends Extension
/**
* Loads the Propel configuration.
*
* @param array $config An array of configuration settings
* @param \Symfony\Components\DependencyInjection\ContainerBuilder $container A ContainerBuilder instance
* @param array $config An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function configLoad($config, ContainerBuilder $container)
{
@ -47,8 +47,8 @@ class PropelExtension extends Extension
/**
* Loads the DBAL configuration.
*
* @param array $config An array of configuration settings
* @param \Symfony\Components\DependencyInjection\ContainerBuilder $container A ContainerBuilder instance
* @param array $config An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function dbalLoad($config, ContainerBuilder $container)
{

View File

@ -14,9 +14,9 @@ class PropelBundle extends Bundle
/**
* Customizes the Container instance.
*
* @param \Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface $parameterBag A ParameterBagInterface instance
* @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
*
* @return \Symfony\Components\DependencyInjection\ContainerBuilder A ContainerBuilder instance
* @return ContainerBuilder A ContainerBuilder instance
*/
public function buildContainer(ParameterBagInterface $parameterBag)
{

View File

@ -40,8 +40,8 @@ class SwiftMailerExtension extends Extension
* <swift:spool path="/path/to/spool/" />
* </swift:mailer>
*
* @param array $config An array of configuration settings
* @param \Symfony\Components\DependencyInjection\ContainerBuilder $container A ContainerBuilder instance
* @param array $config An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function mailerLoad($config, ContainerBuilder $container)
{

View File

@ -29,9 +29,9 @@ class SwiftmailerBundle extends Bundle
/**
* Customizes the Container instance.
*
* @param \Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface $parameterBag A ParameterBagInterface instance
* @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
*
* @return \Symfony\Components\DependencyInjection\ContainerBuilder A ContainerBuilder instance
* @return ContainerBuilder A ContainerBuilder instance
*/
public function buildContainer(ParameterBagInterface $parameterBag)
{

View File

@ -27,8 +27,8 @@ class TwigExtension extends Extension
/**
* Loads the Twig configuration.
*
* @param array $config An array of configuration settings
* @param \Symfony\Components\DependencyInjection\ContainerBuilder $container A ContainerBuilder instance
* @param array $config An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function configLoad($config, ContainerBuilder $container)
{

View File

@ -30,9 +30,9 @@ class TwigBundle extends Bundle
/**
* Customizes the Container instance.
*
* @param \Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface $parameterBag A ParameterBagInterface instance
* @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
*
* @return \Symfony\Components\DependencyInjection\ContainerBuilder A ContainerBuilder instance
* @return ContainerBuilder A ContainerBuilder instance
*/
public function buildContainer(ParameterBagInterface $parameterBag)
{

View File

@ -36,8 +36,8 @@ class ZendExtension extends Extension
*
* <zend:logger priority="info" path="/path/to/some.log" />
*
* @param array $config An array of configuration settings
* @param \Symfony\Components\DependencyInjection\ContainerBuilder $container A ContainerBuilder instance
* @param array $config An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function loggerLoad($config, ContainerBuilder $container)
{
@ -63,8 +63,8 @@ class ZendExtension extends Extension
*
* <zend:i18n locale="en" adapter="xliff" data="/path/to/messages.xml" />
*
* @param array $config An array of configuration settings
* @param \Symfony\Components\DependencyInjection\ContainerBuilder $container A ContainerBuilder instance
* @param array $config An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function i18nLoad($config, ContainerBuilder $container)
{

View File

@ -30,9 +30,9 @@ class ZendBundle extends Bundle
/**
* Customizes the Container instance.
*
* @param \Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface $parameterBag A ParameterBagInterface instance
* @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
*
* @return \Symfony\Components\DependencyInjection\ContainerBuilder A ContainerBuilder instance
* @return ContainerBuilder A ContainerBuilder instance
*/
public function buildContainer(ParameterBagInterface $parameterBag)
{

View File

@ -6,6 +6,9 @@ use Symfony\Components\DomCrawler\Crawler;
use Symfony\Components\DomCrawler\Link;
use Symfony\Components\DomCrawler\Form;
use Symfony\Components\Process\PhpProcess;
use Symfony\Components\BrowserKit\Request;
use Symfony\Components\BrowserKit\Response;
use Symfony\Components\BrowserKit\Client;
/*
* This file is part of the Symfony package.
@ -43,9 +46,9 @@ abstract class Client
/**
* Constructor.
*
* @param array $server The server parameters (equivalent of $_SERVER)
* @param Symfony\Components\BrowserKit\History $history A History instance to store the browser history
* @param Symfony\Components\BrowserKit\CookieJar $cookieJar A CookieJar instance to store the cookies
* @param array $server The server parameters (equivalent of $_SERVER)
* @param History $history A History instance to store the browser history
* @param CookieJar $cookieJar A CookieJar instance to store the cookies
*/
public function __construct(array $server = array(), History $history = null, CookieJar $cookieJar = null)
{
@ -100,7 +103,7 @@ abstract class Client
/**
* Returns the History instance.
*
* @return Symfony\Components\BrowserKit\History A History instance
* @return History A History instance
*/
public function getHistory()
{
@ -110,7 +113,7 @@ abstract class Client
/**
* Returns the CookieJar instance.
*
* @return Symfony\Components\BrowserKit\CookieJar A CookieJar instance
* @return CookieJar A CookieJar instance
*/
public function getCookieJar()
{
@ -120,7 +123,7 @@ abstract class Client
/**
* Returns the current Crawler instance.
*
* @return Symfony\Components\DomCrawler\Crawler A Crawler instance
* @return Crawler A Crawler instance
*/
public function getCrawler()
{
@ -130,7 +133,7 @@ abstract class Client
/**
* Returns the current Response instance.
*
* @return Symfony\Components\BrowserKit\Response A Response instance
* @return Response A Response instance
*/
public function getResponse()
{
@ -140,7 +143,7 @@ abstract class Client
/**
* Returns the current Request instance.
*
* @return Symfony\Components\BrowserKit\Request A Request instance
* @return Request A Request instance
*/
public function getRequest()
{
@ -150,7 +153,7 @@ abstract class Client
/**
* Clicks on a given link.
*
* @param Symfony\Components\BrowserKit\Link $link A Link instance
* @param Link $link A Link instance
*/
public function click(Link $link)
{
@ -160,8 +163,8 @@ abstract class Client
/**
* Submits a form.
*
* @param Symfony\Components\BrowserKit\Form $form A Form instance
* @param array $values An array of form field values
* @param Form $form A Form instance
* @param array $values An array of form field values
*/
public function submit(Form $form, array $values = array())
{
@ -180,7 +183,7 @@ abstract class Client
* @param array $server The server parameters (HTTP headers are referenced with a HTTP_ prefix as PHP does)
* @param Boolean $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
*
* @return Symfony\Components\DomCrawler\Crawler
* @return Crawler
*/
public function request($method, $uri, array $parameters = array(), array $files = array(), array $server = array(), $changeHistory = true)
{
@ -309,7 +312,7 @@ abstract class Client
/**
* Follow redirects?
*
* @return Symfony\Components\BrowserKit\Client
* @return Client
*
* @throws \LogicException If request was not a redirect
*/
@ -370,10 +373,10 @@ abstract class Client
/**
* Makes a request from a Request object directly.
*
* @param Symfony\Components\BrowserKit\Request $request A Request instance
* @param Boolean $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
* @param Request $request A Request instance
* @param Boolean $changeHistory Whether to update the history or not (only used internally for back(), forward(), and reload())
*
* @return Symfony\Components\DomCrawler\Crawler
* @return Crawler
*/
protected function requestFromRequest(Request $request, $changeHistory = true)
{

View File

@ -90,7 +90,7 @@ class Cookie
* @param string $cookie A Set-Cookie header value
* @param string $url The base URL
*
* @return Symfony\Components\BrowserKit\Cookie A Cookie instance
* @return Cookie A Cookie instance
*/
static public function fromString($cookie, $url = null)
{

View File

@ -25,7 +25,7 @@ class CookieJar
/**
* Sets a cookie.
*
* @param Symfony\Components\BrowserKit\Cookie $cookie A Cookie instance
* @param Cookie $cookie A Cookie instance
*/
public function set(Cookie $cookie)
{
@ -37,7 +37,7 @@ class CookieJar
*
* @param string $name The cookie name
*
* @return Symfony\Components\BrowserKit\Cookie|null A Cookie instance or null if the cookie does not exist
* @return Cookie|null A Cookie instance or null if the cookie does not exist
*/
public function get($name)
{
@ -67,8 +67,8 @@ class CookieJar
/**
* Updates the cookie jar from a Response object.
*
* @param Symfony\Components\BrowserKit\Response $response A Response object
* @param string $url The base URL
* @param Response $response A Response object
* @param string $url The base URL
*/
public function updateFromResponse(Response $response, $uri = null)
{

View File

@ -43,7 +43,7 @@ class History
/**
* Adds a Request to the history.
*
* @param Symfony\Components\BrowserKit\Request $request A Request instance
* @param Request $request A Request instance
*/
public function add(Request $request)
{
@ -65,7 +65,7 @@ class History
/**
* Goes back in the history.
*
* @return Symfony\Components\BrowserKit\Request A Request instance
* @return Request A Request instance
*
* @throws \LogicException if the stack is already on the first page
*/
@ -81,7 +81,7 @@ class History
/**
* Goes forward in the history.
*
* @return Symfony\Components\BrowserKit\Request A Request instance
* @return Request A Request instance
*
* @throws \LogicException if the stack is already on the last page
*/
@ -97,7 +97,7 @@ class History
/**
* Returns the current element in the history.
*
* @return Symfony\Components\BrowserKit\Request A Request instance
* @return Request A Request instance
*
* @throws \LogicException if the stack is empty
*/

View File

@ -62,7 +62,7 @@ class Container implements ContainerInterface, \ArrayAccess
/**
* Constructor.
*
* @param Symfony\Components\DependencyInjection\ParameterBagInterface $parameterBag A ParameterBagInterface instance
* @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
*/
public function __construct(ParameterBagInterface $parameterBag = null)
{
@ -99,7 +99,7 @@ class Container implements ContainerInterface, \ArrayAccess
/**
* Gets the service container parameter bag.
*
* @return Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface A ParameterBagInterface instance
* @return ParameterBagInterface A ParameterBagInterface instance
*/
public function getParameterBag()
{

View File

@ -25,7 +25,7 @@ class DelegatingLoader extends Loader
/**
* Constructor.
*
* @param \Symfony\Components\DependencyInjection\Loader\LoaderResolverInterface $resolver A LoaderResolverInterface instance
* @param LoaderResolverInterface $resolver A LoaderResolverInterface instance
*/
public function __construct(LoaderResolverInterface $resolver)
{

View File

@ -28,8 +28,8 @@ abstract class FileLoader extends Loader
/**
* Constructor.
*
* @param \Symfony\Components\DependencyInjection\ContainerBuilder $container A ContainerBuilder instance
* @param string|array $paths A path or an array of paths where to look for resources
* @param ContainerBuilder $container A ContainerBuilder instance
* @param string|array $paths A path or an array of paths where to look for resources
*/
public function __construct(ContainerBuilder $container, $paths = array())
{

View File

@ -28,7 +28,7 @@ abstract class Loader implements LoaderInterface
/**
* Constructor.
*
* @param \Symfony\Components\DependencyInjection\ContainerBuilder $container A ContainerBuilder instance
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function __construct(ContainerBuilder $container)
{
@ -38,7 +38,7 @@ abstract class Loader implements LoaderInterface
/**
* Gets the loader resolver.
*
* @return \Symfony\Components\DependencyInjection\Loader\LoaderResolver A LoaderResolver instance
* @return LoaderResolver A LoaderResolver instance
*/
public function getResolver()
{
@ -48,7 +48,7 @@ abstract class Loader implements LoaderInterface
/**
* Sets the loader resolver.
*
* @param \Symfony\Components\DependencyInjection\Loader\LoaderResolver $resolver A LoaderResolver instance
* @param LoaderResolver $resolver A LoaderResolver instance
*/
public function setResolver(LoaderResolver $resolver)
{
@ -70,7 +70,7 @@ abstract class Loader implements LoaderInterface
*
* @param mixed $resource A Resource
*
* @return Symfony\Components\DependencyInjection\Loader\LoaderInterface A LoaderInterface instance
* @return LoaderInterface A LoaderInterface instance
*
* @throws \InvalidArgumentException if no loader is found
*/

View File

@ -74,14 +74,14 @@ interface LoaderInterface
/**
* Gets the loader resolver.
*
* @return \Symfony\Components\Routing\Loader\LoaderResolver A LoaderResolver instance
* @return LoaderResolver A LoaderResolver instance
*/
function getResolver();
/**
* Sets the loader resolver.
*
* @param \Symfony\Components\Routing\Loader\LoaderResolver $resolver A LoaderResolver instance
* @param LoaderResolver $resolver A LoaderResolver instance
*/
function setResolver(LoaderResolver $resolver);
}

View File

@ -25,7 +25,7 @@ class LoaderResolver implements LoaderResolverInterface
/**
* Constructor.
*
* @param \Symfony\Components\DependencyInjection\Loader\LoaderInterface[] $loaders An array of loaders
* @param LoaderInterface[] $loaders An array of loaders
*/
public function __construct(array $loaders = array())
{
@ -40,7 +40,7 @@ class LoaderResolver implements LoaderResolverInterface
*
* @param mixed $resource A resource
*
* @return Symfony\Components\DependencyInjection\Loader\LoaderInterface A LoaderInterface instance
* @return LoaderInterface A LoaderInterface instance
*/
public function resolve($resource)
{
@ -56,7 +56,7 @@ class LoaderResolver implements LoaderResolverInterface
/**
* Sets a loader.
*
* @param \Symfony\Components\DependencyInjection\Loader\LoaderInterface $loader A LoaderInterface instance
* @param LoaderInterface $loader A LoaderInterface instance
*/
public function addLoader(LoaderInterface $loader)
{
@ -67,7 +67,7 @@ class LoaderResolver implements LoaderResolverInterface
/**
* Returns the registered loaders.
*
* @return \Symfony\Components\DependencyInjection\Loader\LoaderInterface[] A array of LoaderInterface instances
* @return LoaderInterface[] A array of LoaderInterface instances
*/
public function getLoaders()
{

View File

@ -25,7 +25,7 @@ interface LoaderResolverInterface
*
* @param mixed $resource A resource
*
* @return Symfony\Components\DependencyInjection\Loader\LoaderInterface A LoaderInterface instance
* @return LoaderInterface A LoaderInterface instance
*/
function resolve($resource);
}

View File

@ -2,6 +2,8 @@
namespace Symfony\Components\DomCrawler;
use Symfony\Components\DomCrawler\FormField;
/*
* This file is part of the Symfony package.
*
@ -220,7 +222,7 @@ class Form implements \ArrayAccess
*
* @param string $name The field name
*
* @return Field\FormField The field instance
* @return FormField The field instance
*
* @throws \InvalidArgumentException When field is not present in this form
*/
@ -238,7 +240,7 @@ class Form implements \ArrayAccess
*
* @param string $name The field name
*
* @return Field\FormField The field instance
* @return FormField The field instance
*/
public function setField(Field\FormField $field)
{
@ -311,7 +313,7 @@ class Form implements \ArrayAccess
*
* @param string $name The field name
*
* @return Symfony\Components\DomCrawler\Field The associated Field instance
* @return FormField The associated Field instance
*
* @throws \InvalidArgumentException if the field does not exist
*/

View File

@ -45,7 +45,7 @@ class Finder implements \IteratorAggregate
/**
* Restricts the matching to directories only.
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*/
public function directories()
{
@ -57,7 +57,7 @@ class Finder implements \IteratorAggregate
/**
* Restricts the matching to files only.
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*/
public function files()
{
@ -76,7 +76,7 @@ class Finder implements \IteratorAggregate
*
* @param int $level The depth level expression
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @see Symfony\Components\Finder\Iterator\DepthRangeFilterIterator
* @see Symfony\Components\Finder\Comparator\NumberComparator
@ -100,7 +100,7 @@ class Finder implements \IteratorAggregate
*
* @param string $date A date rage string
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @see strtotime
* @see Symfony\Components\Finder\Iterator\DateRangeFilterIterator
@ -124,7 +124,7 @@ class Finder implements \IteratorAggregate
*
* @param string $pattern A pattern (a regexp, a glob, or a string)
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @see Symfony\Components\Finder\Iterator\FilenameFilterIterator
*/
@ -140,7 +140,7 @@ class Finder implements \IteratorAggregate
*
* @param string $pattern A pattern (a regexp, a glob, or a string)
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @see Symfony\Components\Finder\Iterator\FilenameFilterIterator
*/
@ -160,7 +160,7 @@ class Finder implements \IteratorAggregate
*
* @param string $size A size range string
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @see Symfony\Components\Finder\Iterator\SizeRangeFilterIterator
* @see Symfony\Components\Finder\Comparator\NumberComparator
@ -177,7 +177,7 @@ class Finder implements \IteratorAggregate
*
* @param string $dir A directory to exclude
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @see Symfony\Components\Finder\Iterator\ExcludeDirectoryFilterIterator
*/
@ -191,7 +191,7 @@ class Finder implements \IteratorAggregate
/**
* Forces the finder to ignore version control directories.
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @see Symfony\Components\Finder\Iterator\IgnoreVcsFilterIterator
*/
@ -211,7 +211,7 @@ class Finder implements \IteratorAggregate
*
* @param Closure $closure An anonymous function
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @see Symfony\Components\Finder\Iterator\SortableIterator
*/
@ -227,7 +227,7 @@ class Finder implements \IteratorAggregate
*
* This can be slow as all the matching files and directories must be retrieved for comparison.
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @see Symfony\Components\Finder\Iterator\SortableIterator
*/
@ -243,7 +243,7 @@ class Finder implements \IteratorAggregate
*
* This can be slow as all the matching files and directories must be retrieved for comparison.
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @see Symfony\Components\Finder\Iterator\SortableIterator
*/
@ -262,7 +262,7 @@ class Finder implements \IteratorAggregate
*
* @param Closure $closure An anonymous function
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @see Symfony\Components\Finder\Iterator\CustomFilterIterator
*/
@ -276,7 +276,7 @@ class Finder implements \IteratorAggregate
/**
* Forces the following of symlinks.
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*/
public function followLinks()
{
@ -290,7 +290,7 @@ class Finder implements \IteratorAggregate
*
* @param string|array $dirs A directory path or an array of directories
*
* @return Symfony\Components\Finder\Finder The current Finder instance
* @return Finder The current Finder instance
*
* @throws \InvalidArgumentException if one of the directory does not exist
*/

View File

@ -30,9 +30,9 @@ class CacheControl
/**
* Constructor.
*
* @param \Symfony\Components\HttpFoundation\HeaderBag $bag A HeaderBag instance
* @param string $header The value of the Cache-Control HTTP header
* @param string $type The type (null, request, or response)
* @param HeaderBag $bag A HeaderBag instance
* @param string $header The value of the Cache-Control HTTP header
* @param string $type The type (null, request, or response)
*/
public function __construct(HeaderBag $bag, $header, $type = null)
{

View File

@ -147,7 +147,7 @@ class HeaderBag
/**
* Returns an instance able to manage the Cache-Control header.
*
* @return \Symfony\Components\HttpFoundation\CacheControl A CacheControl instance
* @return CacheControl A CacheControl instance
*/
public function getCacheControl()
{

View File

@ -69,9 +69,9 @@ class Cache implements HttpKernelInterface
* This setting is overriden by the stale-if-error HTTP Cache-Control extension
* (see RFC 5861).
*
* @param Symfony\Components\HttpKernel\HttpKernelInterface $kernel An HttpKernelInterface instance
* @param Symfony\Components\HttpKernel\Cache\Store $store A Store instance
* @param Symfony\Components\HttpKernel\Cache\Esi $esi An Esi instance
* @param HttpKernelInterface $kernel An HttpKernelInterface instance
* @param Store $store A Store instance
* @param Esi $esi An Esi instance
* @param array $options An array of options
*/
public function __construct(HttpKernelInterface $kernel, Store $store, Esi $esi = null, array $options = array())
@ -132,9 +132,9 @@ class Cache implements HttpKernelInterface
/**
* Handles a Request.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param integer $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST, HttpKernelInterface::FORWARDED_REQUEST, or HttpKernelInterface::EMBEDDED_REQUEST)
* @param Boolean $raw Whether to catch exceptions or not (this is NOT used in this context)
* @param Request $request A Request instance
* @param integer $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST, HttpKernelInterface::FORWARDED_REQUEST, or HttpKernelInterface::EMBEDDED_REQUEST)
* @param Boolean $raw Whether to catch exceptions or not (this is NOT used in this context)
*
* @return Symfony\Components\HttpFoundation\Response A Response instance
*/
@ -178,9 +178,9 @@ class Cache implements HttpKernelInterface
/**
* Forwards the Request to the backend without storing the Response in the cache.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
protected function pass(Request $request)
{
@ -192,9 +192,9 @@ class Cache implements HttpKernelInterface
/**
* Invalidates non-safe methods (like POST, PUT, and DELETE).
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*
* @see RFC2616 13.10
*/
@ -229,9 +229,9 @@ class Cache implements HttpKernelInterface
* the backend using conditional GET. When no matching cache entry is found,
* it triggers "miss" processing.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
protected function lookup(Request $request)
{
@ -278,10 +278,10 @@ class Cache implements HttpKernelInterface
* The original request is used as a template for a conditional
* GET request with the backend.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Symfony\Components\HttpFoundation\Response $entry A Response instance to validate
* @param Request $request A Request instance
* @param Response $entry A Response instance to validate
*
* @return Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
protected function validate(Request $request, $entry)
{
@ -338,9 +338,9 @@ class Cache implements HttpKernelInterface
*
* This methods is trigered when the cache missed or a reload is required.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
protected function fetch(Request $request)
{
@ -371,11 +371,11 @@ class Cache implements HttpKernelInterface
/**
* Forwards the Request to the backend and returns the Response.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Boolean $raw Whether to catch exceptions or not
* @param Symfony\Components\HttpFoundation\Response $response A Response instance (the stale entry if present, null otherwise)
* @param Request $request A Request instance
* @param Boolean $raw Whether to catch exceptions or not
* @param Response $response A Response instance (the stale entry if present, null otherwise)
*
* @return Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
protected function forward(Request $request, $raw = false, Response $entry = null)
{
@ -408,8 +408,8 @@ class Cache implements HttpKernelInterface
/**
* Checks whether the cache entry is "fresh enough" to satisfy the Request.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Symfony\Components\HttpFoundation\Response $entry A Response instance
* @param Request $request A Request instance
* @param Response $entry A Response instance
*
* @return Boolean true if the cache entry if fresh enough, false otherwise
*/
@ -429,8 +429,8 @@ class Cache implements HttpKernelInterface
/**
* Locks a Request during the call to the backend.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Symfony\Components\HttpFoundation\Response $entry A Response instance
* @param Request $request A Request instance
* @param Response $entry A Response instance
*
* @return Boolean true if the cache entry can be returned even if it is staled, false otherwise
*/
@ -486,8 +486,8 @@ class Cache implements HttpKernelInterface
/**
* Writes the Response to the cache.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Request $request A Request instance
* @param Response $response A Response instance
*/
protected function store(Request $request, Response $response)
{
@ -512,9 +512,9 @@ class Cache implements HttpKernelInterface
/**
* Restores the Response body.
*
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Response $response A Response instance
*
* @return Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
protected function restoreResponseBody(Response $response)
{
@ -553,7 +553,7 @@ class Cache implements HttpKernelInterface
* Checks if the Request includes authorization or other sensitive information
* that should cause the Response to be considered private by default.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return Boolean true if the Request is private, false otherwise
*/

View File

@ -46,7 +46,7 @@ class Esi
/**
* Checks that at least one surrogate has ESI/1.0 capability.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return Boolean true if one surrogate has ESI/1.0 capability, false otherwise
*/
@ -62,7 +62,7 @@ class Esi
/**
* Adds ESI/1.0 capability to the given Request.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*/
public function addSurrogateEsiCapability(Request $request)
{
@ -77,7 +77,7 @@ class Esi
*
* This method only adds an ESI HTTP header if the Response has some ESI tags.
*
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Response $response A Response instance
*/
public function addSurrogateControl(Response $response)
{
@ -89,7 +89,7 @@ class Esi
/**
* Checks that the Response needs to be parsed for ESI tags.
*
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Response $response A Response instance
*
* @return Boolean true if the Response needs to be parsed, false otherwise
*/
@ -128,8 +128,8 @@ class Esi
/**
* Replaces a Response ESI tags with the included resource content.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Request $request A Request instance
* @param Response $response A Response instance
*/
public function process(Request $request, Response $response)
{
@ -165,10 +165,10 @@ class Esi
/**
* Handles an ESI from the cache.
*
* @param Symfony\Components\HttpKernel\Cache\Cache $cache A Cache instance
* @param string $uri The main URI
* @param string $alt An alternative URI
* @param Boolean $ignoreErrors Whether to ignore errors or not
* @param Cache $cache A Cache instance
* @param string $uri The main URI
* @param string $alt An alternative URI
* @param Boolean $ignoreErrors Whether to ignore errors or not
*/
public function handle(Cache $cache, $uri, $alt, $ignoreErrors)
{

View File

@ -30,7 +30,7 @@ class EsiListener
/**
* Constructor.
*
* @param Symfony\Components\HttpKernel\Cache\Esi $esi An ESI instance
* @param Esi $esi An ESI instance
*/
public function __construct(Esi $esi = null)
{
@ -40,7 +40,7 @@ class EsiListener
/**
* Registers a core.response listener to add the Surrogate-Control header to a Response when needed.
*
* @param Symfony\Components\EventDispatcher\EventDispatcher $dispatcher An EventDispatcher instance
* @param EventDispatcher $dispatcher An EventDispatcher instance
*/
public function register(EventDispatcher $dispatcher)
{
@ -53,8 +53,8 @@ class EsiListener
/**
* Filters the Response.
*
* @param Symfony\Components\EventDispatcher\Event $event An Event instance
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Event $event An Event instance
* @param Response $response A Response instance
*/
public function filter($event, Response $response)
{

View File

@ -65,7 +65,7 @@ class Store
/**
* Locks the cache for a given Request.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return Boolean|string true if the lock is acquired, the path to the current lock otherwise
*/
@ -85,7 +85,7 @@ class Store
/**
* Releases the lock for the given Request.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*/
public function unlock(Request $request)
{
@ -95,9 +95,9 @@ class Store
/**
* Locates a cached Response for the Request provided.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return Symfony\Components\HttpFoundation\Response|null A Response instance, or null if no cache entry was found
* @return Response|null A Response instance, or null if no cache entry was found
*/
public function lookup(Request $request)
{
@ -139,8 +139,8 @@ class Store
* Existing entries are read and any that match the response are removed. This
* method calls write with the new list of cache entries.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Request $request A Request instance
* @param Response $response A Response instance
*
* @return string The key under which the response is stored
*/
@ -192,7 +192,7 @@ class Store
/**
* Invalidates all cache entries that match the request.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*/
public function invalidate(Request $request)
{
@ -342,7 +342,7 @@ class Store
/**
* Returns a cache key for the given Request.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return string A key for the given Request
*/
@ -358,7 +358,7 @@ class Store
/**
* Persists the Request HTTP headers.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return array An array of HTTP headers
*/
@ -370,7 +370,7 @@ class Store
/**
* Persists the Response HTTP headers.
*
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Response $response A Response instance
*
* @return array An array of HTTP headers
*/

View File

@ -33,10 +33,10 @@ class Client extends BaseClient
/**
* Constructor.
*
* @param Symfony\Components\HttpKernel\HttpKernelInterface $kernel An HttpKernel instance
* @param array $server The server parameters (equivalent of $_SERVER)
* @param Symfony\Components\BrowserKit\History $history A History instance to store the browser history
* @param Symfony\Components\BrowserKit\CookieJar $cookieJar A CookieJar instance to store the cookies
* @param HttpKernelInterface $kernel An HttpKernel instance
* @param array $server The server parameters (equivalent of $_SERVER)
* @param History $history A History instance to store the browser history
* @param CookieJar $cookieJar A CookieJar instance to store the cookies
*/
public function __construct(HttpKernelInterface $kernel, array $server = array(), History $history = null, CookieJar $cookieJar = null)
{
@ -50,9 +50,9 @@ class Client extends BaseClient
/**
* Makes a request.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @return Response A Response instance
*/
protected function doRequest($request)
{
@ -62,7 +62,7 @@ class Client extends BaseClient
/**
* Returns the script to execute when the request must be insulated.
*
* @param Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*/
protected function getScript($request)
{
@ -91,9 +91,9 @@ EOF;
/**
* Converts the BrowserKit request to a HttpKernel request.
*
* @param Symfony\Components\BrowserKit\Request $request A Request instance
* @param Request $request A Request instance
*
* @return Symfony\Components\HttpFoundation\Request A Request instance
* @return Request A Request instance
*/
protected function filterRequest(DomRequest $request)
{
@ -108,9 +108,9 @@ EOF;
/**
* Converts the HttpKernel response to a BrowserKit response.
*
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Response $response A Response instance
*
* @return Symfony\Components\BrowserKit\Response A Response instance
* @return Response A Response instance
*/
protected function filterResponse($response)
{

View File

@ -36,7 +36,7 @@ interface ControllerResolverInterface
* The resolver must only throw an exception when it should be able to load
* controller but cannot because of some errors made by the developer.
*
* @param \Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
*
* @return mixed|Boolean A PHP callable representing the Controller,
* or false if this resolver is not able to determine the controller
@ -48,8 +48,8 @@ interface ControllerResolverInterface
/**
* Returns the arguments to pass to the controller.
*
* @param \Symfony\Components\HttpFoundation\Request $request A Request instance
* @param mixed $controller A PHP callable
* @param Request $request A Request instance
* @param mixed $controller A PHP callable
*
* @throws \RuntimeException When value for argument given is not provided
*/

View File

@ -34,8 +34,8 @@ class HttpKernel implements HttpKernelInterface
/**
* Constructor
*
* @param \Symfony\Components\EventDispatcher\EventDispatcher $dispatcher An event dispatcher instance
* @param \Symfony\Components\HttpKernel\Controller\ControllerResolverInterface $resolver A ControllerResolverInterface instance
* @param EventDispatcher $dispatcher An event dispatcher instance
* @param ControllerResolverInterface $resolver A ControllerResolverInterface instance
*/
public function __construct(EventDispatcher $dispatcher, ControllerResolverInterface $resolver)
{
@ -59,11 +59,11 @@ class HttpKernel implements HttpKernelInterface
* All exceptions are caught, and a core.exception event is notified
* for user management.
*
* @param \Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
* @param integer $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST, HttpKernelInterface::FORWARDED_REQUEST, or HttpKernelInterface::EMBEDDED_REQUEST)
* @param Boolean $raw Whether to catch exceptions or not
*
* @return \Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*
* @throws \Exception When an Exception occurs during processing
* and couldn't be caught by event processing or $raw is true
@ -104,13 +104,13 @@ class HttpKernel implements HttpKernelInterface
*
* Exceptions are not caught.
*
* @param \Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
* @param integer $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST, HttpKernelInterface::FORWARDED_REQUEST, or HttpKernelInterface::EMBEDDED_REQUEST)
*
* @return \Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*
* @throws \LogicException If one of the listener does not behave as expected
* @throws \Symfony\Components\HttpKernel\Exception\NotFoundHttpException When controller cannot be found
* @throws NotFoundHttpException When controller cannot be found
*/
protected function handleRaw(Request $request, $type = self::MASTER_REQUEST)
{
@ -148,7 +148,7 @@ class HttpKernel implements HttpKernelInterface
/**
* Handles a request that need to be embedded.
*
* @param \Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
* @param Boolean $raw Whether to catch exceptions or not
*
* @return string|false The Response content or false if there is a problem
@ -179,11 +179,11 @@ class HttpKernel implements HttpKernelInterface
/**
* Filters a response object.
*
* @param \Symfony\Components\HttpFoundation\Response $response A Response instance
* @param string $message A error message in case the response is not a Response object
* @param integer $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST, HttpKernelInterface::FORWARDED_REQUEST, or HttpKernelInterface::EMBEDDED_REQUEST)
* @param Response $response A Response instance
* @param string $message A error message in case the response is not a Response object
* @param integer $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST, HttpKernelInterface::FORWARDED_REQUEST, or HttpKernelInterface::EMBEDDED_REQUEST)
*
* @return \Symfony\Components\HttpFoundation\Response The filtered Response instance
* @return Response The filtered Response instance
*
* @throws \RuntimeException if the passed object is not a Response instance
*/

View File

@ -29,18 +29,18 @@ interface HttpKernelInterface
/**
* Handles a request to convert it to a response.
*
* @param \Symfony\Components\HttpFoundation\Request $request A Request instance
* @param Request $request A Request instance
* @param integer $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST, HttpKernelInterface::FORWARDED_REQUEST, or HttpKernelInterface::EMBEDDED_REQUEST)
* @param Boolean $raw Whether to catch exceptions or not
*
* @return \Symfony\Components\HttpFoundation\Response $response A Response instance
* @return Response $response A Response instance
*/
public function handle(Request $request = null, $type = self::MASTER_REQUEST, $raw = false);
/**
* Gets the Request instance associated with the master request.
*
* @return \Symfony\Components\HttpFoundation\Request A Request instance
* @return Request A Request instance
*/
public function getRequest();
}

View File

@ -48,9 +48,9 @@ class Profiler implements \ArrayAccess
/**
* Returns a new Profiler for the given Response.
*
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Response $response A Response instance
*
* @return Symfony\Components\HttpKernel\Profiler\Profiler A new Profiler instance
* @return Profiler A new Profiler instance
*/
public function load(Response $response)
{
@ -66,7 +66,7 @@ class Profiler implements \ArrayAccess
*
* @param string $token A token
*
* @return Symfony\Components\HttpKernel\Profiler\Profiler A new Profiler instance
* @return Profiler A new Profiler instance
*/
public function getProfilerForToken($token)
{
@ -80,7 +80,7 @@ class Profiler implements \ArrayAccess
/**
* Collects data for the given Response.
*
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Response $response A Response instance
*/
public function collect(Response $response)
{
@ -123,7 +123,7 @@ class Profiler implements \ArrayAccess
/**
* Gets the profiler storage.
*
* @return Symfony\Components\HttpKernel\Profiler\ProfilerStorage A ProfilerStorage instance
* @return ProfilerStorage A ProfilerStorage instance
*/
public function getProfilerStorage()
{
@ -133,7 +133,7 @@ class Profiler implements \ArrayAccess
/**
* Gets the Response.
*
* @return Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
public function getResponse()
{
@ -166,7 +166,7 @@ class Profiler implements \ArrayAccess
/**
* Adds a Collector.
*
* @param Symfony\Components\HttpKernel\Profiler\DataCollector\DataCollectorInterface $collector A DataCollectorInterface instance
* @param DataCollectorInterface $collector A DataCollectorInterface instance
*/
public function addCollector(DataCollectorInterface $collector)
{
@ -188,7 +188,7 @@ class Profiler implements \ArrayAccess
*
* @param string $name A collector name
*
* @return Symfony\Components\HttpKernel\Profiler\DataCollector\DataCollectorInterface A DataCollectorInterface instance
* @return DataCollectorInterface A DataCollectorInterface instance
*
* @throws \InvalidArgumentException if the collector does not exist
*/

View File

@ -35,7 +35,7 @@ class ProfilerListener
/**
* Registers a core.response listener.
*
* @param Symfony\Components\EventDispatcher\EventDispatcher $dispatcher An EventDispatcher instance
* @param EventDispatcher $dispatcher An EventDispatcher instance
*/
public function register(EventDispatcher $dispatcher)
{

View File

@ -36,7 +36,7 @@ class WebDebugToolbarListener
/**
* Registers a core.response listener.
*
* @param Symfony\Components\EventDispatcher\EventDispatcher $dispatcher An EventDispatcher instance
* @param EventDispatcher $dispatcher An EventDispatcher instance
*/
public function register(EventDispatcher $dispatcher)
{

View File

@ -27,7 +27,7 @@ class ResponseListener
/**
* Registers a core.response listener to change the Content-Type header based on the Request format.
*
* @param Symfony\Components\EventDispatcher\EventDispatcher $dispatcher An EventDispatcher instance
* @param EventDispatcher $dispatcher An EventDispatcher instance
*/
public function register(EventDispatcher $dispatcher)
{
@ -37,8 +37,8 @@ class ResponseListener
/**
* Filters the Response.
*
* @param Symfony\Components\EventDispatcher\Event $event An Event instance
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @param Event $event An Event instance
* @param Response $response A Response instance
*/
public function filter(Event $event, Response $response)
{

View File

@ -30,7 +30,7 @@ abstract class WebTestCase extends \PHPUnit_Framework_TestCase
* @param Boolean $debug The debug flag
* @param array $server An array of server parameters
*
* @return Symfony\Framework\Client A Client instance
* @return Client A Client instance
*/
abstract public function createClient(array $options = array(), array $server = array());
}

View File

@ -35,8 +35,8 @@ class IteratorDecorator extends ObjectDecorator implements \Iterator, \Countable
/**
* Constructs a new escaping iterator using the escaping method and value supplied.
*
* @param string $escaper The escaping method to use
* @param \Traversable $value The iterator to escape
* @param string $escaper The escaping method to use
* @param \Traversable $value The iterator to escape
*/
public function __construct($escaper, \Traversable $value)
{

View File

@ -2,6 +2,8 @@
namespace Symfony\Components\Routing\Loader;
use Symfony\Components\Routing\RouteCollection;
/*
* This file is part of the Symfony framework.
*
@ -25,7 +27,7 @@ class DelegatingLoader extends Loader
/**
* Constructor.
*
* @param \Symfony\Components\Routing\Loader\LoaderResolverInterface $resolver A LoaderResolverInterface instance
* @param LoaderResolverInterface $resolver A LoaderResolverInterface instance
*/
public function __construct(LoaderResolverInterface $resolver)
{
@ -37,7 +39,7 @@ class DelegatingLoader extends Loader
*
* @param mixed $resource A resource
*
* @return \Symfony\Components\Routing\RouteCollection A RouteCollection instance
* @return RouteCollection A RouteCollection instance
*/
public function load($resource)
{

View File

@ -2,6 +2,8 @@
namespace Symfony\Components\Routing\Loader;
use Symfony\Components\Routing\RouteCollection;
/*
* This file is part of the Symfony framework.
*
@ -39,9 +41,9 @@ abstract class FileLoader extends Loader
/**
* Adds routes from a resource.
*
* @param mixed $resource A Resource
* @param mixed $resource A Resource
*
* @return Symfony\Components\Routing\RouteCollection A RouteCollection instance
* @return RouteCollection A RouteCollection instance
*/
public function import($resource)
{

View File

@ -25,7 +25,7 @@ abstract class Loader implements LoaderInterface
/**
* Gets the loader resolver.
*
* @return \Symfony\Components\Routing\Loader\LoaderResolver A LoaderResolver instance
* @return LoaderResolver A LoaderResolver instance
*/
public function getResolver()
{
@ -35,7 +35,7 @@ abstract class Loader implements LoaderInterface
/**
* Sets the loader resolver.
*
* @param \Symfony\Components\Routing\Loader\LoaderResolver $resolver A LoaderResolver instance
* @param LoaderResolver $resolver A LoaderResolver instance
*/
public function setResolver(LoaderResolver $resolver)
{
@ -57,7 +57,7 @@ abstract class Loader implements LoaderInterface
*
* @param mixed $resource A Resource
*
* @return Symfony\Components\Routing\Loader\LoaderInterface A LoaderInterface instance
* @return LoaderInterface A LoaderInterface instance
*
* @throws \InvalidArgumentException if no loader is found
*/

View File

@ -43,14 +43,14 @@ interface LoaderInterface
/**
* Gets the loader resolver.
*
* @return \Symfony\Components\Routing\Loader\LoaderResolver A LoaderResolver instance
* @return LoaderResolver A LoaderResolver instance
*/
function getResolver();
/**
* Sets the loader resolver.
*
* @param \Symfony\Components\Routing\Loader\LoaderResolver $resolver A LoaderResolver instance
* @param LoaderResolver $resolver A LoaderResolver instance
*/
function setResolver(LoaderResolver $resolver);
}

View File

@ -25,7 +25,7 @@ class LoaderResolver implements LoaderResolverInterface
/**
* Constructor.
*
* @param \Symfony\Components\Routing\Loader\LoaderInterface[] $loaders An array of loaders
* @param LoaderInterface[] $loaders An array of loaders
*/
public function __construct(array $loaders = array())
{
@ -40,7 +40,7 @@ class LoaderResolver implements LoaderResolverInterface
*
* @param mixed $resource A resource
*
* @return Symfony\Components\Routing\Loader\LoaderInterface A LoaderInterface instance
* @return LoaderInterface A LoaderInterface instance
*/
public function resolve($resource)
{
@ -56,7 +56,7 @@ class LoaderResolver implements LoaderResolverInterface
/**
* Sets a loader.
*
* @param \Symfony\Components\Routing\Loader\LoaderInterface $loader A LoaderInterface instance
* @param LoaderInterface $loader A LoaderInterface instance
*/
public function addLoader(LoaderInterface $loader)
{
@ -67,7 +67,7 @@ class LoaderResolver implements LoaderResolverInterface
/**
* Returns the registered loaders.
*
* @return \Symfony\Components\Routing\Loader\LoaderInterface[] A array of LoaderInterface instances
* @return LoaderInterface[] A array of LoaderInterface instances
*/
public function getLoaders()
{

View File

@ -25,7 +25,7 @@ interface LoaderResolverInterface
*
* @param mixed $resource A resource
*
* @return Symfony\Components\Routing\Loader\LoaderInterface A LoaderInterface instance
* @return LoaderInterface A LoaderInterface instance
*/
function resolve($resource);
}

View File

@ -40,11 +40,11 @@ class Router implements RouterInterface
* * cache_dir: The cache directory (or null to disable caching)
* * debug: Whether to enable debugging or not (false by default)
*
* @param Symfony\Components\Routing\Loader\LoaderInterface $loader A LoaderInterface instance
* @param mixed $resource The main resource to load
* @param array $options An array of options
* @param array $context The context
* @param array $defaults The default values
* @param LoaderInterface $loader A LoaderInterface instance
* @param mixed $resource The main resource to load
* @param array $options An array of options
* @param array $context The context
* @param array $defaults The default values
*
* @throws \InvalidArgumentException When unsupported option is provided
*/

View File

@ -39,7 +39,7 @@ abstract class FilesLoader extends LoaderChain
/**
* Takes mapping file path
* @param string $file
* @return Symfony\Components\Validator\Mapping\Loader\LoaderInterface
* @return LoaderInterface
*/
abstract protected function getFileLoaderInstance($file);
}

View File

@ -3,6 +3,7 @@
namespace Symfony\Framework\Bundle;
use Symfony\Components\DependencyInjection\ContainerInterface;
use Symfony\Components\DependencyInjection\ContainerBuilder;
use Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface;
use Symfony\Components\Console\Application;
use Symfony\Components\Finder\Finder;
@ -33,9 +34,9 @@ abstract class Bundle implements BundleInterface
/**
* Customizes the Container instance.
*
* @param \Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface $parameterBag A ParameterBagInterface instance
* @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
*
* @return \Symfony\Components\DependencyInjection\ContainerBuilder A ContainerBuilder instance
* @return ContainerBuilder A ContainerBuilder instance
*/
public function buildContainer(ParameterBagInterface $parameterBag)
{
@ -44,7 +45,7 @@ abstract class Bundle implements BundleInterface
/**
* Boots the Bundle.
*
* @param \Symfony\Components\DependencyInjection\ContainerInterface $container A ContainerInterface instance
* @param ContainerInterface $container A ContainerInterface instance
*/
public function boot(ContainerInterface $container)
{
@ -53,7 +54,7 @@ abstract class Bundle implements BundleInterface
/**
* Shutdowns the Bundle.
*
* @param \Symfony\Components\DependencyInjection\ContainerInterface $container A ContainerInterface instance
* @param ContainerInterface $container A ContainerInterface instance
*/
public function shutdown(ContainerInterface $container)
{
@ -118,7 +119,7 @@ abstract class Bundle implements BundleInterface
/**
* Finds and registers commands for the current bundle.
*
* @param Symfony\Components\Console\Application $application An Application instance
* @param Application $application An Application instance
*/
public function registerCommands(Application $application)
{

View File

@ -3,6 +3,7 @@
namespace Symfony\Framework\Bundle;
use Symfony\Components\DependencyInjection\ContainerInterface;
use Symfony\Components\DependencyInjection\ContainerBuilder;
use Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface;
/*
@ -26,23 +27,23 @@ interface BundleInterface
/**
* Customizes the Container instance.
*
* @param \Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface $parameterBag A ParameterBagInterface instance
* @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
*
* @return \Symfony\Components\DependencyInjection\ContainerBuilder A ContainerBuilder instance
* @return ContainerBuilder A ContainerBuilder instance
*/
public function buildContainer(ParameterBagInterface $parameterBag);
/**
* Boots the Bundle.
*
* @param Symfony\Components\DependencyInjection\ContainerInterface $container A ContainerInterface instance
* @param ContainerInterface $container A ContainerInterface instance
*/
public function boot(ContainerInterface $container);
/**
* Shutdowns the Bundle.
*
* @param Symfony\Components\DependencyInjection\ContainerInterface $container A ContainerInterface instance
* @param ContainerInterface $container A ContainerInterface instance
*/
public function shutdown(ContainerInterface $container);
}

View File

@ -29,7 +29,7 @@ abstract class Cache extends BaseCache
/**
* Constructor.
*
* @param Symfony\Components\HttpKernel\HttpKernelInterface $kernel An HttpKernelInterface instance
* @param HttpKernelInterface $kernel An HttpKernelInterface instance
*/
public function __construct(HttpKernelInterface $kernel)
{
@ -42,11 +42,11 @@ abstract class Cache extends BaseCache
/**
* Forwards the Request to the backend and returns the Response.
*
* @param Symfony\Components\HttpFoundation\Response $request A Request instance
* @param Boolean $raw Whether to catch exceptions or not
* @param Symfony\Components\HttpFoundation\Response $response A Response instance (the stale entry if present, null otherwise)
* @param Requset $request A Request instance
* @param Boolean $raw Whether to catch exceptions or not
* @param Response $response A Response instance (the stale entry if present, null otherwise)
*
* @return Symfony\Components\HttpFoundation\Response A Response instance
* @return Response A Response instance
*/
protected function forward(Request $request, $raw = false, Response $entry = null)
{

View File

@ -2,10 +2,14 @@
namespace Symfony\Framework;
use Symfony\Components\DependencyInjection\ContainerInterface;
use Symfony\Components\HttpKernel\HttpKernelInterface;
use Symfony\Components\HttpKernel\Client as BaseClient;
use Symfony\Components\BrowserKit\History;
use Symfony\Components\BrowserKit\CookieJar;
use Symfony\Components\HttpKernel\Profiler\Profiler;
use Symfony\Components\HttpFoundation\Request;
use Symfony\Components\HttpFoundation\Response;
/*
* This file is part of the Symfony package.
@ -30,10 +34,10 @@ class Client extends BaseClient
/**
* Constructor.
*
* @param Symfony\Components\HttpKernel\HttpKernelInterface $kernel A Kernel instance
* @param array $server The server parameters (equivalent of $_SERVER)
* @param Symfony\Components\BrowserKit\History $history A History instance to store the browser history
* @param Symfony\Components\BrowserKit\CookieJar $cookieJar A CookieJar instance to store the cookies
* @param HttpKernelInterface $kernel A Kernel instance
* @param array $server The server parameters (equivalent of $_SERVER)
* @param History $history A History instance to store the browser history
* @param CookieJar $cookieJar A CookieJar instance to store the cookies
*/
public function __construct(HttpKernelInterface $kernel, array $server = array(), History $history = null, CookieJar $cookieJar = null)
{
@ -45,7 +49,7 @@ class Client extends BaseClient
/**
* Returns the container.
*
* @return Symfony\Components\DependencyInjection\Container
* @return ContainerInterface
*/
public function getContainer()
{
@ -55,7 +59,7 @@ class Client extends BaseClient
/**
* Returns the kernel.
*
* @return Symfony\Framework\Kernel
* @return Kernel
*/
public function getKernel()
{
@ -65,7 +69,7 @@ class Client extends BaseClient
/**
* Gets a profiler for the current Response.
*
* @return Symfony\Components\HttpKernel\Profiler\Profiler A Profiler instance
* @return Profiler A Profiler instance
*/
public function getProfiler()
{
@ -79,9 +83,9 @@ class Client extends BaseClient
/**
* Makes a request.
*
* @param Symfony\Components\HttpFoundation\Response $request A Request instance
* @param Request $request A Request instance
*
* @param Symfony\Components\HttpFoundation\Response $response A Response instance
* @return Response A Response instance
*/
protected function doRequest($request)
{
@ -93,7 +97,9 @@ class Client extends BaseClient
/**
* Returns the script to execute when the request must be insulated.
*
* @param Symfony\Components\HttpFoundation\Response $request A Request instance
* @param Request $request A Request instance
*
* @return string The script content
*/
protected function getScript($request)
{

View File

@ -32,9 +32,9 @@ class KernelBundle extends Bundle
/**
* Customizes the Container instance.
*
* @param \Symfony\Components\DependencyInjection\ParameterBag\ParameterBagInterface $parameterBag A ParameterBagInterface instance
* @param ParameterBagInterface $parameterBag A ParameterBagInterface instance
*
* @return \Symfony\Components\DependencyInjection\ContainerBuilder A ContainerBuilder instance
* @return ContainerBuilder A ContainerBuilder instance
*/
public function buildContainer(ParameterBagInterface $parameterBag)
{
@ -56,7 +56,7 @@ class KernelBundle extends Bundle
/**
* Boots the Bundle.
*
* @param Symfony\Components\DependencyInjection\ContainerInterface $container A ContainerInterface instance
* @param ContainerInterface $container A ContainerInterface instance
*/
public function boot(ContainerInterface $container)
{

View File

@ -3,6 +3,7 @@
namespace Symfony\Framework\Test;
use Symfony\Components\HttpKernel\Test\WebTestCase as BaseWebTestCase;
use Symfony\Framework\Client;
/*
* This file is part of the Symfony package.
@ -30,7 +31,7 @@ abstract class WebTestCase extends BaseWebTestCase
* @param array $options An array of options to pass to the createKernel class
* @param array $server An array of server parameters
*
* @return Symfony\Framework\Client A Client instance
* @return Client A Client instance
*/
public function createClient(array $options = array(), array $server = array())
{
@ -48,7 +49,7 @@ abstract class WebTestCase extends BaseWebTestCase
*
* @param array $options An array of options
*
* @return Symfony\Components\HttpKernel\HttpKernelInterface A HttpKernelInterface instance
* @return HttpKernelInterface A HttpKernelInterface instance
*/
abstract protected function createKernel(array $options = array());
}