fixed phpdoc @param alignment

This commit is contained in:
Fabien Potencier 2012-05-15 18:56:32 +02:00
parent 926ac98c9a
commit ce9791246b
199 changed files with 739 additions and 739 deletions

View File

@ -251,7 +251,7 @@ class EntityChoiceList extends ArrayChoiceList
* If they have single identifiers, they are either fetched from the * If they have single identifiers, they are either fetched from the
* internal entity cache (if filled) or loaded from the database. * internal entity cache (if filled) or loaded from the database.
* *
* @param string $key The choice key (for entities with composite * @param string $key The choice key (for entities with composite
* identifiers) or entity ID (for entities with single * identifiers) or entity ID (for entities with single
* identifiers) * identifiers)
* *
@ -288,7 +288,7 @@ class EntityChoiceList extends ArrayChoiceList
/** /**
* Returns the \ReflectionProperty instance for a property of the underlying class. * Returns the \ReflectionProperty instance for a property of the underlying class.
* *
* @param string $property The name of the property * @param string $property The name of the property
* *
* @return \ReflectionProperty The reflection instance * @return \ReflectionProperty The reflection instance
*/ */
@ -309,7 +309,7 @@ class EntityChoiceList extends ArrayChoiceList
* be persisted or added to the identity map before. Otherwise an * be persisted or added to the identity map before. Otherwise an
* exception is thrown. * exception is thrown.
* *
* @param object $entity The entity for which to get the identifier * @param object $entity The entity for which to get the identifier
* *
* @return array The identifier values * @return array The identifier values
* *

View File

@ -30,7 +30,7 @@ class EntitiesToArrayTransformer implements DataTransformerInterface
/** /**
* Transforms entities into choice keys. * Transforms entities into choice keys.
* *
* @param Collection|object $collection A collection of entities, a single entity 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 * @return mixed An array of choice keys, a single key or NULL
*/ */
@ -68,7 +68,7 @@ class EntitiesToArrayTransformer implements DataTransformerInterface
/** /**
* Transforms choice keys into entities. * Transforms choice keys into entities.
* *
* @param mixed $keys An array of keys, a single key or NULL * @param mixed $keys An array of keys, a single key or NULL
* *
* @return Collection|object A collection of entities, a single entity or NULL * @return Collection|object A collection of entities, a single entity or NULL
*/ */

View File

@ -60,7 +60,7 @@ class EntityToIdTransformer implements DataTransformerInterface
/** /**
* Transforms choice keys into entities. * Transforms choice keys into entities.
* *
* @param mixed $key An array of keys, a single key or NULL * @param mixed $key An array of keys, a single key or NULL
* *
* @return Collection|object A collection of entities, a single entity or NULL * @return Collection|object A collection of entities, a single entity or NULL
*/ */

View File

@ -103,7 +103,7 @@ class FormExtension extends \Twig_Extension
* *
* <form action="..." method="post" {{ form_enctype(form) }}> * <form action="..." method="post" {{ form_enctype(form) }}>
* *
* @param FormView $view The view for which to render the encoding type * @param FormView $view The view for which to render the encoding type
* *
* @return string The html markup * @return string The html markup
*/ */
@ -151,8 +151,8 @@ class FormExtension extends \Twig_Extension
* *
* {{ form_widget(view, {'separator': '+++++'}) }} * {{ form_widget(view, {'separator': '+++++'}) }}
* *
* @param FormView $view The view to render * @param FormView $view The view to render
* @param array $variables Additional variables passed to the template * @param array $variables Additional variables passed to the template
* *
* @return string The html markup * @return string The html markup
*/ */
@ -176,8 +176,8 @@ class FormExtension extends \Twig_Extension
/** /**
* Renders the label of the given view * 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 * @param string $label Label name
* @param array $variables Additional variables passed to the template * @param array $variables Additional variables passed to the template
* *
* @return string The html markup * @return string The html markup
@ -200,9 +200,9 @@ class FormExtension extends \Twig_Extension
* 3. the type name is recursively replaced by the parent type name until a * 3. the type name is recursively replaced by the parent type name until a
* corresponding block is found * corresponding block is found
* *
* @param FormView $view The form view * @param FormView $view The form view
* @param string $section The section to render (i.e. 'row', 'widget', 'label', ...) * @param string $section The section to render (i.e. 'row', 'widget', 'label', ...)
* @param array $variables Additional variables * @param array $variables Additional variables
* *
* @return string The html markup * @return string The html markup
* *

View File

@ -23,7 +23,7 @@ class FormThemeTokenParser extends \Twig_TokenParser
/** /**
* Parses a token and returns a node. * Parses a token and returns a node.
* *
* @param \Twig_Token $token A Twig_Token instance * @param \Twig_Token $token A Twig_Token instance
* *
* @return \Twig_NodeInterface A Twig_NodeInterface instance * @return \Twig_NodeInterface A Twig_NodeInterface instance
*/ */

View File

@ -23,7 +23,7 @@ class TransChoiceTokenParser extends TransTokenParser
/** /**
* Parses a token and returns a node. * Parses a token and returns a node.
* *
* @param \Twig_Token $token A Twig_Token instance * @param \Twig_Token $token A Twig_Token instance
* *
* @return \Twig_NodeInterface A Twig_NodeInterface instance * @return \Twig_NodeInterface A Twig_NodeInterface instance
*/ */

View File

@ -23,7 +23,7 @@ class TransTokenParser extends \Twig_TokenParser
/** /**
* Parses a token and returns a node. * Parses a token and returns a node.
* *
* @param \Twig_Token $token A Twig_Token instance * @param \Twig_Token $token A Twig_Token instance
* *
* @return \Twig_NodeInterface A Twig_NodeInterface instance * @return \Twig_NodeInterface A Twig_NodeInterface instance
*/ */

View File

