Merge remote branch 'pborreli/phpdoc-fix'

* pborreli/phpdoc-fix:
  [Phpdoc] Cleaning/fixing
  [FrameworkBundle] Fixed typo in css
This commit is contained in:
Fabien Potencier 2011-04-23 21:50:16 +02:00
commit 278223d950
161 changed files with 459 additions and 407 deletions

View File

@ -30,10 +30,9 @@ class EntitiesToArrayTransformer implements DataTransformerInterface
/**
* Transforms entities into choice keys
*
* @param Collection|object A collection of entities, a single entity or
* NULL
* @return mixed An array of choice keys, a single key or
* NULL
* @param Collection|object $collection A collection of entities, a single entity or
* NULL
* @return mixed An array of choice keys, a single key or NULL
*/
public function transform($collection)
{

View File

@ -28,10 +28,9 @@ class EntityToIdTransformer implements DataTransformerInterface
/**
* Transforms entities into choice keys
*
* @param Collection|object A collection of entities, a single entity or
* NULL
* @return mixed An array of choice keys, a single key or
* NULL
* @param Collection|object $entity A collection of entities, a single entity or
* NULL
* @return mixed An array of choice keys, a single key or NULL
*/
public function transform($entity)
{

View File

@ -45,8 +45,8 @@ class FormExtension extends \Twig_Extension
/**
* Sets a theme for a given view.
*
* @param FormView $view A FormView instance
* @param array $resources An array of resources
* @param FormView $view A FormView instance
* @param array $resources An array of resources
*/
public function setTheme(FormView $view, array $resources)
{
@ -95,7 +95,8 @@ class FormExtension extends \Twig_Extension
/**
* Renders a row for the view.
*
* @param FormView $view The view to render as a row
* @param FormView $view The view to render as a row
* @param array $variables An array of variables
*/
public function renderRow(FormView $view, array $variables = array())
{
@ -122,9 +123,8 @@ class FormExtension extends \Twig_Extension
*
* {{ form_widget(view, {}, {'separator': '+++++'}) }}
*
* @param FormView $view The view to render
* @param array $attributes HTML attributes passed to the template
* @param array $parameters Additional variables passed to the template
* @param FormView $view The view to render
* @param array $variables Additional variables passed to the template
* @param array|string $resources A resource or array of resources
*/
public function renderWidget(FormView $view, array $variables = array(), $resources = null)
@ -140,7 +140,6 @@ class FormExtension extends \Twig_Extension
* Renders the errors of the given view
*
* @param FormView $view The view to render the errors for
* @param array $params Additional variables passed to the template
*/
public function renderErrors(FormView $view)
{
@ -150,7 +149,8 @@ class FormExtension extends \Twig_Extension
/**
* Renders the label of the given view
*
* @param FormView $view The view to render the label for
* @param FormView $view The view to render the label for
* @param string $label Label name
*/
public function renderLabel(FormView $view, $label = null)
{

View File

@ -26,7 +26,7 @@ class FormThemeNode extends \Twig_Node
/**
* Compiles the node to PHP.
*
* @param \Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler $compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{

View File

@ -26,7 +26,7 @@ class TransNode extends \Twig_Node
/**
* Compiles the node to PHP.
*
* @param \Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler $compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{

View File

@ -46,7 +46,7 @@ class FormThemeTokenParser extends \Twig_TokenParser
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
* @return string The tag name
*/
public function getTag()
{

View File

@ -80,7 +80,7 @@ class TransChoiceTokenParser extends TransTokenParser
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
* @return string The tag name
*/
public function getTag()
{

View File

@ -72,7 +72,7 @@ class TransTokenParser extends \Twig_TokenParser
/**
* Gets the tag name associated with this token parser.
*
* @param string The tag name
* @return string The tag name
*/
public function getTag()
{

View File

@ -110,9 +110,9 @@ class DumpCommand extends Command
/**
* Checks if an asset should be dumped.
*
* @param LazyAssetManager $am The asset manager
* @param string $name The asset name
* @param array $previously An array of previous visits
* @param LazyAssetManager $am The asset manager
* @param string $name The asset name
* @param array &$previously An array of previous visits
*
* @return AssetInterface|Boolean The asset if it should be dumped
*/

View File

@ -41,7 +41,7 @@ abstract class DoctrineCommand extends Command
* Convenience method to push the helper sets of a given entity manager into the application.
*
* @param Application $application
* @param string $emName
* @param string $emName
*/
public static function setApplicationEntityManager(Application $application, $emName)
{

View File

@ -26,7 +26,8 @@ class ConnectionFactory
private $initialized = false;
/**
* @param ContainerInterface $container
* Construct.
*
* @param array $typesConfig
*/
public function __construct(array $typesConfig)
@ -37,7 +38,10 @@ class ConnectionFactory
/**
* Create a connection by name.
*
* @param string $connectionName
* @param string $connectionName
* @param Configuration $config
* @param EventManager $eventManager
*
* @return Doctrine\DBAL\Connection
*/
public function createConnection(array $params, Configuration $config = null, EventManager $eventManager = null)

View File

@ -51,7 +51,7 @@ class DoctrineExtension extends AbstractDoctrineExtension
*
* <doctrine:dbal id="myconn" dbname="sfweb" user="root" />
*
* @param array $config An array of configuration settings
* @param array $config An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
protected function dbalLoad(array $config, ContainerBuilder $container)
@ -77,9 +77,9 @@ class DoctrineExtension extends AbstractDoctrineExtension
/**
* Loads a configured DBAL connection.
*
* @param string $name The name of the connection
* @param array $connection A dbal connection configuration.
* @param ContainerBuilder $container A ContainerBuilder instance
* @param string $name The name of the connection
* @param array $connection A dbal connection configuration.
* @param ContainerBuilder $container A ContainerBuilder instance
*/
protected function loadDbalConnection($name, array $connection, ContainerBuilder $container)
{
@ -137,7 +137,7 @@ class DoctrineExtension extends AbstractDoctrineExtension
*
* <doctrine:orm id="mydm" connection="myconn" />
*
* @param array $config An array of configuration settings
* @param array $config An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
protected function ormLoad(array $config, ContainerBuilder $container)
@ -295,8 +295,8 @@ class DoctrineExtension extends AbstractDoctrineExtension
/**
* Loads a configured entity managers cache drivers.
*
* @param array $entityManager A configured ORM entity manager.
* @param ContainerBuilder $container A ContainerBuilder instance
* @param array $entityManager A configured ORM entity manager.
* @param ContainerBuilder $container A ContainerBuilder instance
*/
protected function loadOrmCacheDrivers(array $entityManager, ContainerBuilder $container)
{
@ -308,9 +308,9 @@ class DoctrineExtension extends AbstractDoctrineExtension
/**
* Loads a configured entity managers metadata, query or result cache driver.
*
* @param array $entityManager A configured ORM entity manager.
* @param array $entityManager A configured ORM entity manager.
* @param ContainerBuilder $container A ContainerBuilder instance
* @param string $cacheName
* @param string $cacheName
*/
protected function loadOrmEntityManagerCacheDriver(array $entityManager, ContainerBuilder $container, $cacheName)
{
@ -324,8 +324,8 @@ class DoctrineExtension extends AbstractDoctrineExtension
/**
* Gets an entity manager cache driver definition for metadata, query and result caches.
*
* @param array $entityManager The array configuring an entity manager.
* @param array $cacheDriver The cache driver configuration.
* @param array $entityManager The array configuring an entity manager.
* @param array $cacheDriver The cache driver configuration.
* @param ContainerBuilder $container
* @return Definition $cacheDef
*/

View File

@ -26,8 +26,7 @@ class ClassMapCacheWarmer extends CacheWarmer
/**
* Constructor.
*
* @param KernelInterface $kernel A KernelInterface instance
* @param string $rootDir The directory where global templates can be stored
* @param ContainerInterface $container The container
*/
public function __construct(ContainerInterface $container)
{

View File

@ -26,7 +26,7 @@ class RouterCacheWarmer extends CacheWarmer
/**
* Constructor.
*
* @param router $router A Router instance
* @param Router $router A Router instance
*/
public function __construct(Router $router)
{

View File

@ -32,10 +32,10 @@ class TemplatePathsCacheWarmer extends CacheWarmer
/**
* Constructor.
*
* @param KernelInterface $kernel A KernelInterface instance
* @param TemplateNameParser $parser A TemplateNameParser instance
* @param TemplateLocator $locator The template locator
* @param string $rootDir The directory where global templates can be stored
* @param KernelInterface $kernel A KernelInterface instance
* @param TemplateNameParser $parser A TemplateNameParser instance
* @param TemplateLocator $locator The template locator
* @param string $rootDir The directory where global templates can be stored
*/
public function __construct(KernelInterface $kernel, TemplateNameParser $parser, TemplateLocator $locator, $rootDir)
{

View File

@ -29,6 +29,8 @@ class Application extends BaseApplication
/**
* Constructor.
*
* @param KernelInterface $kernel A KernelInterface instance
*/
public function __construct(KernelInterface $kernel)
{

View File

@ -28,9 +28,9 @@ class Controller extends ContainerAware
/**
* Generates a URL from the given parameters.
*
* @param string $name The name of the route
* @param array $parameters An array of parameters
* @param Boolean $absolute Whether to generate an absolute URL
* @param string $name The name of the route
* @param array $parameters An array of parameters
* @param Boolean $absolute Whether to generate an absolute URL
*
* @return string The generated URL
*/

View File

@ -171,8 +171,8 @@ class FrameworkExtension extends Extension
/**
* Loads the ESI configuration.
*
* @param array $config An ESI configuration array
* @param XmlFileLoader $loader An XmlFileLoader instance
* @param array $config An ESI configuration array
* @param XmlFileLoader $loader An XmlFileLoader instance
*/
private function registerEsiConfiguration(array $config, XmlFileLoader $loader)
{
@ -312,6 +312,7 @@ class FrameworkExtension extends Extension
* Loads the templating configuration.
*
* @param array $config A templating configuration array
* @param string $ide
* @param ContainerBuilder $container A ContainerBuilder instance
* @param XmlFileLoader $loader An XmlFileLoader instance
*/

View File

@ -41,9 +41,9 @@ abstract class HttpCache extends BaseHttpCache
/**
* Forwards the Request to the backend and returns the Response.
*
* @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)
* @param Request $request A Request instance
* @param Boolean $raw Whether to catch exceptions or not
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
*
* @return Response A Response instance
*/

View File

@ -35,10 +35,10 @@ class ProfilerListener
/**
* Constructor.
*
* @param ContainerInterface $container A ContainerInterface instance
* @param RequestMatcherInterface $matcher A RequestMatcher instance
* @param Boolean $onlyException true if the profiler only collects data when an exception occurs, false otherwise
* @param Boolean $onlyMaster true if the profiler only collects data when the request is a master request, false otherwise
* @param ContainerInterface $container A ContainerInterface instance
* @param RequestMatcherInterface $matcher A RequestMatcher instance
* @param Boolean $onlyException true if the profiler only collects data when an exception occurs, false otherwise
* @param Boolean $onlyMasterRequests true if the profiler only collects data when the request is a master request, false otherwise
*/
public function __construct(ContainerInterface $container, RequestMatcherInterface $matcher = null, $onlyException = false, $onlyMasterRequests = false)
{

View File

@ -255,7 +255,7 @@ build: 56
.sf-exceptionreset ol li {
list-style: decimal;
margin-left: 20px;
padding: 2px,
padding: 2px;
padding-bottom: 20px;
}
@ -265,7 +265,7 @@ build: 56
margin-left: 0;
white-space: nowrap;
font-size: 12px;
padding-bottom: 0px;
padding-bottom: 0;
}
.sf-exceptionreset li .selected
{

View File

@ -22,7 +22,7 @@ img
.clear
{
clear:both;
height:0px;
height:0;
font-size:0;
line-height:0;
}
@ -97,7 +97,6 @@ img
{
-webkit-appearance: button-bevel;
float: none;
text-align: left;
padding: 0;
margin: 0;
overflow: visible;
@ -148,7 +147,7 @@ img
.search button span span span
{
padding: 0px 7px;
padding: 0 7px;
font: bold 11px Arial, Helvetica, sans-serif;
color: #6b6b6b;
line-height: 28px;

View File

@ -29,6 +29,7 @@ class DelegatingEngine extends BaseDelegatingEngine implements EngineInterface
* Constructor.
*
* @param ContainerInterface $container The DI container
* @param array $engineIds An array of engine Ids
*/
public function __construct(ContainerInterface $container, array $engineIds)
{

View File

@ -72,7 +72,9 @@ class FormHelper extends Helper
/**
* Renders the entire form field "row".
*
* @param FieldInterface $field
* @param FormView $view
* @param array $variables
*
* @return string
*/
public function row(FormView $view, array $variables = array())

View File

@ -36,9 +36,9 @@ class RouterHelper extends Helper
/**
* Generates a URL from the given parameters.
*
* @param string $name The name of the route
* @param array $parameters An array of parameters
* @param Boolean $absolute Whether to generate an absolute URL
* @param string $name The name of the route
* @param array $parameters An array of parameters
* @param Boolean $absolute Whether to generate an absolute URL
*
* @return string The generated URL
*/

View File

@ -28,7 +28,6 @@ class CachedTemplateLocator extends TemplateLocator
*
* @param string $cacheDir The cache path
* @param FileLocatorInterface $locator A FileLocatorInterface instance
* @param string $path A global fallback path
*/
public function __construct($cacheDir, FileLocatorInterface $locator)
{

View File

@ -56,8 +56,8 @@ class FilesystemLoader implements LoaderInterface
/**
* Returns true if the template is still fresh.
*
* @param TemplateReferenceInterface $template The template name as an array
* @param integer $time The last modification time of the cached template (timestamp)
* @param TemplateReferenceInterface $template The template name as an array
* @param integer $time The last modification time of the cached template (timestamp)
*/
public function isFresh(TemplateReferenceInterface $template, $time)
{

View File

@ -39,9 +39,9 @@ class TemplateLocator implements FileLocatorInterface
/**
* Returns a full path for a given file.
*
* @param TemplateReferenceInterface $template A template
* @param string $currentPath Unused
* @param Boolean $first Unused
* @param TemplateReferenceInterface $template A template
* @param string $currentPath Unused
* @param Boolean $first Unused
*
* @return string The full path for the file
*

View File

@ -32,6 +32,7 @@ class PhpEngine extends BasePhpEngine implements EngineInterface
* @param TemplateNameParserInterface $parser A TemplateNameParserInterface instance
* @param ContainerInterface $container The DI container
* @param LoaderInterface $loader A loader instance
* @param GlobalVariables $globals A GlobalVariables instance
*/
public function __construct(TemplateNameParserInterface $parser, ContainerInterface $container, LoaderInterface $loader, GlobalVariables $globals)
{

View File

@ -40,6 +40,7 @@ class Translator extends BaseTranslator
*
* @param ContainerInterface $container A ContainerInterface instance
* @param MessageSelector $selector The message selector for pluralization
* @param array $loaderIds An array of loader Ids
* @param array $options An array of options
* @param Session $session A Session instance
*/

View File

@ -44,7 +44,8 @@ class ConstraintValidatorFactory implements ConstraintValidatorFactoryInterface
/**
* Constructor.
*
* @param ContainerInterface $container The service container
* @param ContainerInterface $container The service container
* @param array $validators An array of validators
*/
public function __construct(ContainerInterface $container, array $validators = array())
{

View File

@ -90,8 +90,8 @@ abstract class AbstractFactory implements SecurityFactoryInterface
* AuthenticationProviderInterface.
*
* @param ContainerBuilder $container
* @param string $id The unique id of the firewall
* @param array $options The options array for this listener
* @param string $id The unique id of the firewall
* @param array $config The options array for this listener
* @param string $userProviderId The id of the user provider
*
* @return string never null, the id of the authentication provider

View File

@ -27,7 +27,7 @@ class SecurityHelper extends Helper
/**
* Constructor.
*
* @param SecurityContext $context A SecurityContext instance
* @param SecurityContextInterface $context A SecurityContext instance
*/
public function __construct(SecurityContextInterface $context = null)
{

View File

@ -36,7 +36,7 @@ class SwiftmailerExtension extends Extension
* <swiftmailer:spool path="/path/to/spool/" />
* </swiftmailer:config>
*
* @param array $config An array of configuration settings
* @param array $configs An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function load(array $configs, ContainerBuilder $container)

View File

@ -32,8 +32,8 @@ class TemplateCacheCacheWarmer extends CacheWarmer
/**
* Constructor.
*
* @param ContainerInterface $container The dependency injection container
* @param string $rootDir The directory where global templates can be stored
* @param ContainerInterface $container The dependency injection container
* @param string $rootDir The directory where global templates can be stored
*/
public function __construct(ContainerInterface $container, $rootDir)
{

View File

@ -30,7 +30,8 @@ class FilesystemLoader implements \Twig_LoaderInterface
/**
* Constructor.
*
* @param FileLocatorInterface $locator A FileLocatorInterface instance
* @param FileLocatorInterface $locator A FileLocatorInterface instance
* @param TemplateNameParserInterface $parser A TemplateNameParserInterface instance
*/
public function __construct(FileLocatorInterface $locator, TemplateNameParserInterface $parser)
{

View File

@ -26,7 +26,7 @@ class RenderNode extends \Twig_Node
/**
* Compiles the node to PHP.
*
* @param \Twig_Compiler A Twig_Compiler instance
* @param \Twig_Compiler $compiler A Twig_Compiler instance
*/
public function compile(\Twig_Compiler $compiler)
{

View File

@ -200,6 +200,7 @@ class ProfilerController extends ContainerAware
/**
* Search results.
*
* @param string $token The token
* @return Response A Response instance
*/
public function searchResultsAction($token)

View File

@ -34,7 +34,7 @@ class WebProfilerExtension extends Extension
/**
* Loads the web profiler configuration.
*
* @param array $config An array of configuration settings
* @param array $configs An array of configuration settings
* @param ContainerBuilder $container A ContainerBuilder instance
*/
public function load(array $configs, ContainerBuilder $container)

View File

@ -109,7 +109,7 @@ abbr
.clear
{
clear:both;
height:0px;
height:0;
font-size:0;
line-height:0;
}
@ -192,7 +192,7 @@ abbr
{
display: block;
position: absolute;
left: 0px;
left: 0;
top: 12px;
width: 60px;
text-align: center;
@ -394,10 +394,9 @@ td.main, td.menu {
{
-webkit-appearance: button-bevel;
float: none;
display: block;
padding: 0;
margin: 0;
border: 0px solid #000000;
border: 0 solid #000;
text-decoration: none;
cursor: pointer;
background-color: transparent;
@ -405,7 +404,6 @@ td.main, td.menu {
display: inline-block;
text-align: center;
vertical-align: middle;
border: 0;
background: none;
}
@ -439,7 +437,7 @@ td.main, td.menu {
.search button span span span
{
padding: 0px 7px;
padding: 0 7px;
font: bold 11px Arial, Helvetica, sans-serif;
color: #6b6b6b;
line-height: 28px;

View File

@ -76,7 +76,7 @@ class CookieJar
* Updates the cookie jar from a Response object.
*
* @param Response $response A Response object
* @param string $url The base URL
* @param string $uri The base URL
*/
public function updateFromResponse(Response $response, $uri = null)
{

View File

@ -53,7 +53,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
/**
* Set a custom children builder
*
* @param NodeBuilder $class A custom NodeBuilder
* @param NodeBuilder $builder A custom NodeBuilder
*/
public function setBuilder(NodeBuilder $builder)
{
@ -160,7 +160,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
* If you'd like "'id' => 'my_name'" to still be present in the resulting
* array, then you can set the second argument of this method to false.
*
* @param string $name The name of the key
* @param string $name The name of the key
* @param Boolean $removeKeyItem Whether or not the key item should be removed.
*
* @return ArrayNodeDefinition

View File

@ -27,7 +27,7 @@ class ExprBuilder
/**
* Constructor
*
* @param NodeDefinition $parent The related node
* @param NodeDefinition $node The related node
*/
public function __construct(NodeDefinition $node)
{

View File

@ -74,7 +74,7 @@ abstract class NodeDefinition implements NodeParentInterface
/**
* Creates the node.
*
* @param Boolean $forceRootNode Wether to force this node as the root node
* @param Boolean $forceRootNode Whether to force this node as the root node
*
* @return NodeInterface
*/

View File

@ -70,7 +70,7 @@ class PrototypedArrayNode extends ArrayNode
* If $remove is false, the resulting array will still have the
* "'id' => 'my_name'" item in it.
*
* @param string $attribute The name of the attribute which value is to be used as a key
* @param string $attribute The name of the attribute which value is to be used as a key
* @param Boolean $remove Whether or not to remove the key
*/
public function setKeyAttribute($attribute, $remove = true)

View File

@ -27,6 +27,8 @@ abstract class FileLoader extends Loader
/**
* Constructor.
*
* @param FileLocatorInterface $locator A FileLocatorInterface instance
*/
public function __construct(FileLocatorInterface $locator)
{

View File

@ -640,8 +640,8 @@ class Application
/**
* Returns an XML representation of the Application.
*
* @param string $namespace An optional namespace name
* @param Boolean $asDom Whether to return a DOM or an XML string
* @param string $namespace An optional namespace name
* @param Boolean $asDom Whether to return a DOM or an XML string
*
* @return string|DOMDocument An XML string representing the Application
*/

View File

@ -72,8 +72,8 @@ class OutputFormatter implements OutputFormatterInterface
/**
* Sets a new style.
*
* @param string $name The style name
* @param OutputFormatterStyleInterface $options The style instance
* @param string $name The style name
* @param OutputFormatterStyleInterface $style The style instance
*
* @api
*/

View File

@ -41,8 +41,8 @@ interface OutputFormatterInterface
/**
* Sets a new style.
*
* @param string $name The style name
* @param OutputFormatterStyleInterface $options The style instance
* @param string $name The style name
* @param OutputFormatterStyleInterface $style The style instance
*
* @api
*/

View File

@ -38,7 +38,7 @@ class HelperSet
* Sets a helper.
*
* @param HelperInterface $value The helper instance
* @param string $alias An alias
* @param string $alias An alias
*/
public function set(HelperInterface $helper, $alias = null)
{

View File

@ -111,7 +111,7 @@ class ArgvInput extends Input
/**
* Parses a short option set.
*
* @param string $token The current token
* @param string $name The current token
*
* @throws \RuntimeException When option given doesn't exist
*/

View File

@ -29,7 +29,7 @@ class ArrayInput extends Input
/**
* Constructor.
*
* @param array $param An array of parameters
* @param array $parameters An array of parameters
* @param InputDefinition $definition A InputDefinition instance
*
* @api
@ -63,7 +63,7 @@ class ArrayInput extends Input
* This method is to be used to introspect the input parameters
* before it has been validated. It must be used carefully.
*
* @param string|array $value The values to look for in the raw parameters (can be an array)
* @param string|array $values The values to look for in the raw parameters (can be an array)
*
* @return Boolean true if the value is contained in the raw parameters
*/

View File

@ -33,9 +33,10 @@ class ConsoleOutput extends StreamOutput
/**
* Constructor.
*
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
* @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
* @param OutputFormatter $formatter Output formatter instance
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,
* self::VERBOSITY_VERBOSE)
* @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
* @param OutputFormatter $formatter Output formatter instance
*
* @api
*/

View File

@ -35,9 +35,9 @@ abstract class Output implements OutputInterface
/**
* Constructor.
*
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
* @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
* @param OutputFormatterInterface $formatter Output formatter instance
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
* @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
* @param OutputFormatterInterface $formatter Output formatter instance
*
* @api
*/
@ -55,7 +55,7 @@ abstract class Output implements OutputInterface
/**
* Sets output formatter.
*
* @param OutputFormatterInterface $formatter
* @param OutputFormatterInterface $formatter
*
* @api
*/

View File

@ -90,7 +90,7 @@ interface OutputInterface
/**
* Sets output formatter.
*
* @param OutputFormatterInterface $formatter
* @param OutputFormatterInterface $formatter
*
* @api
*/

View File

@ -35,10 +35,11 @@ class StreamOutput extends Output
/**
* Constructor.
*
* @param mixed $stream A stream resource
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, self::VERBOSITY_VERBOSE)
* @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
* @param OutputFormatter $formatter Output formatter instance
* @param mixed $stream A stream resource
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,
* self::VERBOSITY_VERBOSE)
* @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
* @param OutputFormatter $formatter Output formatter instance
*
* @throws \InvalidArgumentException When first argument is not a real stream
*

View File

@ -27,7 +27,7 @@ class ApplicationTester
/**
* Constructor.
*
* @param Application $application A Application instance to test.
* @param Application $application An Application instance to test.
*/
public function __construct(Application $application)
{

View File

@ -77,9 +77,9 @@ class FunctionNode implements NodeInterface
* undocumented function
*
* @param XPathExpr $xpath
* @param mixed $expr
* @param string $last
* @param string $addNameTest
* @param mixed $expr
* @param Boolean $last
* @param Boolean $addNameTest
* @return XPathExpr
*/
protected function _xpath_nth_child($xpath, $expr, $last = false, $addNameTest = true)

View File

@ -168,7 +168,7 @@ class Parser
*
* @throws SyntaxError When expected symbol but got something else
*
* @param TokenStream The stream containing the selector.
* @param TokenStream $stream The stream containing the selector.
*
* @return Node\NodeInterface
*/

View File

@ -36,7 +36,7 @@ class AnalyzeServiceReferencesPass implements RepeatablePassInterface
/**
* Constructor.
*
* @param boolean $ignoreMethodCalls Sets this Service Reference pass to ignore method calls
* @param boolean $onlyConstructorArguments Sets this Service Reference pass to ignore method calls
*/
public function __construct($onlyConstructorArguments = false)
{

View File

@ -103,7 +103,7 @@ class CheckReferenceValidityPass implements CompilerPassInterface
/**
* Validates the scope of a single Reference.
*
* @param Reference $reference
* @param Reference $reference
* @param Definition $definition
* @throws \RuntimeException when there is an issue with the Reference scope
*/

View File

@ -71,7 +71,7 @@ class Compiler
* Adds a pass to the PassConfig.
*
* @param CompilerPassInterface $pass A compiler pass
* @param string $type The type of the pass
* @param string $type The type of the pass
*/
public function addPass(CompilerPassInterface $pass, $type = PassConfig::TYPE_BEFORE_OPTIMIZATION)
{

View File

@ -69,7 +69,7 @@ class InlineServiceDefinitionsPass implements RepeatablePassInterface
* Processes inline arguments.
*
* @param ContainerBuilder $container The ContainerBuilder
* @param array $arguments An array of arguments
* @param array $arguments An array of arguments
*/
private function inlineArguments(ContainerBuilder $container, array $arguments)
{
@ -104,8 +104,8 @@ class InlineServiceDefinitionsPass implements RepeatablePassInterface
* Checks if the definition is inlineable.
*
* @param ContainerBuilder $container
* @param string $id
* @param Definition $definition
* @param string $id
* @param Definition $definition
* @return boolean If the definition is inlineable
*/
private function isInlinableDefinition(ContainerBuilder $container, $id, Definition $definition)

View File

@ -44,7 +44,7 @@ class ResolveDefinitionTemplatesPass implements CompilerPassInterface
/**
* Resolves the definition
*
* @param string $id The definition identifier
* @param string $id The definition identifier
* @param DefinitionDecorator $definition
* @return Definition
*/

View File

@ -147,8 +147,8 @@ class Container implements ContainerInterface
/**
* Sets a parameter.
*
* @param string $name The parameter name
* @param mixed $parameters The parameter value
* @param string $name The parameter name
* @param mixed $value The parameter value
*/
public function setParameter($name, $value)
{
@ -201,8 +201,8 @@ class Container implements ContainerInterface
* If a service is both defined through a set() method and
* with a set*Service() method, the former has always precedence.
*
* @param string $id The service identifier
* @param int $invalidBehavior The behavior when the service does not exist
* @param string $id The service identifier
* @param integer $invalidBehavior The behavior when the service does not exist
*
* @return object The associated service
*

View File

@ -266,8 +266,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/**
* Gets a service.
*
* @param string $id The service identifier
* @param int $invalidBehavior The behavior when the service does not exist
* @param string $id The service identifier
* @param integer $invalidBehavior The behavior when the service does not exist
*
* @return object The associated service
*
@ -427,7 +427,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/**
* Sets the service aliases.
*
* @param array $definitions An array of service definitions
* @param array $aliases An array of service definitions
*/
public function setAliases(array $aliases)
{

View File

@ -80,8 +80,8 @@ interface ContainerInterface
/**
* Sets a parameter.
*
* @param string $name The parameter name
* @param mixed $parameters The parameter value
* @param string $name The parameter name
* @param mixed $value The parameter value
*/
function setParameter($name, $value);

View File

@ -411,7 +411,7 @@ class Definition
/**
* Sets the scope of the service
*
* @param string $string Whether the service must be shared or not
* @param string $scope Whether the service must be shared or not
*
* @return Definition The current instance
*/

View File

@ -834,8 +834,8 @@ EOF;
/**
* Builds service calls from arguments
*
* @param array $arguments
* @param string $calls By reference
* @param array $arguments
* @param string $calls By reference
* @param string $behavior By reference
* @return void
*/
@ -1034,7 +1034,7 @@ EOF;
/**
* Gets a service call
*
* @param string $id
* @param string $id
* @param Reference $reference
* @return string
*/

View File

@ -196,7 +196,7 @@ class YamlDumper extends Dumper
/**
* Gets the service call.
*
* @param string $id
* @param string $id
* @param Reference $reference
* @return string
*/

View File

@ -23,7 +23,7 @@ interface ExtensionInterface
/**
* Loads a specific configuration.
*
* @param array $config An array of configuration values
* @param array $config An array of configuration values
* @param ContainerBuilder $container A ContainerBuilder instance
*
* @throws \InvalidArgumentException When provided tag is not defined in this extension

View File

@ -38,8 +38,8 @@ class ClosureLoader extends Loader
/**
* Loads a Closure.
*
* @param \Closure $resource The resource
* @param string $type The resource type
* @param \Closure $closure The resource
* @param string $type The resource type
*/
public function load($closure, $type = null)
{

View File

@ -28,7 +28,7 @@ abstract class FileLoader extends BaseFileLoader
* Constructor.
*
* @param ContainerBuilder $container A ContainerBuilder instance
* @param FileLocator $locator A FileLocator instance
* @param FileLocator $locator A FileLocator instance
*/
public function __construct(ContainerBuilder $container, FileLocator $locator)
{

View File

@ -26,7 +26,7 @@ class PhpFileLoader extends FileLoader
/**
* Loads a PHP file.
*
* @param mixed $resource The resource
* @param mixed $file The resource
* @param string $type The resource type
*/
public function load($file, $type = null)

View File

@ -32,8 +32,8 @@ class YamlFileLoader extends FileLoader
/**
* Loads a Yaml file.
*
* @param mixed $resource The resource
* @param string $type The resource type
* @param mixed $file The resource
* @param string $type The resource type
*/
public function load($file, $type = null)
{

View File

@ -83,8 +83,8 @@ class ParameterBag implements ParameterBagInterface
/**
* Sets a service container parameter.
*
* @param string $name The parameter name
* @param mixed $parameters The parameter value
* @param string $name The parameter name
* @param mixed $value The parameter value
*/
public function set($name, $value)
{

View File

@ -51,8 +51,8 @@ interface ParameterBagInterface
/**
* Sets a service container parameter.
*
* @param string $name The parameter name
* @param mixed $parameters The parameter value
* @param string $name The parameter name
* @param mixed $value The parameter value
*/
function set($name, $value);

View File

@ -32,7 +32,9 @@ class SimpleXMLElement extends \SimpleXMLElement
/**
* Returns arguments as valid php types.
*
* @param string $name
* @param string $name
* @param Boolean $lowercase
*
* @return mixed
*/
public function getArgumentsAsPhp($name, $lowercase = true)

View File

@ -591,8 +591,8 @@ class Crawler extends \SplObjectStorage
/**
* Returns a Form object for the first node in the list.
*
* @param array $arguments An array of values for the form fields
* @param string $method The method for the form
* @param array $values An array of values for the form fields
* @param string $method The method for the form
*
* @return Form A Form instance
*

View File

@ -262,7 +262,7 @@ class Form extends Link implements \ArrayAccess
/**
* Sets a named field.
*
* @param string $name The field name
* @param Field\FormField $field The field
*
* @return FormField The field instance
*

View File

@ -38,7 +38,9 @@ class Glob
/**
* Returns a regexp which is the equivalent of the glob pattern.
*
* @param string $glob The glob pattern
* @param string $glob The glob pattern
* @param Boolean $strictLeadingDot
* @param Boolean $strictWildcardSlash
*
* @return string regex The regexp
*/

View File

@ -24,9 +24,9 @@ class SplFileInfo extends \SplFileInfo
/**
* Constructor
*
* @param string $fileInfo The file name
* @param string $relativePath The relative path
* @param string $relativePathname The relative path name
* @param string $file The file name
* @param string $relativePath The relative path
* @param string $relativePathname The relative path name
*/
public function __construct($file, $relativePath, $relativePathname)
{

View File

@ -25,10 +25,10 @@ class PaddedChoiceList extends ArrayChoiceList
* If the values are shorter than $padLength characters, they are padded with
* zeros on the left side.
*
* @param array $values The available choices
* @param integer $padLength The length to pad the choices
* @return array An array with the input values as keys and the
* padded values as values
* @param array $values The available choices
* @param integer $padLength The length to pad the choices
* @param string $padString The padding character
* @param integer $padType The direction of padding
*/
public function __construct($values, $padLength, $padString, $padType = STR_PAD_LEFT)
{

View File

@ -33,7 +33,7 @@ class ArrayToBooleanChoicesTransformer implements DataTransformerInterface
* depending on whether a given option is selected. If this field is rendered
* as select tag, the value is not modified.
*
* @param mixed $value An array if "multiple" is set to true, a scalar
* @param mixed $array An array if "multiple" is set to true, a scalar
* value otherwise.
* @return mixed An array if "expanded" or "multiple" is set to true,
* a scalar value otherwise.

View File

@ -34,8 +34,8 @@ class SessionCsrfProvider extends DefaultCsrfProvider
* A recommended value for the secret is a generated value with at least
* 32 characters and mixed letters, digits and special characters.
*
* @param Session $session The user session
* @param string $secret A secret value included in the CSRF token
* @param Session $session The user session
* @param string $secret A secret value included in the CSRF token
*/
public function __construct(Session $session, $secret)
{

View File

@ -29,7 +29,9 @@ class DelegatingValidator implements FormValidatorInterface
}
/**
* Validates the form and its domain object
* Validates the form and its domain object.
*
* @param FormInterface $form A FormInterface instance
*/
public function validate(FormInterface $form)
{
@ -184,8 +186,8 @@ class DelegatingValidator implements FormValidatorInterface
*
* This method is called automatically during the validation process.
*
* @param FormInterface $form The validated form
* @param ExecutionContext $context The current validation context
* @param FormInterface $form The validated form
* @param ExecutionContext $context The current validation context
*/
public static function validateFormData(FormInterface $form, ExecutionContext $context)
{

View File

@ -387,7 +387,7 @@ class Form implements \IteratorAggregate, FormInterface
/**
* Binds POST data to the field, transforms and validates it.
*
* @param string|array $data The POST data
* @param string|array $clientData The POST data
*/
public function bind($clientData)
{
@ -503,8 +503,6 @@ class Form implements \IteratorAggregate, FormInterface
* constructor.
*
* @param Request $request The request to bind to the form
* @param array|object $data The data from which to read default values
* and where to write bound values
*/
public function bindRequest(Request $request)
{

View File

@ -191,7 +191,7 @@ class FormBuilder
/**
* Prepends a transformer to the client transformer chain
*
* @param DataTransformerInterface $clientTransformer
* @param DataTransformerInterface $normTransformer
*/
public function prependNormTransformer(DataTransformerInterface $normTransformer = null)
{
@ -336,7 +336,9 @@ class FormBuilder
* $form->add($locationGroup);
* </code>
*
* @param FormInterface|string $form
* @param string $name
* @param string|FormTypeInterface $type
* @param array $options
* @return FormInterface
*/
public function add($name, $type = null, array $options = array())

View File

@ -30,7 +30,7 @@ class ReversedTransformer implements DataTransformerInterface
/**
* Reverses this transformer
*
* @param DataTransformerInterface $innerTransformer
* @param DataTransformerInterface $reversedTransformer
*/
public function __construct(DataTransformerInterface $reversedTransformer)
{

View File

@ -51,7 +51,7 @@ class PropertyPath implements \IteratorAggregate
/**
* Parses the given property path
*
* @param string $this
* @param string $propertyPath
*/
public function __construct($propertyPath)
{
@ -125,6 +125,8 @@ class PropertyPath implements \IteratorAggregate
/**
* Returns the element at the given index in the property path
*
* @param $index The index key
*
* @return string A property or index name
*/
public function getElement($index)
@ -208,7 +210,7 @@ class PropertyPath implements \IteratorAggregate
* If neither is found, an exception is thrown.
*
* @param object|array $objectOrArray The object or array to traverse
* @return mixed The value at the end of the
* @param mixed $value The value at the end of the
* property path
* @throws InvalidPropertyException If the property/setter does not
* exist
@ -346,7 +348,7 @@ class PropertyPath implements \IteratorAggregate
/**
* Sets the value of the property at the given index in the path
*
* @param object $object The object or array to traverse
* @param object $objectOrArray The object or array to traverse
* @param integer $currentIndex The index of the modified property in the
* path
* @param mixed $value The value to set

View File

@ -26,7 +26,7 @@ class FileBag extends ParameterBag
/**
* Constructor.
*
* @param array $headers An array of HTTP files
* @param array $parameters An array of HTTP files
*/
public function __construct(array $parameters = array())
{

View File

@ -66,7 +66,7 @@ class RequestMatcher implements RequestMatcherInterface
/**
* Adds a check for the HTTP method.
*
* @param string|array An HTTP method or an array of HTTP methods
* @param string|array $method An HTTP method or an array of HTTP methods
*/
public function matchMethod($method)
{

View File

@ -29,7 +29,7 @@ class Session implements \Serializable
/**
* Constructor.
*
* @param SessionStorageInterface $session A SessionStorageInterface instance
* @param SessionStorageInterface $storage A SessionStorageInterface instance
* @param string $defaultLocale The default locale
*/
public function __construct(SessionStorageInterface $storage, $defaultLocale = 'en')

View File

@ -100,7 +100,8 @@ class NativeSessionStorage implements SessionStorageInterface
*
* The preferred format for a key is directory style so naming conflicts can be avoided.
*
* @param string $key A unique key identifying your data
* @param string $key A unique key identifying your data
* @param string $default Default value
*
* @return mixed Data associated with the key
*/

View File

@ -25,7 +25,7 @@ class PdoSessionStorage extends NativeSessionStorage
/**
* Constructor.
*
* @param \PDO $pdo A PDO instance
* @param \PDO $db A PDO instance
* @param array $options An associative array of session options
* @param array $dbOptions An associative array of DB options
*

View File

@ -91,7 +91,7 @@ EOF;
/**
* Converts the BrowserKit request to a HttpKernel request.
*
* @param Request $request A Request instance
* @param DomRequest $request A Request instance
*
* @return Request A Request instance
*/

View File

@ -29,7 +29,7 @@ class FileLocator extends BaseFileLocator
*
* @param KernelInterface $kernel A KernelInterface instance
* @param string $path The path the global resource directory
* @param string|array $paths A path or an array of paths where to look for resources
* @param string|array $paths A path or an array of paths where to look for resources
*/
public function __construct(KernelInterface $kernel, $path = null, array $paths = array())
{

View File

@ -38,7 +38,7 @@ class EsiListener
/**
* Filters the Response.
*
* @param FilterResponseEvent $event A FilterResponseEvent instance
* @param FilterResponseEvent $event A FilterResponseEvent instance
*/
public function onCoreResponse(FilterResponseEvent $event)
{

View File

@ -68,10 +68,10 @@ class HttpCache implements HttpKernelInterface
* This setting is overridden by the stale-if-error HTTP Cache-Control extension
* (see RFC 5861).
*
* @param HttpKernelInterface $kernel An HttpKernelInterface instance
* @param StoreInterface $store A Store instance
* @param Esi $esi An Esi instance
* @param array $options An array of options
* @param HttpKernelInterface $kernel An HttpKernelInterface instance
* @param StoreInterface $store A Store instance
* @param Esi $esi An Esi instance
* @param array $options An array of options
*/
public function __construct(HttpKernelInterface $kernel, StoreInterface $store, Esi $esi = null, array $options = array())
{
@ -201,7 +201,7 @@ class HttpCache implements HttpKernelInterface
* Forwards the Request to the backend without storing the Response in the cache.
*
* @param Request $request A Request instance
* @param Boolean $catch whether to process exceptions
* @param Boolean $catch Whether to process exceptions
*
* @return Response A Response instance
*/
@ -216,7 +216,7 @@ class HttpCache implements HttpKernelInterface
* Invalidates non-safe methods (like POST, PUT, and DELETE).
*
* @param Request $request A Request instance
* @param Boolean $catch whether to process exceptions
* @param Boolean $catch Whether to process exceptions
*
* @return Response A Response instance
*
@ -364,8 +364,8 @@ class HttpCache implements HttpKernelInterface
*
* This methods is triggered when the cache missed or a reload is required.
*
* @param Request $request A Request instance
* @param Boolean $catch whether to process exceptions
* @param Request $request A Request instance
* @param Boolean $catch whether to process exceptions
*
* @return Response A Response instance
*/
@ -398,9 +398,9 @@ class HttpCache implements HttpKernelInterface
/**
* Forwards the Request to the backend and returns the Response.
*
* @param Request $request A Request instance
* @param Boolean $catch Whether to catch exceptions or not
* @param Response $response A Response instance (the stale entry if present, null otherwise)
* @param Request $request A Request instance
* @param Boolean $catch Whether to catch exceptions or not
* @param Response $entry A Response instance (the stale entry if present, null otherwise)
*
* @return Response A Response instance
*/
@ -537,6 +537,7 @@ class HttpCache implements HttpKernelInterface
/**
* Restores the Response body.
*
* @param Request $request A Request instance
* @param Response $response A Response instance
*
* @return Response A Response instance
@ -610,7 +611,8 @@ class HttpCache implements HttpKernelInterface
/**
* Records that an event took place.
*
* @param string $event The event name
* @param Request $request A Request instance
* @param string $event The event name
*/
private function record(Request $request, $event)
{

View File

@ -35,8 +35,8 @@ class HttpKernel implements HttpKernelInterface
/**
* Constructor
*
* @param EventDispatcherInterface $dispatcher An EventDispatcherInterface instance
* @param ControllerResolverInterface $resolver A ControllerResolverInterface instance
* @param EventDispatcherInterface $dispatcher An EventDispatcherInterface instance
* @param ControllerResolverInterface $resolver A ControllerResolverInterface instance
*/
public function __construct(EventDispatcherInterface $dispatcher, ControllerResolverInterface $resolver)
{
@ -78,7 +78,7 @@ class HttpKernel implements HttpKernelInterface
* Exceptions are not caught.
*
* @param Request $request A Request instance
* @param integer $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
* @param integer $type The type of the request (one of HttpKernelInterface::MASTER_REQUEST or HttpKernelInterface::SUB_REQUEST)
*
* @return Response A Response instance
*

Some files were not shown because too many files have changed in this diff Show More