@ -135,7 +135,7 @@ abstract class AbstractDoctrineExtension extends Extension
* *
* @param array $bundleConfig * @param array $bundleConfig
* @param \ReflectionClass $bundle * @param \ReflectionClass $bundle
* @param ContainerBuilder $container A ContainerBuilder instance * @param ContainerBuilder $container A ContainerBuilder instance
* *
* @return array|false * @return array|false
*/ */
@ -173,7 +173,7 @@ abstract class AbstractDoctrineExtension extends Extension
* Register all the collected mapping information with the object manager by registering the appropriate mapping drivers. * Register all the collected mapping information with the object manager by registering the appropriate mapping drivers.
* *
* @param array $objectManager * @param array $objectManager
* @param ContainerBuilder $container A ContainerBuilder instance * @param ContainerBuilder $container A ContainerBuilder instance
*/ */
protected function registerMappingDrivers($objectManager, ContainerBuilder $container) protected function registerMappingDrivers($objectManager, ContainerBuilder $container)
{ {

View File

@ -197,8 +197,8 @@ class DoctrineExtension extends AbstractDoctrineExtension
/** /**
* Loads a configured ORM entity manager. * Loads a configured ORM entity manager.
* *
* @param array $entityManager A configured ORM entity manager. * @param array $entityManager A configured ORM entity manager.
* @param ContainerBuilder $container A ContainerBuilder instance * @param ContainerBuilder $container A ContainerBuilder instance
*/ */
protected function loadOrmEntityManager(array $entityManager, ContainerBuilder $container) protected function loadOrmEntityManager(array $entityManager, ContainerBuilder $container)
{ {
@ -341,7 +341,7 @@ class DoctrineExtension extends AbstractDoctrineExtension
* Loads a configured entity managers metadata, query or result cache driver. * 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 ContainerBuilder $container A ContainerBuilder instance
* @param string $cacheName * @param string $cacheName
*/ */
protected function loadOrmEntityManagerCacheDriver(array $entityManager, ContainerBuilder $container, $cacheName) protected function loadOrmEntityManagerCacheDriver(array $entityManager, ContainerBuilder $container, $cacheName)
@ -356,8 +356,8 @@ class DoctrineExtension extends AbstractDoctrineExtension
/** /**
* Gets an entity manager cache driver definition for metadata, query and result caches. * Gets an entity manager cache driver definition for metadata, query and result caches.
* *
* @param array $entityManager The array configuring an entity manager. * @param array $entityManager The array configuring an entity manager.
* @param array $cacheDriver The cache driver configuration. * @param array $cacheDriver The cache driver configuration.
* @param ContainerBuilder $container * @param ContainerBuilder $container
* @return Definition $cacheDef * @return Definition $cacheDef
*/ */

View File

@ -31,9 +31,9 @@ class TemplateFinder implements TemplateFinderInterface
/** /**
* Constructor. * Constructor.
* *
* @param KernelInterface $kernel A KernelInterface instance * @param KernelInterface $kernel A KernelInterface instance
* @param TemplateNameParser $parser A TemplateNameParser instance * @param TemplateNameParser $parser A TemplateNameParser instance
* @param string $rootDir The directory where global templates can be stored * @param string $rootDir The directory where global templates can be stored
*/ */
public function __construct(KernelInterface $kernel, TemplateNameParser $parser, $rootDir) public function __construct(KernelInterface $kernel, TemplateNameParser $parser, $rootDir)
{ {

View File

@ -27,8 +27,8 @@ class TemplatePathsCacheWarmer extends CacheWarmer
/** /**
* Constructor. * Constructor.
* *
* @param TemplateFinderInterface $finder A template finder * @param TemplateFinderInterface $finder A template finder
* @param TemplateLocator $locator The template locator * @param TemplateLocator $locator The template locator
*/ */
public function __construct(TemplateFinderInterface $finder, TemplateLocator $locator) public function __construct(TemplateFinderInterface $finder, TemplateLocator $locator)
{ {

View File

@ -55,10 +55,10 @@ class ContainerAwareEventDispatcher extends EventDispatcher
/** /**
* Adds a service as event listener * Adds a service as event listener
* *
* @param string $eventName Event for which the listener is added * @param string $eventName Event for which the listener is added
* @param array $callback The service ID of the listener service & the method * @param array $callback The service ID of the listener service & the method
* name that has to be called * name that has to be called
* @param integer $priority The higher this value, the earlier an event listener * @param integer $priority The higher this value, the earlier an event listener
* will be triggered in the chain. * will be triggered in the chain.
* Defaults to 0. * Defaults to 0.
*/ */

View File

@ -305,7 +305,7 @@ class FrameworkExtension extends Extension
/** /**
* Loads the templating configuration. * Loads the templating configuration.
* *
* @param array $config A templating configuration array * @param array $config A templating configuration array
* @param string $ide * @param string $ide
* @param ContainerBuilder $container A ContainerBuilder instance * @param ContainerBuilder $container A ContainerBuilder instance
* @param XmlFileLoader $loader An XmlFileLoader instance * @param XmlFileLoader $loader An XmlFileLoader instance

View File

@ -59,9 +59,9 @@ class HttpKernel extends BaseHttpKernel
/** /**
* Forwards the request to another controller. * Forwards the request to another controller.
* *
* @param string $controller The controller name (a string like BlogBundle:Post:index) * @param string $controller The controller name (a string like BlogBundle:Post:index)
* @param array $attributes An array of request attributes * @param array $attributes An array of request attributes
* @param array $query An array of request query parameters * @param array $query An array of request query parameters
* *
* @return Response A Response instance * @return Response A Response instance
*/ */

View File

@ -21,9 +21,9 @@ class RedirectableUrlMatcher extends BaseMatcher
/** /**
* Redirects the user to another URL. * Redirects the user to another URL.
* *
* @param string $path The path info to redirect to. * @param string $path The path info to redirect to.
* @param string $route The route that matched * @param string $route The route that matched
* @param string $scheme The URL scheme (null to keep the current one) * @param string $scheme The URL scheme (null to keep the current one)
* *
* @return array An array of parameters * @return array An array of parameters
*/ */

View File

@ -135,8 +135,8 @@ class CodeHelper extends Helper
/** /**
* Returns an excerpt of a code file around the given line number. * Returns an excerpt of a code file around the given line number.
* *
* @param string $file A file path * @param string $file A file path
* @param int $line The selected line number * @param int $line The selected line number
* *
* @return string An HTML string * @return string An HTML string
*/ */
@ -160,9 +160,9 @@ class CodeHelper extends Helper
/** /**
* Formats a file path. * Formats a file path.
* *
* @param string $file An absolute file path * @param string $file An absolute file path
* @param integer $line The line number * @param integer $line The line number
* @param string $text Use this text for the link rather than the file path * @param string $text Use this text for the link rather than the file path
* *
* @return string * @return string
*/ */
@ -189,8 +189,8 @@ class CodeHelper extends Helper
/** /**
* Returns the link for a given file/line pair. * Returns the link for a given file/line pair.
* *
* @param string $file An absolute file path * @param string $file An absolute file path
* @param integer $line The line number * @param integer $line The line number
* *
* @return string A link of false * @return string A link of false
*/ */

View File

@ -84,7 +84,7 @@ class FormHelper extends Helper
* *
* <form action="..." method="post" <?php echo $view['form']->enctype() ?>> * <form action="..." method="post" <?php echo $view['form']->enctype() ?>>
* *
* @param FormView $view The view for which to render the encoding type * @param FormView $view The view for which to render the encoding type
* *
* @return string The html markup * @return string The html markup
*/ */
@ -181,9 +181,9 @@ class FormHelper extends Helper
* 3. the type name is recursively replaced by the parent type name until a * 3. the type name is recursively replaced by the parent type name until a
* corresponding block is found * corresponding block is found
* *
* @param FormView $view The form view * @param FormView $view The form view
* @param string $section The section to render (i.e. 'row', 'widget', 'label', ...) * @param string $section The section to render (i.e. 'row', 'widget', 'label', ...)
* @param array $variables Additional variables * @param array $variables Additional variables
* *
* @return string The html markup * @return string The html markup
* *
@ -252,7 +252,7 @@ class FormHelper extends Helper
* Render a block from a form element. * Render a block from a form element.
* *
* @param string $name * @param string $name
* @param array $variables Additional variables (those would override the current context) * @param array $variables Additional variables (those would override the current context)
* *
* @throws FormException if the block is not found * @throws FormException if the block is not found
* @throws FormException if the method is called out of a form element (no context) * @throws FormException if the method is called out of a form element (no context)

View File

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

View File

@ -28,8 +28,8 @@ abstract class WebTestCase extends \PHPUnit_Framework_TestCase
/** /**
* Creates a Client. * Creates a Client.
* *
* @param array $options An array of options to pass to the createKernel class * @param array $options An array of options to pass to the createKernel class
* @param array $server An array of server parameters * @param array $server An array of server parameters
* *
* @return Client A Client instance * @return Client A Client instance
*/ */

View File

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

View File

@ -57,7 +57,7 @@ class ProfilerController extends ContainerAware
/** /**
* Exports data for a given token. * Exports data for a given token.
* *
* @param string $token The profiler token * @param string $token The profiler token
* *
* @return Response A Response instance * @return Response A Response instance
*/ */

View File

@ -45,14 +45,14 @@ class Cookie
/** /**
* Sets a cookie. * Sets a cookie.
* *
* @param string $name The cookie name * @param string $name The cookie name
* @param string $value The value of the cookie * @param string $value The value of the cookie
* @param string $expires The time the cookie expires * @param string $expires The time the cookie expires
* @param string $path The path on the server in which the cookie will be available on * @param string $path The path on the server in which the cookie will be available on
* @param string $domain The domain that the cookie is available * @param string $domain The domain that the cookie is available
* @param Boolean $secure Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client * @param Boolean $secure Indicates that the cookie should only be transmitted over a secure HTTPS connection from the client
* @param Boolean $httponly The cookie httponly flag * @param Boolean $httponly The cookie httponly flag
* @param Boolean $encodedValue Whether the value is encoded or not * @param Boolean $encodedValue Whether the value is encoded or not
* *
* @api * @api
*/ */

View File

@ -76,7 +76,7 @@ class CookieJar
* Updates the cookie jar from a Response object. * Updates the cookie jar from a Response object.
* *
* @param Response $response A Response object * @param Response $response A Response object
* @param string $uri The base URL * @param string $uri The base URL
*/ */
public function updateFromResponse(Response $response, $uri = null) public function updateFromResponse(Response $response, $uri = null)
{ {
@ -100,7 +100,7 @@ class CookieJar
/** /**
* Returns not yet expired cookie values for the given URI. * Returns not yet expired cookie values for the given URI.
* *
* @param string $uri A URI * @param string $uri A URI
* @param Boolean $returnsRawValue Returns raw value or urldecoded value * @param Boolean $returnsRawValue Returns raw value or urldecoded value
* *
* @return array An array of cookie values * @return array An array of cookie values

View File

@ -27,8 +27,8 @@ class ConfigCache
/** /**
* Constructor. * Constructor.
* *
* @param string $file The absolute cache path * @param string $file The absolute cache path
* @param Boolean $debug Whether debugging is enabled or not * @param Boolean $debug Whether debugging is enabled or not
*/ */
public function __construct($file, $debug) public function __construct($file, $debug)
{ {

View File

@ -34,7 +34,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
/** /**
* Constructor. * Constructor.
* *
* @param string $name The Node's name * @param string $name The Node's name
* @param NodeInterface $parent The node parent * @param NodeInterface $parent The node parent
*/ */
public function __construct($name, NodeInterface $parent = null) public function __construct($name, NodeInterface $parent = null)
@ -301,7 +301,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
/** /**
* Merges values together. * Merges values together.
* *
* @param mixed $leftSide The left side to merge. * @param mixed $leftSide The left side to merge.
* @param mixed $rightSide The right side to merge. * @param mixed $rightSide The right side to merge.
* *
* @return mixed The merged values * @return mixed The merged values

View File

@ -33,7 +33,7 @@ abstract class BaseNode implements NodeInterface
/** /**
* Constructor. * Constructor.
* *
* @param string $name The name of the node * @param string $name The name of the node
* @param NodeInterface $parent The parent of this node * @param NodeInterface $parent The parent of this node
* *
* @throws \InvalidArgumentException if the name contains a period. * @throws \InvalidArgumentException if the name contains a period.

View File

@ -142,7 +142,7 @@ class NodeBuilder implements NodeParentInterface
/** /**
* Add or override a node Type * Add or override a node Type
* *
* @param string $type The name of the type * @param string $type The name of the type
* @param string $class The fully qualified name the node definition class * @param string $class The fully qualified name the node definition class
*/ */
public function setNodeClass($type, $class) public function setNodeClass($type, $class)

View File

@ -36,8 +36,8 @@ abstract class NodeDefinition implements NodeParentInterface
/** /**
* Constructor * Constructor
* *
* @param string $name The name of the node * @param string $name The name of the node
* @param NodeParentInterface $parent The parent * @param NodeParentInterface $parent The parent
*/ */
public function __construct($name, NodeParentInterface $parent = null) public function __construct($name, NodeParentInterface $parent = null)
{ {

View File

@ -25,9 +25,9 @@ class TreeBuilder implements NodeParentInterface
/** /**
* Creates the root node. * Creates the root node.
* *
* @param string $name The name of the root node * @param string $name The name of the root node
* @param string $type The type of the root node * @param string $type The type of the root node
* @param NodeBuilder $builder A custom node builder instance * @param NodeBuilder $builder A custom node builder instance
* *
* @return ArrayNodeDefinition|NodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array') * @return ArrayNodeDefinition|NodeDefinition The root node (as an ArrayNodeDefinition when the type is 'array')
* *

View File

@ -42,8 +42,8 @@ class Processor
/** /**
* Processes an array of configurations. * Processes an array of configurations.
* *
* @param ConfigurationInterface $configuration The configuration class * @param ConfigurationInterface $configuration The configuration class
* @param array $configs An array of configuration items to process * @param array $configs An array of configuration items to process
* *
* @return array The processed configuration * @return array The processed configuration
*/ */

View File

@ -31,7 +31,7 @@ class PrototypedArrayNode extends ArrayNode
/** /**
* Constructor. * Constructor.
* *
* @param string $name The Node's name * @param string $name The Node's name
* @param NodeInterface $parent The node parent * @param NodeInterface $parent The node parent
*/ */
public function __construct($name, NodeInterface $parent = null) public function __construct($name, NodeInterface $parent = null)
@ -70,7 +70,7 @@ class PrototypedArrayNode extends ArrayNode
* "'id' => 'my_name'" item in it. * "'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 * @param Boolean $remove Whether or not to remove the key
*/ */
public function setKeyAttribute($attribute, $remove = true) public function setKeyAttribute($attribute, $remove = true)
{ {
@ -234,7 +234,7 @@ class PrototypedArrayNode extends ArrayNode
/** /**
* Merges values together. * Merges values together.
* *
* @param mixed $leftSide The left side to merge. * @param mixed $leftSide The left side to merge.
* @param mixed $rightSide The right side to merge. * @param mixed $rightSide The right side to merge.
* *
* @return mixed The merged values * @return mixed The merged values

View File

@ -19,10 +19,10 @@ namespace Symfony\Component\Config\Exception;
class FileLoaderLoadException extends \Exception class FileLoaderLoadException extends \Exception
{ {
/** /**
* @param string $resource The resource that could not be imported * @param string $resource The resource that could not be imported
* @param string $sourceResource The original resource importing the new resource * @param string $sourceResource The original resource importing the new resource
* @param integer $code The error code * @param integer $code The error code
* @param Exception $previous A previous exception * @param Exception $previous A previous exception
*/ */
public function __construct($resource, $sourceResource = null, $code = null, $previous = null) public function __construct($resource, $sourceResource = null, $code = null, $previous = null)
{ {

View File

@ -59,8 +59,8 @@ class Application
/** /**
* Constructor. * Constructor.
* *
* @param string $name The name of the application * @param string $name The name of the application
* @param string $version The version of the application * @param string $version The version of the application
* *
* @api * @api
*/ */
@ -503,7 +503,7 @@ class Application
* Contrary to get, this command tries to find the best * Contrary to get, this command tries to find the best
* match if you give it an abbreviation of a name or alias. * match if you give it an abbreviation of a name or alias.
* *
* @param string $name A command name or a command alias * @param string $name A command name or a command alias
* *
* @return Command A Command instance * @return Command A Command instance
* *
@ -567,7 +567,7 @@ class Application
* *
* The array keys are the full names and the values the command instances. * The array keys are the full names and the values the command instances.
* *
* @param string $namespace A namespace name * @param string $namespace A namespace name
* *
* @return array An array of Command instances * @return array An array of Command instances
* *

View File

@ -31,8 +31,8 @@ class OutputFormatter implements OutputFormatterInterface
/** /**
* Initializes console output formatter. * Initializes console output formatter.
* *
* @param Boolean $decorated Whether this formatter should actually decorate strings * @param Boolean $decorated Whether this formatter should actually decorate strings
* @param array $styles Array of "name => FormatterStyle" instances * @param array $styles Array of "name => FormatterStyle" instances
* *
* @api * @api
*/ */
@ -124,7 +124,7 @@ class OutputFormatter implements OutputFormatterInterface
/** /**
* Formats a message according to the given styles. * Formats a message according to the given styles.
* *
* @param string $message The message to style * @param string $message The message to style
* *
* @return string The styled message * @return string The styled message
* *

View File

@ -73,7 +73,7 @@ interface OutputFormatterInterface
/** /**
* Formats a message according to the given styles. * Formats a message according to the given styles.
* *
* @param string $message The message to style * @param string $message The message to style
* *
* @return string The styled message * @return string The styled message
* *

View File

@ -55,9 +55,9 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
/** /**
* Initializes output formatter style. * Initializes output formatter style.
* *
* @param string $foreground style foreground color name * @param string $foreground style foreground color name
* @param string $background style background color name * @param string $background style background color name
* @param array $options style options * @param array $options style options
* *
* @api * @api
*/ */
@ -77,7 +77,7 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
/** /**
* Sets style foreground color. * Sets style foreground color.
* *
* @param string $color color name * @param string $color color name
* *
* @throws \InvalidArgumentException When the color name isn't defined * @throws \InvalidArgumentException When the color name isn't defined
* *
@ -105,7 +105,7 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
/** /**
* Sets style background color. * Sets style background color.
* *
* @param string $color color name * @param string $color color name
* *
* @throws \InvalidArgumentException When the color name isn't defined * @throws \InvalidArgumentException When the color name isn't defined
* *
@ -133,7 +133,7 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
/** /**
* Sets some specific style option. * Sets some specific style option.
* *
* @param string $option option name * @param string $option option name
* *
* @throws \InvalidArgumentException When the option name isn't defined * @throws \InvalidArgumentException When the option name isn't defined
* *
@ -157,7 +157,7 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
/** /**
* Unsets some specific style option. * Unsets some specific style option.
* *
* @param string $option option name * @param string $option option name
* *
* @throws \InvalidArgumentException When the option name isn't defined * @throws \InvalidArgumentException When the option name isn't defined
* *

View File

@ -23,7 +23,7 @@ interface OutputFormatterStyleInterface
/** /**
* Sets style foreground color. * Sets style foreground color.
* *
* @param string $color color name * @param string $color color name
* *
* @api * @api
*/ */
@ -32,7 +32,7 @@ interface OutputFormatterStyleInterface
/** /**
* Sets style background color. * Sets style background color.
* *
* @param string $color color name * @param string $color color name
* *
* @api * @api
*/ */
@ -41,7 +41,7 @@ interface OutputFormatterStyleInterface
/** /**
* Sets some specific style option. * Sets some specific style option.
* *
* @param string $option option name * @param string $option option name
* *
* @api * @api
*/ */
@ -50,7 +50,7 @@ interface OutputFormatterStyleInterface
/** /**
* Unsets some specific style option. * Unsets some specific style option.
* *
* @param string $option option name * @param string $option option name
*/ */
function unsetOption($option); function unsetOption($option);

View File

@ -82,7 +82,7 @@ class DialogHelper extends Helper
* @param string|array $question The question to ask * @param string|array $question The question to ask
* @param callback $validator A PHP callback * @param callback $validator A PHP callback
* @param integer $attempts Max number of times to ask before giving up (false by default, which means infinite) * @param integer $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param string $default The default answer if none is given by the user * @param string $default The default answer if none is given by the user
* *
* @return mixed * @return mixed
* *

View File

@ -21,9 +21,9 @@ class FormatterHelper extends Helper
/** /**
* Formats a message within a section. * Formats a message within a section.
* *
* @param string $section The section name * @param string $section The section name
* @param string $message The message * @param string $message The message
* @param string $style The style to apply to the section * @param string $style The style to apply to the section
*/ */
public function formatSection($section, $message, $style = 'info') public function formatSection($section, $message, $style = 'info')
{ {

View File

@ -55,7 +55,7 @@ class HelperSet
/** /**
* Returns true if the helper if defined. * Returns true if the helper if defined.
* *
* @param string $name The helper name * @param string $name The helper name
* *
* @return Boolean true if the helper is defined, false otherwise * @return Boolean true if the helper is defined, false otherwise
*/ */

View File

@ -46,7 +46,7 @@ class ArgvInput extends Input
/** /**
* Constructor. * Constructor.
* *
* @param array $argv An array of parameters from the CLI (in the argv format) * @param array $argv An array of parameters from the CLI (in the argv format)
* @param InputDefinition $definition A InputDefinition instance * @param InputDefinition $definition A InputDefinition instance
* *
* @api * @api
@ -281,8 +281,8 @@ class ArgvInput extends Input
* This method is to be used to introspect the input parameters * This method is to be used to introspect the input parameters
* before they have been validated. It must be used carefully. * before they have been validated. It must be used carefully.
* *
* @param string|array $values The value(s) to look for in the raw parameters (can be an array) * @param string|array $values The value(s) to look for in the raw parameters (can be an array)
* @param mixed $default The default value to return if no result is found * @param mixed $default The default value to return if no result is found
* *
* @return mixed The option value * @return mixed The option value
*/ */

View File

@ -90,8 +90,8 @@ class ArrayInput extends Input
* This method is to be used to introspect the input parameters * This method is to be used to introspect the input parameters
* before they have been validated. It must be used carefully. * before they have been validated. It must be used carefully.
* *
* @param string|array $values The value(s) to look for in the raw parameters (can be an array) * @param string|array $values The value(s) to look for in the raw parameters (can be an array)
* @param mixed $default The default value to return if no result is found * @param mixed $default The default value to return if no result is found
* *
* @return mixed The option value * @return mixed The option value
*/ */

View File

@ -43,8 +43,8 @@ interface InputInterface
* This method is to be used to introspect the input parameters * This method is to be used to introspect the input parameters
* before they have been validated. It must be used carefully. * before they have been validated. It must be used carefully.
* *
* @param string|array $values The value(s) to look for in the raw parameters (can be an array) * @param string|array $values The value(s) to look for in the raw parameters (can be an array)
* @param mixed $default The default value to return if no result is found * @param mixed $default The default value to return if no result is found
* *
* @return mixed The option value * @return mixed The option value
*/ */

View File

@ -30,7 +30,7 @@ class StringInput extends ArgvInput
/** /**
* Constructor. * Constructor.
* *
* @param string $input An array of parameters from the CLI (in the argv format) * @param string $input An array of parameters from the CLI (in the argv format)
* @param InputDefinition $definition A InputDefinition instance * @param InputDefinition $definition A InputDefinition instance
* *
* @api * @api

View File

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

View File

@ -25,7 +25,7 @@ class NullOutput extends Output
/** /**
* Writes a message to the output. * Writes a message to the output.
* *
* @param string $message A message to write to the output * @param string $message A message to write to the output
* @param Boolean $newline Whether to add a newline or not * @param Boolean $newline Whether to add a newline or not
*/ */
public function doWrite($message, $newline) public function doWrite($message, $newline)

View File

@ -35,8 +35,8 @@ class StreamOutput extends Output
/** /**
* Constructor. * Constructor.
* *
* @param mixed $stream A stream resource * @param mixed $stream A stream resource
* @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL, * @param integer $verbosity The verbosity level (self::VERBOSITY_QUIET, self::VERBOSITY_NORMAL,
* self::VERBOSITY_VERBOSE) * self::VERBOSITY_VERBOSE)
* @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing) * @param Boolean $decorated Whether to decorate messages or not (null for auto-guessing)
* @param OutputFormatter $formatter Output formatter instance * @param OutputFormatter $formatter Output formatter instance

View File

@ -33,8 +33,8 @@ class CssSelector
* Optionally, a prefix can be added to the resulting XPath * Optionally, a prefix can be added to the resulting XPath
* expression with the $prefix parameter. * expression with the $prefix parameter.
* *
* @param mixed $cssExpr The CSS expression. * @param mixed $cssExpr The CSS expression.
* @param string $prefix An optional prefix for the XPath expression. * @param string $prefix An optional prefix for the XPath expression.
* *
* @return string * @return string
* *
@ -86,7 +86,7 @@ class CssSelector
* *
* @throws \Exception When tokenizer throws it while parsing * @throws \Exception When tokenizer throws it while parsing
* *
* @param string $string The expression to parse * @param string $string The expression to parse
* *
* @return Node\NodeInterface * @return Node\NodeInterface
*/ */
@ -109,7 +109,7 @@ class CssSelector
* Parses a selector group contained in $stream and returns * Parses a selector group contained in $stream and returns
* the Node object that represents the expression. * the Node object that represents the expression.
* *
* @param TokenStream $stream The stream to parse. * @param TokenStream $stream The stream to parse.
* *
* @return Node\NodeInterface * @return Node\NodeInterface
*/ */
@ -138,7 +138,7 @@ class CssSelector
* *
* @throws ParseException When expected selector but got something else * @throws ParseException When expected selector but got something else
* *
* @param TokenStream $stream The stream containing the selector. * @param TokenStream $stream The stream containing the selector.
* *
* @return Node\NodeInterface * @return Node\NodeInterface
*/ */
@ -179,7 +179,7 @@ class CssSelector
* *
* @throws ParseException When expected symbol but got something else * @throws ParseException When expected symbol but got something else
* *
* @param TokenStream $stream The stream containing the selector. * @param TokenStream $stream The stream containing the selector.
* *
* @return Node\NodeInterface * @return Node\NodeInterface
*/ */
@ -286,9 +286,9 @@ class CssSelector
* *
* @throws ParseException When encountered unexpected selector * @throws ParseException When encountered unexpected selector
* *
* @param Node\NodeInterface $selector The selector object whose attribute * @param Node\NodeInterface $selector The selector object whose attribute
* is to be parsed. * is to be parsed.
* @param TokenStream $stream The container token stream. * @param TokenStream $stream The container token stream.
* *
* @return Node\AttribNode * @return Node\AttribNode
*/ */

View File

@ -33,11 +33,11 @@ class AttribNode implements NodeInterface
/** /**
* Constructor. * Constructor.
* *
* @param NodeInterface $selector The XPath selector * @param NodeInterface $selector The XPath selector
* @param string $namespace The namespace * @param string $namespace The namespace
* @param string $attrib The attribute * @param string $attrib The attribute
* @param string $operator The operator * @param string $operator The operator
* @param string $value The value * @param string $value The value
*/ */
public function __construct($selector, $namespace, $attrib, $operator, $value) public function __construct($selector, $namespace, $attrib, $operator, $value)
{ {

View File

@ -29,8 +29,8 @@ class ClassNode implements NodeInterface
/** /**
* The constructor. * The constructor.
* *
* @param NodeInterface $selector The XPath Selector * @param NodeInterface $selector The XPath Selector
* @param string $className The class name * @param string $className The class name
*/ */
public function __construct($selector, $className) public function __construct($selector, $className)
{ {

View File

@ -37,8 +37,8 @@ class CombinedSelectorNode implements NodeInterface
/** /**
* The constructor. * The constructor.
* *
* @param NodeInterface $selector The XPath selector * @param NodeInterface $selector The XPath selector
* @param string $combinator The combinator * @param string $combinator The combinator
* @param NodeInterface $subselector The sub XPath selector * @param NodeInterface $subselector The sub XPath selector
*/ */
public function __construct($selector, $combinator, $subselector) public function __construct($selector, $combinator, $subselector)
@ -77,8 +77,8 @@ class CombinedSelectorNode implements NodeInterface
/** /**
* Joins a NodeInterface into the XPath of this object. * Joins a NodeInterface into the XPath of this object.
* *
* @param XPathExpr $xpath The XPath expression for this object * @param XPathExpr $xpath The XPath expression for this object
* @param NodeInterface $sub The NodeInterface object to add * @param NodeInterface $sub The NodeInterface object to add
*/ */
protected function _xpath_descendant($xpath, $sub) protected function _xpath_descendant($xpath, $sub)
{ {
@ -91,8 +91,8 @@ class CombinedSelectorNode implements NodeInterface
/** /**
* Joins a NodeInterface as a child of this object. * Joins a NodeInterface as a child of this object.
* *
* @param XPathExpr $xpath The parent XPath expression * @param XPathExpr $xpath The parent XPath expression
* @param NodeInterface $sub The NodeInterface object to add * @param NodeInterface $sub The NodeInterface object to add
*/ */
protected function _xpath_child($xpath, $sub) protected function _xpath_child($xpath, $sub)
{ {
@ -105,8 +105,8 @@ class CombinedSelectorNode implements NodeInterface
/** /**
* Joins an XPath expression as an adjacent of another. * Joins an XPath expression as an adjacent of another.
* *
* @param XPathExpr $xpath The parent XPath expression * @param XPathExpr $xpath The parent XPath expression
* @param NodeInterface $sub The adjacent XPath expression * @param NodeInterface $sub The adjacent XPath expression
*/ */
protected function _xpath_direct_adjacent($xpath, $sub) protected function _xpath_direct_adjacent($xpath, $sub)
{ {
@ -121,8 +121,8 @@ class CombinedSelectorNode implements NodeInterface
/** /**
* Joins an XPath expression as an indirect adjacent of another. * Joins an XPath expression as an indirect adjacent of another.
* *
* @param XPathExpr $xpath The parent XPath expression * @param XPathExpr $xpath The parent XPath expression
* @param NodeInterface $sub The indirect adjacent NodeInterface object * @param NodeInterface $sub The indirect adjacent NodeInterface object
*/ */
protected function _xpath_indirect_adjacent($xpath, $sub) protected function _xpath_indirect_adjacent($xpath, $sub)
{ {

View File

@ -30,7 +30,7 @@ class ElementNode implements NodeInterface
* Constructor. * Constructor.
* *
* @param string $namespace Namespace * @param string $namespace Namespace
* @param string $element Element * @param string $element Element
*/ */
public function __construct($namespace, $element) public function __construct($namespace, $element)
{ {

View File

@ -30,7 +30,7 @@ class HashNode implements NodeInterface
* Constructor. * Constructor.
* *
* @param NodeInterface $selector The NodeInterface object * @param NodeInterface $selector The NodeInterface object
* @param string $id The ID * @param string $id The ID
*/ */
public function __construct($selector, $id) public function __construct($selector, $id)
{ {

View File

@ -37,8 +37,8 @@ class PseudoNode implements NodeInterface
* Constructor. * Constructor.
* *
* @param NodeInterface $element The NodeInterface element * @param NodeInterface $element The NodeInterface element
* @param string $type Node type * @param string $type Node type
* @param string $ident The ident * @param string $ident The ident
* *
* @throws ParseException When incorrect PseudoNode type is given * @throws ParseException When incorrect PseudoNode type is given
*/ */

View File

@ -52,7 +52,7 @@ class Token
/** /**
* Answers whether this token's type equals to $type. * Answers whether this token's type equals to $type.
* *
* @param string $type The type to test against this token's one. * @param string $type The type to test against this token's one.
* *
* @return Boolean * @return Boolean
*/ */

View File

@ -27,7 +27,7 @@ class Tokenizer
* Takes a CSS selector and returns an array holding the Tokens * Takes a CSS selector and returns an array holding the Tokens
* it contains. * it contains.
* *
* @param string $s The selector to lex. * @param string $s The selector to lex.
* *
* @return array Token[] * @return array Token[]
*/ */
@ -111,8 +111,8 @@ class Tokenizer
* *
* @throws ParseException When expected closing is not found * @throws ParseException When expected closing is not found
* *
* @param string $s The selector string containing the quoted string. * @param string $s The selector string containing the quoted string.
* @param integer $pos The starting position for the quoted string. * @param integer $pos The starting position for the quoted string.
* *
* @return array * @return array
*/ */
@ -148,7 +148,7 @@ class Tokenizer
* *
* @throws ParseException When invalid escape sequence is found * @throws ParseException When invalid escape sequence is found
* *
* @param string $literal The string literal to unescape. * @param string $literal The string literal to unescape.
* *
* @return string * @return string
*/ */
@ -174,8 +174,8 @@ class Tokenizer
* *
* @throws ParseException When Unexpected symbol is found * @throws ParseException When Unexpected symbol is found
* *
* @param string $s The selector string. * @param string $s The selector string.
* @param integer $pos The position in $s at which the symbol starts. * @param integer $pos The position in $s at which the symbol starts.
* *
* @return array * @return array
*/ */

View File

@ -139,7 +139,7 @@ class XPathExpr
* Adds a prefix to this XPath expression. * Adds a prefix to this XPath expression.
* It will be prepended to any pre-existent prefixes. * It will be prepended to any pre-existent prefixes.
* *
* @param string $prefix The prefix to add. * @param string $prefix The prefix to add.
*/ */
public function addPrefix($prefix) public function addPrefix($prefix)
{ {
@ -215,7 +215,7 @@ class XPathExpr
/** /**
* Gets an XPath literal for $s. * Gets an XPath literal for $s.
* *
* @param mixed $s Can either be a Node\ElementNode or a string. * @param mixed $s Can either be a Node\ElementNode or a string.
* *
* @return string * @return string
*/ */

View File

@ -22,7 +22,7 @@ class Alias
/** /**
* Constructor. * Constructor.
* *
* @param string $id Alias identifier * @param string $id Alias identifier
* @param Boolean $public If this alias is public * @param Boolean $public If this alias is public
* *
* @api * @api

View File

@ -94,7 +94,7 @@ class PassConfig
* Adds a pass. * Adds a pass.
* *
* @param CompilerPassInterface $pass A Compiler pass * @param CompilerPassInterface $pass A Compiler pass
* @param string $type The pass type * @param string $type The pass type
* *
* @throws \InvalidArgumentException when a pass type doesn't exist * @throws \InvalidArgumentException when a pass type doesn't exist
* *

View File

@ -63,8 +63,8 @@ class ReplaceAliasByActualDefinitionPass implements CompilerPassInterface
* Updates references to remove aliases. * Updates references to remove aliases.
* *
* @param ContainerBuilder $container The container * @param ContainerBuilder $container The container
* @param string $currentId The alias identifier being replaced * @param string $currentId The alias identifier being replaced
* @param string $newId The id of the service the alias points to * @param string $newId The id of the service the alias points to
*/ */
private function updateReferences($container, $currentId, $newId) private function updateReferences($container, $currentId, $newId)
{ {
@ -94,9 +94,9 @@ class ReplaceAliasByActualDefinitionPass implements CompilerPassInterface
/** /**
* Updates argument references. * Updates argument references.
* *
* @param array $arguments An array of Arguments * @param array $arguments An array of Arguments
* @param string $currentId The alias identifier * @param string $currentId The alias identifier
* @param string $newId The identifier the alias points to * @param string $newId The identifier the alias points to
*/ */
private function updateArgumentReferences(array $arguments, $currentId, $newId) private function updateArgumentReferences(array $arguments, $currentId, $newId)
{ {

View File

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

View File

@ -68,7 +68,7 @@ class ResolveInvalidReferencesPass implements CompilerPassInterface
/** /**
* Processes arguments to determine invalid references. * Processes arguments to determine invalid references.
* *
* @param array $arguments An array of Reference objects * @param array $arguments An array of Reference objects
* @param Boolean $inMethodCall * @param Boolean $inMethodCall
*/ */
private function processArguments(array $arguments, $inMethodCall = false) private function processArguments(array $arguments, $inMethodCall = false)

View File

@ -31,8 +31,8 @@ class ServiceReferenceGraphNode
/** /**
* Constructor. * Constructor.
* *
* @param string $id The node identifier * @param string $id The node identifier
* @param mixed $value The node value * @param mixed $value The node value
*/ */
public function __construct($id, $value) public function __construct($id, $value)
{ {

View File

@ -131,7 +131,7 @@ class Container implements ContainerInterface
/** /**
* Gets a parameter. * Gets a parameter.
* *
* @param string $name The parameter name * @param string $name The parameter name
* *
* @return mixed The parameter value * @return mixed The parameter value
* *
@ -147,7 +147,7 @@ class Container implements ContainerInterface
/** /**
* Checks if a parameter exists. * Checks if a parameter exists.
* *
* @param string $name The parameter name * @param string $name The parameter name
* *
* @return Boolean The presence of parameter in container * @return Boolean The presence of parameter in container
* *
@ -202,7 +202,7 @@ class Container implements ContainerInterface
/** /**
* Returns true if the given service is defined. * Returns true if the given service is defined.
* *
* @param string $id The service identifier * @param string $id The service identifier
* *
* @return Boolean true if the service is defined, false otherwise * @return Boolean true if the service is defined, false otherwise
* *
@ -221,8 +221,8 @@ class Container implements ContainerInterface
* If a service is both defined through a set() method and * If a service is both defined through a set() method and
* with a set*Service() method, the former has always precedence. * with a set*Service() method, the former has always precedence.
* *
* @param string $id The service identifier * @param string $id The service identifier
* @param integer $invalidBehavior The behavior when the service does not exist * @param integer $invalidBehavior The behavior when the service does not exist
* *
* @return object The associated service * @return object The associated service
* *

View File

@ -280,7 +280,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/** /**
* Returns true if the given service is defined. * Returns true if the given service is defined.
* *
* @param string $id The service identifier * @param string $id The service identifier
* *
* @return Boolean true if the service is defined, false otherwise * @return Boolean true if the service is defined, false otherwise
* *
@ -296,8 +296,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/** /**
* Gets a service. * Gets a service.
* *
* @param string $id The service identifier * @param string $id The service identifier
* @param integer $invalidBehavior The behavior when the service does not exist * @param integer $invalidBehavior The behavior when the service does not exist
* *
* @return object The associated service * @return object The associated service
* *
@ -520,7 +520,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/** /**
* Returns true if an alias exists under the given identifier. * Returns true if an alias exists under the given identifier.
* *
* @param string $id The service identifier * @param string $id The service identifier
* *
* @return Boolean true if the alias exists, false otherwise * @return Boolean true if the alias exists, false otherwise
* *
@ -546,7 +546,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/** /**
* Gets an alias. * Gets an alias.
* *
* @param string $id The service identifier * @param string $id The service identifier
* *
* @return string The aliased service identifier * @return string The aliased service identifier
* *
@ -571,8 +571,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
* This methods allows for simple registration of service definition * This methods allows for simple registration of service definition
* with a fluid interface. * with a fluid interface.
* *
* @param string $id The service identifier * @param string $id The service identifier
* @param string $class The service class * @param string $class The service class
* *
* @return Definition A Definition instance * @return Definition A Definition instance
* *
@ -625,8 +625,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/** /**
* Sets a service definition. * Sets a service definition.
* *
* @param string $id The service identifier * @param string $id The service identifier
* @param Definition $definition A Definition instance * @param Definition $definition A Definition instance
* *
* @throws BadMethodCallException * @throws BadMethodCallException
* *
@ -648,7 +648,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/** /**
* Returns true if a service definition exists under the given identifier. * Returns true if a service definition exists under the given identifier.
* *
* @param string $id The service identifier * @param string $id The service identifier
* *
* @return Boolean true if the service definition exists, false otherwise * @return Boolean true if the service definition exists, false otherwise
* *
@ -662,7 +662,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/** /**
* Gets a service definition. * Gets a service definition.
* *
* @param string $id The service identifier * @param string $id The service identifier
* *
* @return Definition A Definition instance * @return Definition A Definition instance
* *
@ -686,7 +686,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
* *
* The method "unaliases" recursively to return a Definition instance. * The method "unaliases" recursively to return a Definition instance.
* *
* @param string $id The service identifier or alias * @param string $id The service identifier or alias
* *
* @return Definition A Definition instance * @return Definition A Definition instance
* *
@ -706,8 +706,8 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/** /**
* Creates a service for a service definition. * Creates a service for a service definition.
* *
* @param Definition $definition A service definition instance * @param Definition $definition A service definition instance
* @param string $id The service identifier * @param string $id The service identifier
* *
* @return object The service described by the service definition * @return object The service described by the service definition
* *
@ -790,7 +790,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/** /**
* Replaces service references by the real service instance. * Replaces service references by the real service instance.
* *
* @param mixed $value A value * @param mixed $value A value
* *
* @return mixed The same value with all service references replaced by the real service instances * @return mixed The same value with all service references replaced by the real service instances
*/ */

View File

@ -41,8 +41,8 @@ interface ContainerInterface
/** /**
* Gets a service. * Gets a service.
* *
* @param string $id The service identifier * @param string $id The service identifier
* @param int $invalidBehavior The behavior when the service does not exist * @param int $invalidBehavior The behavior when the service does not exist
* *
* @return object The associated service * @return object The associated service
* *
@ -57,7 +57,7 @@ interface ContainerInterface
/** /**
* Returns true if the given service is defined. * Returns true if the given service is defined.
* *
* @param string $id The service identifier * @param string $id The service identifier
* *
* @return Boolean true if the service is defined, false otherwise * @return Boolean true if the service is defined, false otherwise
* *
@ -68,7 +68,7 @@ interface ContainerInterface
/** /**
* Gets a parameter. * Gets a parameter.
* *
* @param string $name The parameter name * @param string $name The parameter name
* *
* @return mixed The parameter value * @return mixed The parameter value
* *
@ -81,7 +81,7 @@ interface ContainerInterface
/** /**
* Checks if a parameter exists. * Checks if a parameter exists.
* *
* @param string $name The parameter name * @param string $name The parameter name
* *
* @return Boolean The presence of parameter in container * @return Boolean The presence of parameter in container
* *

View File

@ -63,7 +63,7 @@ class Definition
* Sets the name of the class that acts as a factory using the factory method, * Sets the name of the class that acts as a factory using the factory method,
* which will be invoked statically. * which will be invoked statically.
* *
* @param string $factoryClass The factory class name * @param string $factoryClass The factory class name
* *
* @return Definition The current instance * @return Definition The current instance
* *
@ -91,7 +91,7 @@ class Definition
/** /**
* Sets the factory method able to create an instance of this class. * Sets the factory method able to create an instance of this class.
* *
* @param string $factoryMethod The factory method name * @param string $factoryMethod The factory method name
* *
* @return Definition The current instance * @return Definition The current instance
* *
@ -147,7 +147,7 @@ class Definition
/** /**
* Sets the service class. * Sets the service class.
* *
* @param string $class The service class * @param string $class The service class
* *
* @return Definition The current instance * @return Definition The current instance
* *
@ -175,7 +175,7 @@ class Definition
/** /**
* Sets the arguments to pass to the service constructor/factory method. * Sets the arguments to pass to the service constructor/factory method.
* *
* @param array $arguments An array of arguments * @param array $arguments An array of arguments
* *
* @return Definition The current instance * @return Definition The current instance
* *
@ -219,7 +219,7 @@ class Definition
/** /**
* Adds an argument to pass to the service constructor/factory method. * Adds an argument to pass to the service constructor/factory method.
* *
* @param mixed $argument An argument * @param mixed $argument An argument
* *
* @return Definition The current instance * @return Definition The current instance
* *
@ -286,7 +286,7 @@ class Definition
/** /**
* Sets the methods to call after service initialization. * Sets the methods to call after service initialization.
* *
* @param array $calls An array of method calls * @param array $calls An array of method calls
* *
* @return Definition The current instance * @return Definition The current instance
* *
@ -305,8 +305,8 @@ class Definition
/** /**
* Adds a method to call after service initialization. * Adds a method to call after service initialization.
* *
* @param string $method The method name to call * @param string $method The method name to call
* @param array $arguments An array of arguments to pass to the method call * @param array $arguments An array of arguments to pass to the method call
* *
* @return Definition The current instance * @return Definition The current instance
* *
@ -327,7 +327,7 @@ class Definition
/** /**
* Removes a method to call after service initialization. * Removes a method to call after service initialization.
* *
* @param string $method The method name to remove * @param string $method The method name to remove
* *
* @return Definition The current instance * @return Definition The current instance
* *
@ -348,7 +348,7 @@ class Definition
/** /**
* Check if the current definition has a given method to call after service initialization. * Check if the current definition has a given method to call after service initialization.
* *
* @param string $method The method name to search for * @param string $method The method name to search for
* *
* @return Boolean * @return Boolean
* *
@ -408,7 +408,7 @@ class Definition
/** /**
* Gets a tag by name. * Gets a tag by name.
* *
* @param string $name The tag name * @param string $name The tag name
* *
* @return array An array of attributes * @return array An array of attributes
* *
@ -422,8 +422,8 @@ class Definition
/** /**
* Adds a tag for this definition. * Adds a tag for this definition.
* *
* @param string $name The tag name * @param string $name The tag name
* @param array $attributes An array of attributes * @param array $attributes An array of attributes
* *
* @return Definition The current instance * @return Definition The current instance
* *
@ -467,7 +467,7 @@ class Definition
/** /**
* Sets a file to require before creating the service. * Sets a file to require before creating the service.
* *
* @param string $file A full pathname to include * @param string $file A full pathname to include
* *
* @return Definition The current instance * @return Definition The current instance
* *
@ -495,7 +495,7 @@ class Definition
/** /**
* Sets the scope of the service * Sets the scope of the service
* *
* @param string $scope Whether the service must be shared or not * @param string $scope Whether the service must be shared or not
* *
* @return Definition The current instance * @return Definition The current instance
* *
@ -611,7 +611,7 @@ class Definition
/** /**
* Sets a configurator to call after the service is fully initialized. * Sets a configurator to call after the service is fully initialized.
* *
* @param mixed $callable A PHP callable * @param mixed $callable A PHP callable
* *
* @return Definition The current instance * @return Definition The current instance
* *

View File

@ -23,7 +23,7 @@ interface DumperInterface
/** /**
* Dumps the service container. * Dumps the service container.
* *
* @param array $options An array of options * @param array $options An array of options
* *
* @return string The representation of the service container * @return string The representation of the service container
* *

View File

@ -50,7 +50,7 @@ class GraphvizDumper extends Dumper
* * node.definition: The default options for services that are defined via service definition instances * * node.definition: The default options for services that are defined via service definition instances
* * node.missing: The default options for missing services * * node.missing: The default options for missing services
* *
* @param array $options An array of options * @param array $options An array of options
* *
* @return string The dot representation of the service container * @return string The dot representation of the service container
*/ */
@ -119,8 +119,8 @@ class GraphvizDumper extends Dumper
/** /**
* Finds all edges belonging to a specific service id. * Finds all edges belonging to a specific service id.
* *
* @param string $id The service id used to find edges * @param string $id The service id used to find edges
* @param array $arguments An array of arguments * @param array $arguments An array of arguments
* @param Boolean $required * @param Boolean $required
* @param string $name * @param string $name
* *

View File

@ -68,7 +68,7 @@ class PhpDumper extends Dumper
* * class: The class name * * class: The class name
* * base_class: The base class name * * base_class: The base class name
* *
* @param array $options An array of options * @param array $options An array of options
* *
* @return string A PHP class representing of the service container * @return string A PHP class representing of the service container
* *
@ -611,7 +611,7 @@ EOF;
/** /**
* Adds the class headers. * Adds the class headers.
* *
* @param string $class Class name * @param string $class Class name
* @param string $baseClass The name of the base class * @param string $baseClass The name of the base class
* *
* @return string * @return string

View File

@ -34,7 +34,7 @@ class XmlDumper extends Dumper
/** /**
* Dumps the service container as an XML string. * Dumps the service container as an XML string.
* *
* @param array $options An array of options * @param array $options An array of options
* *
* @return string An xml string representing of the service container * @return string An xml string representing of the service container
* *

View File

@ -28,7 +28,7 @@ class YamlDumper extends Dumper
/** /**
* Dumps the service container as an YAML string. * Dumps the service container as an YAML string.
* *
* @param array $options An array of options * @param array $options An array of options
* *
* @return string A YAML string representing of the service container * @return string A YAML string representing of the service container
* *

View File

@ -49,8 +49,8 @@ class ClosureLoader extends Loader
/** /**
* Returns true if this class supports the given resource. * Returns true if this class supports the given resource.
* *
* @param mixed $resource A resource * @param mixed $resource A resource
* @param string $type The resource type * @param string $type The resource type
* *
* @return Boolean true if this class supports the given resource, false otherwise * @return Boolean true if this class supports the given resource, false otherwise
*/ */

View File

@ -23,8 +23,8 @@ class IniFileLoader extends FileLoader
/** /**
* Loads a resource. * Loads a resource.
* *
* @param mixed $file The resource * @param mixed $file The resource
* @param string $type The resource type * @param string $type The resource type
* *
* @throws \InvalidArgumentException When ini file is not valid * @throws \InvalidArgumentException When ini file is not valid
*/ */

View File

@ -115,7 +115,7 @@ class ParameterBag implements ParameterBagInterface
/** /**
* Returns true if a parameter name is defined. * Returns true if a parameter name is defined.
* *
* @param string $name The parameter name * @param string $name The parameter name
* *
* @return Boolean true if the parameter name is defined, false otherwise * @return Boolean true if the parameter name is defined, false otherwise
* *
@ -154,7 +154,7 @@ class ParameterBag implements ParameterBagInterface
/** /**
* Replaces parameter placeholders (%name%) by their values. * Replaces parameter placeholders (%name%) by their values.
* *
* @param mixed $value A value * @param mixed $value A value
* @param array $resolving An array of keys that are being resolved (used internally to detect circular references) * @param array $resolving An array of keys that are being resolved (used internally to detect circular references)
* *
* @return mixed The resolved value * @return mixed The resolved value

View File

@ -73,7 +73,7 @@ interface ParameterBagInterface
/** /**
* Returns true if a parameter name is defined. * Returns true if a parameter name is defined.
* *
* @param string $name The parameter name * @param string $name The parameter name
* *
* @return Boolean true if the parameter name is defined, false otherwise * @return Boolean true if the parameter name is defined, false otherwise
* *
@ -89,7 +89,7 @@ interface ParameterBagInterface
/** /**
* Replaces parameter placeholders (%name%) by their values. * Replaces parameter placeholders (%name%) by their values.
* *
* @param mixed $value A value * @param mixed $value A value
* *
* @throws ParameterNotFoundException if a placeholder references a parameter that does not exist * @throws ParameterNotFoundException if a placeholder references a parameter that does not exist
*/ */

View File

@ -139,8 +139,8 @@ class EventDispatcher implements EventDispatcherInterface
* for each listener. * for each listener.
* *
* @param array[callback] $listeners The event listeners. * @param array[callback] $listeners The event listeners.
* @param string $eventName The name of the event to dispatch. * @param string $eventName The name of the event to dispatch.
* @param Event $event The event object to pass to the event handlers/listeners. * @param Event $event The event object to pass to the event handlers/listeners.
*/ */
protected function doDispatch($listeners, $eventName, Event $event) protected function doDispatch($listeners, $eventName, Event $event)
{ {

View File

@ -28,7 +28,7 @@ interface EventDispatcherInterface
* @param string $eventName The name of the event to dispatch. The name of * @param string $eventName The name of the event to dispatch. The name of
* the event is the name of the method that is * the event is the name of the method that is
* invoked on listeners. * invoked on listeners.
* @param Event $event The event to pass to the event handlers/listeners. * @param Event $event The event to pass to the event handlers/listeners.
* If not supplied, an empty Event instance is created. * If not supplied, an empty Event instance is created.
* *
* @api * @api

View File

@ -103,7 +103,7 @@ class Finder implements \IteratorAggregate
* $finder->depth('> 1') // the Finder will start matching at level 1. * $finder->depth('> 1') // the Finder will start matching at level 1.
* $finder->depth('< 3') // the Finder will descend at most 3 levels of directories below the starting point. * $finder->depth('< 3') // the Finder will descend at most 3 levels of directories below the starting point.
* *
* @param int $level The depth level expression * @param int $level The depth level expression
* *
* @return Finder The current Finder instance * @return Finder The current Finder instance
* *
@ -129,7 +129,7 @@ class Finder implements \IteratorAggregate
* $finder->date('> now - 2 hours'); * $finder->date('> now - 2 hours');
* $finder->date('>= 2005-10-15'); * $finder->date('>= 2005-10-15');
* *
* @param string $date A date rage string * @param string $date A date rage string
* *
* @return Finder The current Finder instance * @return Finder The current Finder instance
* *
@ -155,7 +155,7 @@ class Finder implements \IteratorAggregate
* $finder->name('/\.php$/') // same as above * $finder->name('/\.php$/') // same as above
* $finder->name('test.php') * $finder->name('test.php')
* *
* @param string $pattern A pattern (a regexp, a glob, or a string) * @param string $pattern A pattern (a regexp, a glob, or a string)
* *
* @return Finder The current Finder instance * @return Finder The current Finder instance
* *
@ -173,7 +173,7 @@ class Finder implements \IteratorAggregate
/** /**
* Adds rules that files must not match. * Adds rules that files must not match.
* *
* @param string $pattern A pattern (a regexp, a glob, or a string) * @param string $pattern A pattern (a regexp, a glob, or a string)
* *
* @return Finder The current Finder instance * @return Finder The current Finder instance
* *
@ -214,7 +214,7 @@ class Finder implements \IteratorAggregate
/** /**
* Excludes directories. * Excludes directories.
* *
* @param string $dir A directory to exclude * @param string $dir A directory to exclude
* *
* @return Finder The current Finder instance * @return Finder The current Finder instance
* *
@ -285,7 +285,7 @@ class Finder implements \IteratorAggregate
* *
* This can be slow as all the matching files and directories must be retrieved for comparison. * This can be slow as all the matching files and directories must be retrieved for comparison.
* *
* @param Closure $closure An anonymous function * @param Closure $closure An anonymous function
* *
* @return Finder The current Finder instance * @return Finder The current Finder instance
* *
@ -342,7 +342,7 @@ class Finder implements \IteratorAggregate
* The anonymous function receives a \SplFileInfo and must return false * The anonymous function receives a \SplFileInfo and must return false
* to remove files. * to remove files.
* *
* @param Closure $closure An anonymous function * @param Closure $closure An anonymous function
* *
* @return Finder The current Finder instance * @return Finder The current Finder instance
* *
@ -374,7 +374,7 @@ class Finder implements \IteratorAggregate
/** /**
* Searches files and directories which match defined rules. * Searches files and directories which match defined rules.
* *
* @param string|array $dirs A directory path or an array of directories * @param string|array $dirs A directory path or an array of directories
* *
* @return Finder The current Finder instance * @return Finder The current Finder instance
* *

View File

@ -38,7 +38,7 @@ class Glob
/** /**
* Returns a regexp which is the equivalent of the glob pattern. * 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 $strictLeadingDot
* @param Boolean $strictWildcardSlash * @param Boolean $strictWildcardSlash
* *

View File

@ -30,8 +30,8 @@ abstract class AbstractType implements FormTypeInterface
* *
* @see FormTypeExtensionInterface::buildForm() * @see FormTypeExtensionInterface::buildForm()
* *
* @param FormBuilder $builder The form builder * @param FormBuilder $builder The form builder
* @param array $options The options * @param array $options The options
*/ */
public function buildForm(FormBuilder $builder, array $options) public function buildForm(FormBuilder $builder, array $options)
{ {
@ -78,9 +78,9 @@ abstract class AbstractType implements FormTypeInterface
* The builder is retrieved by going up in the type hierarchy when a type does * The builder is retrieved by going up in the type hierarchy when a type does
* not provide one. * not provide one.
* *
* @param string $name The name of the builder * @param string $name The name of the builder
* @param FormFactoryInterface $factory The form factory * @param FormFactoryInterface $factory The form factory
* @param array $options The options * @param array $options The options
* *
* @return FormBuilder|null A form builder or null when the type does not have a builder * @return FormBuilder|null A form builder or null when the type does not have a builder
*/ */

View File

@ -21,8 +21,8 @@ abstract class AbstractTypeExtension implements FormTypeExtensionInterface
* *
* @see FormTypeInterface::buildForm() * @see FormTypeInterface::buildForm()
* *
* @param FormBuilder $builder The form builder * @param FormBuilder $builder The form builder
* @param array $options The options * @param array $options The options
*/ */
public function buildForm(FormBuilder $builder, array $options) public function buildForm(FormBuilder $builder, array $options)
{ {

View File

@ -28,8 +28,8 @@ class CallbackTransformer implements DataTransformerInterface
/** /**
* Constructor. * Constructor.
* *
* @param \Closure $transform The forward transform callback * @param \Closure $transform The forward transform callback
* @param \Closure $reverseTransform The reverse transform callback * @param \Closure $reverseTransform The reverse transform callback
*/ */
public function __construct(\Closure $transform, \Closure $reverseTransform) public function __construct(\Closure $transform, \Closure $reverseTransform)
{ {
@ -40,7 +40,7 @@ class CallbackTransformer implements DataTransformerInterface
/** /**
* Transforms a value from the original representation to a transformed representation. * Transforms a value from the original representation to a transformed representation.
* *
* @param mixed $data The value in the original representation * @param mixed $data The value in the original representation
* *
* @return mixed The value in the transformed representation * @return mixed The value in the transformed representation
* *
@ -56,7 +56,7 @@ class CallbackTransformer implements DataTransformerInterface
* Transforms a value from the transformed representation to its original * Transforms a value from the transformed representation to its original
* representation. * representation.
* *
* @param mixed $data The value in the transformed representation * @param mixed $data The value in the transformed representation
* *
* @return mixed The value in the original representation * @return mixed The value in the original representation
* *

View File

@ -39,7 +39,7 @@ interface DataTransformerInterface
* By convention, transform() should return an empty string if NULL is * By convention, transform() should return an empty string if NULL is
* passed. * passed.
* *
* @param mixed $value The value in the original representation * @param mixed $value The value in the original representation
* *
* @return mixed The value in the transformed representation * @return mixed The value in the transformed representation
* *
@ -66,7 +66,7 @@ interface DataTransformerInterface
* By convention, reverseTransform() should return NULL if an empty string * By convention, reverseTransform() should return NULL if an empty string
* is passed. * is passed.
* *
* @param mixed $value The value in the transformed representation * @param mixed $value The value in the transformed representation
* *
* @return mixed The value in the original representation * @return mixed The value in the original representation
* *

View File

@ -33,7 +33,7 @@ class ArrayToBooleanChoicesTransformer implements DataTransformerInterface
* depending on whether a given option is selected. If this field is rendered * depending on whether a given option is selected. If this field is rendered
* as select tag, the value is not modified. * as select tag, the value is not modified.
* *
* @param mixed $array An array * @param mixed $array An array
* *
* @return mixed An array * @return mixed An array
* *
@ -70,7 +70,7 @@ class ArrayToBooleanChoicesTransformer implements DataTransformerInterface
* values, depending on whether a given choice is selected. The output * values, depending on whether a given choice is selected. The output
* is an array with the selected choices. * is an array with the selected choices.
* *
* @param mixed $value An array * @param mixed $value An array
* *
* @return mixed $value An array * @return mixed $value An array
* *

View File

@ -25,7 +25,7 @@ class BooleanToStringTransformer implements DataTransformerInterface
/** /**
* Transforms a Boolean into a string. * Transforms a Boolean into a string.
* *
* @param Boolean $value Boolean value. * @param Boolean $value Boolean value.
* *
* @return string String value. * @return string String value.
* *
@ -47,7 +47,7 @@ class BooleanToStringTransformer implements DataTransformerInterface
/** /**
* Transforms a string into a Boolean. * Transforms a string into a Boolean.
* *
* @param string $value String value. * @param string $value String value.
* *
* @return Boolean Boolean value. * @return Boolean Boolean value.
* *

View File

@ -44,7 +44,7 @@ class DataTransformerChain implements DataTransformerInterface
* transformer as input. The output of the last transformer is returned * transformer as input. The output of the last transformer is returned
* by this method. * by this method.
* *
* @param mixed $value The original value * @param mixed $value The original value
* *
* @return mixed The transformed value * @return mixed The transformed value
* *
@ -69,7 +69,7 @@ class DataTransformerChain implements DataTransformerInterface
* transformer as input. The output of the last transformer is returned * transformer as input. The output of the last transformer is returned
* by this method. * by this method.
* *
* @param mixed $value The transformed value * @param mixed $value The transformed value
* *
* @return mixed The reverse-transformed value * @return mixed The reverse-transformed value
* *

View File

@ -29,10 +29,10 @@ class DateTimeToArrayTransformer extends BaseDateTimeTransformer
/** /**
* Constructor. * Constructor.
* *
* @param string $inputTimezone The input timezone * @param string $inputTimezone The input timezone
* @param string $outputTimezone The output timezone * @param string $outputTimezone The output timezone
* @param array $fields The date fields * @param array $fields The date fields
* @param Boolean $pad Whether to use padding * @param Boolean $pad Whether to use padding
* *
* @throws UnexpectedTypeException if a timezone is not a string * @throws UnexpectedTypeException if a timezone is not a string
*/ */
@ -51,7 +51,7 @@ class DateTimeToArrayTransformer extends BaseDateTimeTransformer
/** /**
* Transforms a normalized date into a localized date. * Transforms a normalized date into a localized date.
* *
* @param DateTime $dateTime Normalized date. * @param DateTime $dateTime Normalized date.
* *
* @return array Localized date. * @return array Localized date.
* *
@ -106,7 +106,7 @@ class DateTimeToArrayTransformer extends BaseDateTimeTransformer
/** /**
* Transforms a localized date into a normalized date. * Transforms a localized date into a normalized date.
* *
* @param array $value Localized date * @param array $value Localized date
* *
* @return DateTime Normalized date * @return DateTime Normalized date
* *

View File

@ -32,12 +32,12 @@ class DateTimeToLocalizedStringTransformer extends BaseDateTimeTransformer
* *
* @see BaseDateTimeTransformer::formats for available format options * @see BaseDateTimeTransformer::formats for available format options
* *
* @param string $inputTimezone The name of the input timezone * @param string $inputTimezone The name of the input timezone
* @param string $outputTimezone The name of the output timezone * @param string $outputTimezone The name of the output timezone
* @param integer $dateFormat The date format * @param integer $dateFormat The date format
* @param integer $timeFormat The time format * @param integer $timeFormat The time format
* @param \IntlDateFormatter $calendar An \IntlDateFormatter instance * @param \IntlDateFormatter $calendar An \IntlDateFormatter instance
* @param string $pattern A pattern to pass to \IntlDateFormatter * @param string $pattern A pattern to pass to \IntlDateFormatter
* *
* @throws UnexpectedTypeException If a format is not supported * @throws UnexpectedTypeException If a format is not supported
* @throws UnexpectedTypeException if a timezone is not a string * @throws UnexpectedTypeException if a timezone is not a string
@ -71,7 +71,7 @@ class DateTimeToLocalizedStringTransformer extends BaseDateTimeTransformer
/** /**
* Transforms a normalized date into a localized date string/array. * Transforms a normalized date into a localized date string/array.
* *
* @param DateTime $dateTime Normalized date. * @param DateTime $dateTime Normalized date.
* *
* @return string|array Localized date string/array. * @return string|array Localized date string/array.
* *
@ -106,7 +106,7 @@ class DateTimeToLocalizedStringTransformer extends BaseDateTimeTransformer
/** /**
* Transforms a localized date string/array into a normalized date. * Transforms a localized date string/array into a normalized date.
* *
* @param string|array $value Localized date string/array * @param string|array $value Localized date string/array
* *
* @return DateTime Normalized date * @return DateTime Normalized date
* *

View File

@ -46,7 +46,7 @@ class DateTimeToStringTransformer extends BaseDateTimeTransformer
* Transforms a DateTime object into a date string with the configured format * Transforms a DateTime object into a date string with the configured format
* and timezone * and timezone
* *
* @param DateTime $value A DateTime object * @param DateTime $value A DateTime object
* *
* @return string A value as produced by PHP's date() function * @return string A value as produced by PHP's date() function
* *
@ -76,7 +76,7 @@ class DateTimeToStringTransformer extends BaseDateTimeTransformer
/** /**
* Transforms a date string in the configured timezone into a DateTime object. * Transforms a date string in the configured timezone into a DateTime object.
* *
* @param string $value A value as produced by PHP's date() function * @param string $value A value as produced by PHP's date() function
* *
* @return \DateTime An instance of \DateTime * @return \DateTime An instance of \DateTime
* *

View File

@ -25,7 +25,7 @@ class DateTimeToTimestampTransformer extends BaseDateTimeTransformer
/** /**
* Transforms a DateTime object into a timestamp in the configured timezone. * Transforms a DateTime object into a timestamp in the configured timezone.
* *
* @param DateTime $value A DateTime object * @param DateTime $value A DateTime object
* *
* @return integer A timestamp * @return integer A timestamp
* *
@ -55,7 +55,7 @@ class DateTimeToTimestampTransformer extends BaseDateTimeTransformer
/** /**
* Transforms a timestamp in the configured timezone into a DateTime object * Transforms a timestamp in the configured timezone into a DateTime object
* *
* @param string $value A timestamp * @param string $value A timestamp
* *
* @return \DateTime An instance of \DateTime * @return \DateTime An instance of \DateTime
* *

View File

@ -46,7 +46,7 @@ class MoneyToLocalizedStringTransformer extends NumberToLocalizedStringTransform
/** /**
* Transforms a normalized format into a localized money string. * Transforms a normalized format into a localized money string.
* *
* @param number $value Normalized number * @param number $value Normalized number
* *
* @return string Localized money string. * @return string Localized money string.
* *

View File

@ -56,7 +56,7 @@ class NumberToLocalizedStringTransformer implements DataTransformerInterface
/** /**
* Transforms a number type into localized number. * Transforms a number type into localized number.
* *
* @param integer|float $value Number value. * @param integer|float $value Number value.
* *
* @return string Localized value. * @return string Localized value.
* *

View File

@ -64,7 +64,7 @@ class PercentToLocalizedStringTransformer implements DataTransformerInterface
/** /**
* Transforms between a normalized format (integer or float) into a percentage value. * Transforms between a normalized format (integer or float) into a percentage value.
* *
* @param number $value Normalized value * @param number $value Normalized value
* *
* @return number Percentage value * @return number Percentage value
* *
@ -99,7 +99,7 @@ class PercentToLocalizedStringTransformer implements DataTransformerInterface
/** /**
* Transforms between a percentage value into a normalized format (integer or float). * Transforms between a percentage value into a normalized format (integer or float).
* *
* @param number $value Percentage value. * @param number $value Percentage value.
* *
* @return number Normalized value. * @return number Normalized value.
* *

View File

@ -39,7 +39,7 @@ class ScalarToBooleanChoicesTransformer implements DataTransformerInterface
* depending on whether a given option is selected. If this field is rendered * depending on whether a given option is selected. If this field is rendered
* as select tag, the value is not modified. * as select tag, the value is not modified.
* *
* @param mixed $value An array if "multiple" is set to true, a scalar * @param mixed $value An array if "multiple" is set to true, a scalar
* value otherwise. * value otherwise.
* *
* @return mixed An array * @return mixed An array
@ -74,7 +74,7 @@ class ScalarToBooleanChoicesTransformer implements DataTransformerInterface
* values, depending on whether a given choice is selected. The output * values, depending on whether a given choice is selected. The output
* is the selected choice. * is the selected choice.
* *
* @param array $value An array of values * @param array $value An array of values
* *
* @return mixed $value A scalar value * @return mixed $value A scalar value
* *

View File

@ -41,7 +41,7 @@ interface CsrfProviderInterface
* Validates a CSRF token. * Validates a CSRF token.
* *
* @param string $intention The intention used when generating the CSRF token * @param string $intention The intention used when generating the CSRF token
* @param string $token The token supplied by the browser * @param string $token The token supplied by the browser
* *
* @return Boolean Whether the token supplied by the browser is correct * @return Boolean Whether the token supplied by the browser is correct
*/ */

View File

@ -33,7 +33,7 @@ class DefaultCsrfProvider implements CsrfProviderInterface
* A recommended value for the secret is a generated value with at least * A recommended value for the secret is a generated value with at least
* 32 characters and mixed letters, digits and special characters. * 32 characters and mixed letters, digits and special characters.
* *
* @param string $secret A secret value included in the CSRF token * @param string $secret A secret value included in the CSRF token
*/ */
public function __construct($secret) public function __construct($secret)
{ {

View File

@ -32,8 +32,8 @@ class FormTypeCsrfExtension extends AbstractTypeExtension
/** /**
* Adds a CSRF field to the form when the CSRF protection is enabled. * Adds a CSRF field to the form when the CSRF protection is enabled.
* *
* @param FormBuilder $builder The form builder * @param FormBuilder $builder The form builder
* @param array $options The options * @param array $options The options
*/ */
public function buildForm(FormBuilder $builder, array $options) public function buildForm(FormBuilder $builder, array $options)
{ {

View File

@ -78,7 +78,7 @@ class ValidatorTypeGuesser implements FormTypeGuesserInterface
/** /**
* Guesses a field class name for a given constraint * Guesses a field class name for a given constraint
* *
* @param Constraint $constraint The constraint to guess for * @param Constraint $constraint The constraint to guess for
* *
* @return TypeGuess The guessed field class and options * @return TypeGuess The guessed field class and options
*/ */
@ -227,7 +227,7 @@ class ValidatorTypeGuesser implements FormTypeGuesserInterface
/** /**
* Guesses whether a field is required based on the given constraint * Guesses whether a field is required based on the given constraint
* *
* @param Constraint $constraint The constraint to guess for * @param Constraint $constraint The constraint to guess for
* *
* @return Guess The guess whether the field is required * @return Guess The guess whether the field is required
*/ */
@ -255,7 +255,7 @@ class ValidatorTypeGuesser implements FormTypeGuesserInterface
/** /**
* Guesses a field's maximum length based on the given constraint * Guesses a field's maximum length based on the given constraint
* *
* @param Constraint $constraint The constraint to guess for * @param Constraint $constraint The constraint to guess for
* *
* @return Guess The guess for the maximum length * @return Guess The guess for the maximum length
*/ */
@ -278,7 +278,7 @@ class ValidatorTypeGuesser implements FormTypeGuesserInterface
/** /**
* Guesses a field's minimum length based on the given constraint * Guesses a field's minimum length based on the given constraint
* *
* @param Constraint $constraint The constraint to guess for * @param Constraint $constraint The constraint to guess for
* *
* @return Guess The guess for the minimum length * @return Guess The guess for the minimum length
*/ */
@ -302,9 +302,9 @@ class ValidatorTypeGuesser implements FormTypeGuesserInterface
* Iterates over the constraints of a property, executes a constraints on * Iterates over the constraints of a property, executes a constraints on
* them and returns the best guess * them and returns the best guess
* *
* @param string $class The class to read the constraints from * @param string $class The class to read the constraints from
* @param string $property The property for which to find constraints * @param string $property The property for which to find constraints
* @param \Closure $guessForConstraint The closure that returns a guess * @param \Closure $guessForConstraint The closure that returns a guess
* for a given constraint * for a given constraint
* @return Guess The guessed value with the highest confidence * @return Guess The guessed value with the highest confidence
*/ */

View File

@ -565,7 +565,7 @@ class Form implements \IteratorAggregate, FormInterface
* If the request method is POST, PUT or GET, the data is bound to the form, * If the request method is POST, PUT or GET, the data is bound to the form,
* transformed and written into the form data (an object or an array). * transformed and written into the form data (an object or an array).
* *
* @param Request $request The request to bind to the form * @param Request $request The request to bind to the form
* *
* @return Form This form * @return Form This form
* *
@ -856,8 +856,8 @@ class Form implements \IteratorAggregate, FormInterface
/** /**
* Adds a child to the form (implements the \ArrayAccess interface). * Adds a child to the form (implements the \ArrayAccess interface).
* *
* @param string $name Ignored. The name of the child is used. * @param string $name Ignored. The name of the child is used.
* @param FormInterface $child The child to be added * @param FormInterface $child The child to be added
*/ */
public function offsetSet($name, $child) public function offsetSet($name, $child)
{ {
@ -867,7 +867,7 @@ class Form implements \IteratorAggregate, FormInterface
/** /**
* Removes the child with the given name from the form (implements the \ArrayAccess interface). * Removes the child with the given name from the form (implements the \ArrayAccess interface).
* *
* @param string $name The name of the child to be removed * @param string $name The name of the child to be removed
*/ */
public function offsetUnset($name) public function offsetUnset($name)
{ {
@ -943,7 +943,7 @@ class Form implements \IteratorAggregate, FormInterface
/** /**
* Normalizes the value if a normalization transformer is set. * Normalizes the value if a normalization transformer is set.
* *
* @param mixed $value The value to transform * @param mixed $value The value to transform
* *
* @return string * @return string
*/ */
@ -959,7 +959,7 @@ class Form implements \IteratorAggregate, FormInterface
/** /**
* Reverse transforms a value if a normalization transformer is set. * Reverse transforms a value if a normalization transformer is set.
* *
* @param string $value The value to reverse transform * @param string $value The value to reverse transform
* *
* @return mixed * @return mixed
*/ */
@ -975,7 +975,7 @@ class Form implements \IteratorAggregate, FormInterface
/** /**
* Transforms the value if a value transformer is set. * Transforms the value if a value transformer is set.
* *
* @param mixed $value The value to transform * @param mixed $value The value to transform
* *
* @return string * @return string
*/ */
@ -997,7 +997,7 @@ class Form implements \IteratorAggregate, FormInterface
/** /**
* Reverse transforms a value if a value transformer is set. * Reverse transforms a value if a value transformer is set.
* *
* @param string $value The value to reverse transform * @param string $value The value to reverse transform
* *
* @return mixed * @return mixed
*/ */

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