Merge branch '2.7' into 2.8

* 2.7:
  removed dots at the end of @param and @return
  fixed typo
This commit is contained in:
Fabien Potencier 2016-06-29 07:29:29 +02:00
commit bd1e3e3093
224 changed files with 960 additions and 961 deletions

View File

@ -69,9 +69,9 @@ class ContainerAwareEventManager extends EventManager
/** /**
* Gets the listeners of a specific event or all listeners. * Gets the listeners of a specific event or all listeners.
* *
* @param string $event The name of the event. * @param string $event The name of the event
* *
* @return array The event listeners for the specified event, or all event listeners. * @return array The event listeners for the specified event, or all event listeners
*/ */
public function getListeners($event = null) public function getListeners($event = null)
{ {
@ -83,7 +83,7 @@ class ContainerAwareEventManager extends EventManager
* *
* @param string $event * @param string $event
* *
* @return bool TRUE if the specified event has any listeners, FALSE otherwise. * @return bool TRUE if the specified event has any listeners, FALSE otherwise
*/ */
public function hasListeners($event) public function hasListeners($event)
{ {
@ -93,8 +93,8 @@ class ContainerAwareEventManager extends EventManager
/** /**
* Adds an event listener that listens on the specified events. * Adds an event listener that listens on the specified events.
* *
* @param string|array $events The event(s) to listen on. * @param string|array $events The event(s) to listen on
* @param object|string $listener The listener object. * @param object|string $listener The listener object
* *
* @throws \RuntimeException * @throws \RuntimeException
*/ */

View File

@ -40,7 +40,7 @@ abstract class AbstractDoctrineExtension extends Extension
protected $drivers = array(); protected $drivers = array();
/** /**
* @param array $objectManager A configured object manager. * @param array $objectManager A configured object manager
* @param ContainerBuilder $container A ContainerBuilder instance * @param ContainerBuilder $container A ContainerBuilder instance
* *
* @throws \InvalidArgumentException * @throws \InvalidArgumentException
@ -300,8 +300,8 @@ abstract class AbstractDoctrineExtension extends Extension
/** /**
* Loads a configured object manager metadata, query or result cache driver. * Loads a configured object manager metadata, query or result cache driver.
* *
* @param array $objectManager A configured object manager. * @param array $objectManager A configured object manager
* @param ContainerBuilder $container A ContainerBuilder instance. * @param ContainerBuilder $container A ContainerBuilder instance
* @param string $cacheName * @param string $cacheName
* *
* @throws \InvalidArgumentException In case of unknown driver type. * @throws \InvalidArgumentException In case of unknown driver type.
@ -314,10 +314,10 @@ abstract class AbstractDoctrineExtension extends Extension
/** /**
* Loads a cache driver. * Loads a cache driver.
* *
* @param string $cacheDriverServiceId The cache driver name. * @param string $cacheDriverServiceId The cache driver name
* @param string $objectManagerName The object manager name. * @param string $objectManagerName The object manager name
* @param array $cacheDriver The cache driver mapping. * @param array $cacheDriver The cache driver mapping
* @param \Symfony\Component\DependencyInjection\ContainerBuilder $container The ContainerBuilder instance. * @param \Symfony\Component\DependencyInjection\ContainerBuilder $container The ContainerBuilder instance
* *
* @return string * @return string
* *
@ -403,12 +403,12 @@ abstract class AbstractDoctrineExtension extends Extension
/** /**
* Returns a modified version of $managerConfigs. * Returns a modified version of $managerConfigs.
* *
* The manager called $autoMappedManager will map all bundles that are not mepped by other managers. * The manager called $autoMappedManager will map all bundles that are not mapped by other managers.
* *
* @param array $managerConfigs * @param array $managerConfigs
* @param array $bundles * @param array $bundles
* *
* @return array The modified version of $managerConfigs. * @return array The modified version of $managerConfigs
*/ */
protected function fixManagersAutoMappings(array $managerConfigs, array $bundles) protected function fixManagersAutoMappings(array $managerConfigs, array $bundles)
{ {

View File

@ -106,18 +106,18 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
* The $aliasMap parameter can be used to define bundle namespace shortcuts like the * The $aliasMap parameter can be used to define bundle namespace shortcuts like the
* DoctrineBundle provides automatically for objects in the default Entity/Document folder. * DoctrineBundle provides automatically for objects in the default Entity/Document folder.
* *
* @param Definition|Reference $driver Driver DI definition or reference. * @param Definition|Reference $driver Driver DI definition or reference
* @param string[] $namespaces List of namespaces handled by $driver. * @param string[] $namespaces List of namespaces handled by $driver
* @param string[] $managerParameters List of container parameters that could * @param string[] $managerParameters List of container parameters that could
* hold the manager name. * hold the manager name.
* @param string $driverPattern Pattern for the metadata driver service name. * @param string $driverPattern Pattern for the metadata driver service name
* @param string $enabledParameter Service container parameter that must be * @param string $enabledParameter Service container parameter that must be
* present to enable the mapping. Set to false * present to enable the mapping. Set to false
* to not do any check, optional. * to not do any check, optional.
* @param string $configurationPattern Pattern for the Configuration service name. * @param string $configurationPattern Pattern for the Configuration service name
* @param string $registerAliasMethodName Name of Configuration class method to * @param string $registerAliasMethodName Name of Configuration class method to
* register alias. * register alias.
* @param string[] $aliasMap Map of alias to namespace. * @param string[] $aliasMap Map of alias to namespace
* *
* @since Support for bundle alias was added in Symfony 2.6 * @since Support for bundle alias was added in Symfony 2.6
*/ */
@ -219,7 +219,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
* *
* @param ContainerBuilder $container * @param ContainerBuilder $container
* *
* @return string The name of the active manager. * @return string The name of the active manager
* *
* @throws ParameterNotFoundException If none of the managerParameters is found in the container. * @throws ParameterNotFoundException If none of the managerParameters is found in the container.
*/ */

View File

@ -109,7 +109,7 @@ class EntityChoiceList extends ObjectChoiceList
* @param string $groupPath A property path pointing to the property used * @param string $groupPath A property path pointing to the property used
* to group the choices. Only allowed if * to group the choices. Only allowed if
* the choices are given as flat array. * the choices are given as flat array.
* @param PropertyAccessorInterface $propertyAccessor The reflection graph for reading property paths. * @param PropertyAccessorInterface $propertyAccessor The reflection graph for reading property paths
*/ */
public function __construct(ObjectManager $manager, $class, $labelPath = null, EntityLoaderInterface $entityLoader = null, $entities = null, array $preferredEntities = array(), $groupPath = null, PropertyAccessorInterface $propertyAccessor = null) public function __construct(ObjectManager $manager, $class, $labelPath = null, EntityLoaderInterface $entityLoader = null, $entities = null, array $preferredEntities = array(), $groupPath = null, PropertyAccessorInterface $propertyAccessor = null)
{ {
@ -410,7 +410,7 @@ class EntityChoiceList extends ObjectChoiceList
* *
* @param mixed $entity The choice to create a value for * @param mixed $entity The choice to create a value for
* *
* @return int|string A unique value without character limitations. * @return int|string A unique value without character limitations
*/ */
protected function createValue($entity) protected function createValue($entity)
{ {

View File

@ -21,7 +21,7 @@ interface EntityLoaderInterface
/** /**
* Returns an array of entities that are valid choices in the corresponding choice list. * Returns an array of entities that are valid choices in the corresponding choice list.
* *
* @return array The entities. * @return array The entities
*/ */
public function getEntities(); public function getEntities();
@ -31,9 +31,9 @@ interface EntityLoaderInterface
* @param string $identifier The identifier field of the object. This method * @param string $identifier The identifier field of the object. This method
* is not applicable for fields with multiple * is not applicable for fields with multiple
* identifiers. * identifiers.
* @param array $values The values of the identifiers. * @param array $values The values of the identifiers
* *
* @return array The entities. * @return array The entities
*/ */
public function getEntitiesByIds($identifier, array $values); public function getEntitiesByIds($identifier, array $values);
} }

View File

@ -105,9 +105,9 @@ class IdReader
* *
* This method assumes that the object has a single-column ID. * This method assumes that the object has a single-column ID.
* *
* @param object $object The object. * @param object $object The object
* *
* @return mixed The ID value. * @return mixed The ID value
*/ */
public function getIdValue($object) public function getIdValue($object)
{ {
@ -138,7 +138,7 @@ class IdReader
* *
* This method assumes that the object has a single-column ID. * This method assumes that the object has a single-column ID.
* *
* @return string The name of the ID field. * @return string The name of the ID field
*/ */
public function getIdField() public function getIdField()
{ {

View File

@ -43,8 +43,8 @@ class ORMQueryBuilderLoader implements EntityLoaderInterface
* deprecated and will not be * deprecated and will not be
* supported anymore as of * supported anymore as of
* Symfony 3.0. * Symfony 3.0.
* @param ObjectManager $manager Deprecated. * @param ObjectManager $manager Deprecated
* @param string $class Deprecated. * @param string $class Deprecated
* *
* @throws UnexpectedTypeException * @throws UnexpectedTypeException
*/ */

View File

@ -56,9 +56,9 @@ abstract class DoctrineType extends AbstractType
* *
* For backwards compatibility, objects are cast to strings by default. * For backwards compatibility, objects are cast to strings by default.
* *
* @param object $choice The object. * @param object $choice The object
* *
* @return string The string representation of the object. * @return string The string representation of the object
* *
* @internal This method is public to be usable as callback. It should not * @internal This method is public to be usable as callback. It should not
* be used in user code. * be used in user code.
@ -75,12 +75,12 @@ abstract class DoctrineType extends AbstractType
* a single-column integer ID. In that case, the value of the field is * a single-column integer ID. In that case, the value of the field is
* the ID of the object. That ID is also used as field name. * the ID of the object. That ID is also used as field name.
* *
* @param object $choice The object. * @param object $choice The object
* @param int|string $key The choice key. * @param int|string $key The choice key
* @param string $value The choice value. Corresponds to the object's * @param string $value The choice value. Corresponds to the object's
* ID here. * ID here.
* *
* @return string The field name. * @return string The field name
* *
* @internal This method is public to be usable as callback. It should not * @internal This method is public to be usable as callback. It should not
* be used in user code. * be used in user code.

View File

@ -168,7 +168,7 @@ class ConsoleHandler extends AbstractProcessingHandler implements EventSubscribe
/** /**
* Updates the logging level based on the verbosity setting of the console output. * Updates the logging level based on the verbosity setting of the console output.
* *
* @return bool Whether the handler is enabled and verbosity is not set to quiet. * @return bool Whether the handler is enabled and verbosity is not set to quiet
*/ */
private function updateLevel() private function updateLevel()
{ {

View File

@ -38,7 +38,7 @@ class LazyServiceProjectServiceContainer extends Container
* *
* @param bool $lazyLoad whether to try lazy-loading the service with a proxy * @param bool $lazyLoad whether to try lazy-loading the service with a proxy
* *
* @return stdClass A stdClass instance. * @return stdClass A stdClass instance
*/ */
public function getFooService($lazyLoad = true) public function getFooService($lazyLoad = true)
{ {

View File

@ -33,7 +33,7 @@ class LazyServiceProjectServiceContainer extends Container
* *
* @param bool $lazyLoad whether to try lazy-loading the service with a proxy * @param bool $lazyLoad whether to try lazy-loading the service with a proxy
* *
* @return stdClass A stdClass instance. * @return stdClass A stdClass instance
*/ */
public function getFooService($lazyLoad = true) public function getFooService($lazyLoad = true)
{ {

View File

@ -97,9 +97,9 @@ class FormExtension extends \Twig_Extension implements \Twig_Extension_InitRunti
/** /**
* Renders a CSRF token. * Renders a CSRF token.
* *
* @param string $intention The intention of the protected action. * @param string $intention The intention of the protected action
* *
* @return string A CSRF token. * @return string A CSRF token
*/ */
public function renderCsrfToken($intention) public function renderCsrfToken($intention)
{ {
@ -109,9 +109,9 @@ class FormExtension extends \Twig_Extension implements \Twig_Extension_InitRunti
/** /**
* Makes a technical name human readable. * Makes a technical name human readable.
* *
* @param string $text The text to humanize. * @param string $text The text to humanize
* *
* @return string The humanized text. * @return string The humanized text
*/ */
public function humanize($text) public function humanize($text)
{ {
@ -134,10 +134,10 @@ class FormExtension extends \Twig_Extension implements \Twig_Extension_InitRunti
* seems to be much more efficient at executing filters than at executing * seems to be much more efficient at executing filters than at executing
* methods of an object. * methods of an object.
* *
* @param ChoiceView $choice The choice to check. * @param ChoiceView $choice The choice to check
* @param string|array $selectedValue The selected value to compare. * @param string|array $selectedValue The selected value to compare
* *
* @return bool Whether the choice is selected. * @return bool Whether the choice is selected
* *
* @see ChoiceView::isSelected() * @see ChoiceView::isSelected()
*/ */

View File

@ -70,11 +70,11 @@ class TwigRendererEngine extends AbstractRendererEngine implements TwigRendererE
* *
* @see getResourceForBlock() * @see getResourceForBlock()
* *
* @param string $cacheKey The cache key of the form view. * @param string $cacheKey The cache key of the form view
* @param FormView $view The form view for finding the applying themes. * @param FormView $view The form view for finding the applying themes
* @param string $blockName The name of the block to load. * @param string $blockName The name of the block to load
* *
* @return bool True if the resource could be loaded, false otherwise. * @return bool True if the resource could be loaded, false otherwise
*/ */
protected function loadResourceForBlockName($cacheKey, FormView $view, $blockName) protected function loadResourceForBlockName($cacheKey, FormView $view, $blockName)
{ {
@ -141,7 +141,7 @@ class TwigRendererEngine extends AbstractRendererEngine implements TwigRendererE
/** /**
* Loads the resources for all blocks in a theme. * Loads the resources for all blocks in a theme.
* *
* @param string $cacheKey The cache key for storing the resource. * @param string $cacheKey The cache key for storing the resource
* @param mixed $theme The theme to load the block from. This parameter * @param mixed $theme The theme to load the block from. This parameter
* is passed by reference, because it might be necessary * is passed by reference, because it might be necessary
* to initialize the theme first. Any changes made to * to initialize the theme first. Any changes made to

View File

@ -21,7 +21,7 @@ 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)
* *

View File

@ -223,9 +223,9 @@ class FormHelper extends Helper
/** /**
* Renders a block of the template. * Renders a block of the template.
* *
* @param FormView $view The view for determining the used themes. * @param FormView $view The view for determining the used themes
* @param string $blockName The name of the block to render. * @param string $blockName The name of the block to render
* @param array $variables The variable to pass to the template. * @param array $variables The variable to pass to the template
* *
* @return string The HTML markup * @return string The HTML markup
*/ */

View File

@ -150,7 +150,7 @@ class SecurityDataCollector extends DataCollector
* Checks if the data contains information about inherited roles. Still the inherited * Checks if the data contains information about inherited roles. Still the inherited
* roles can be an empty array. * roles can be an empty array.
* *
* @return bool true if the profile was contains inherited role information. * @return bool true if the profile was contains inherited role information
*/ */
public function supportsRoleHierarchy() public function supportsRoleHierarchy()
{ {

View File

@ -28,7 +28,7 @@ class ExceptionController
protected $twig; protected $twig;
/** /**
* @var bool Show error (false) or exception (true) pages by default. * @var bool Show error (false) or exception (true) pages by default
*/ */
protected $debug; protected $debug;

View File

@ -160,7 +160,7 @@
/** /**
* Query an element with a CSS selector. * Query an element with a CSS selector.
* *
* @param string selector a CSS-selector-compatible query string. * @param string selector a CSS-selector-compatible query string
* *
* @return DOMElement|null * @return DOMElement|null
*/ */
@ -187,7 +187,7 @@
/** /**
* Check whether this event is a child event. * Check whether this event is a child event.
* *
* @return true if it is. * @return true if it is
*/ */
function isChildEvent(event) function isChildEvent(event)
{ {
@ -197,7 +197,7 @@
/** /**
* Check whether this event is categorized in 'section'. * Check whether this event is categorized in 'section'.
* *
* @return true if it is. * @return true if it is
*/ */
function isSectionEvent(event) function isSectionEvent(event)
{ {
@ -217,8 +217,8 @@
* *
* @param request the request object * @param request the request object
* @param max <subjected for removal> * @param max <subjected for removal>
* @param threshold the threshold (lower bound) of the length of the timeline (in milliseconds). * @param threshold the threshold (lower bound) of the length of the timeline (in milliseconds)
* @param width the width of the canvas. * @param width the width of the canvas
*/ */
this.drawOne = function(request, max, threshold, width) this.drawOne = function(request, max, threshold, width)
{ {

View File

@ -111,7 +111,7 @@ class Request
/** /**
* Gets the request raw body data. * Gets the request raw body data.
* *
* @return string The request raw body data. * @return string The request raw body data
*/ */
public function getContent() public function getContent()
{ {

View File

@ -59,8 +59,8 @@ class ApcClassLoader
/** /**
* Constructor. * Constructor.
* *
* @param string $prefix The APC namespace prefix to use. * @param string $prefix The APC namespace prefix to use
* @param object $decorated A class loader object that implements the findFile() method. * @param object $decorated A class loader object that implements the findFile() method
* *
* @throws \RuntimeException * @throws \RuntimeException
* @throws \InvalidArgumentException * @throws \InvalidArgumentException

View File

@ -60,8 +60,8 @@ class WinCacheClassLoader
/** /**
* Constructor. * Constructor.
* *
* @param string $prefix The WinCache namespace prefix to use. * @param string $prefix The WinCache namespace prefix to use
* @param object $decorated A class loader object that implements the findFile() method. * @param object $decorated A class loader object that implements the findFile() method
* *
* @throws \RuntimeException * @throws \RuntimeException
* @throws \InvalidArgumentException * @throws \InvalidArgumentException

View File

@ -60,8 +60,8 @@ class XcacheClassLoader
/** /**
* Constructor. * Constructor.
* *
* @param string $prefix The XCache namespace prefix to use. * @param string $prefix The XCache namespace prefix to use
* @param object $decorated A class loader object that implements the findFile() method. * @param object $decorated A class loader object that implements the findFile() method
* *
* @throws \RuntimeException * @throws \RuntimeException
* @throws \InvalidArgumentException * @throws \InvalidArgumentException

View File

@ -32,7 +32,7 @@ interface ConfigCacheInterface
* *
* This check should take the metadata passed to the write() method into consideration. * This check should take the metadata passed to the write() method into consideration.
* *
* @return bool Whether the cache is still fresh. * @return bool Whether the cache is still fresh
*/ */
public function isFresh(); public function isFresh();

View File

@ -349,8 +349,8 @@ 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

@ -184,7 +184,7 @@ abstract class BaseNode implements NodeInterface
/** /**
* Returns the name of this node. * Returns the name of this node.
* *
* @return string The Node's name. * @return string The Node's name
*/ */
public function getName() public function getName()
{ {
@ -237,9 +237,9 @@ abstract class BaseNode implements NodeInterface
/** /**
* Normalizes a value, applying all normalization closures. * Normalizes a value, applying all normalization closures.
* *
* @param mixed $value Value to normalize. * @param mixed $value Value to normalize
* *
* @return mixed The normalized value. * @return mixed The normalized value
*/ */
final public function normalize($value) final public function normalize($value)
{ {
@ -329,7 +329,7 @@ abstract class BaseNode implements NodeInterface
/** /**
* Normalizes the value. * Normalizes the value.
* *
* @param mixed $value The value to normalize. * @param mixed $value The value to normalize
* *
* @return mixed The normalized value * @return mixed The normalized value
*/ */

View File

@ -178,7 +178,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
* This method is applicable to prototype nodes only. * This method is applicable to prototype nodes only.
* *
* @param string $name The name of the key * @param string $name The name of the key
* @param bool $removeKeyItem Whether or not the key item should be removed. * @param bool $removeKeyItem Whether or not the key item should be removed
* *
* @return ArrayNodeDefinition * @return ArrayNodeDefinition
*/ */

View File

@ -278,8 +278,8 @@ 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

@ -57,7 +57,7 @@ class VariableNode extends BaseNode implements PrototypeNodeInterface
/** /**
* Sets if this node is allowed to have an empty value. * Sets if this node is allowed to have an empty value.
* *
* @param bool $boolean True if this entity will accept empty values. * @param bool $boolean True if this entity will accept empty values
*/ */
public function setAllowEmptyValue($boolean) public function setAllowEmptyValue($boolean)
{ {

View File

@ -238,7 +238,7 @@ class Application
/** /**
* Gets the help message. * Gets the help message.
* *
* @return string A help message. * @return string A help message
*/ */
public function getHelp() public function getHelp()
{ {

View File

@ -30,7 +30,7 @@ class HelperSet implements \IteratorAggregate
/** /**
* Constructor. * Constructor.
* *
* @param Helper[] $helpers An array of helper. * @param Helper[] $helpers An array of helper
*/ */
public function __construct(array $helpers = array()) public function __construct(array $helpers = array())
{ {

View File

@ -93,7 +93,7 @@ class ArgvInput extends Input
/** /**
* Parses a short option. * Parses a short option.
* *
* @param string $token The current token. * @param string $token The current token
*/ */
private function parseShortOption($token) private function parseShortOption($token)
{ {

View File

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

View File

@ -32,7 +32,7 @@ class CommandTester
/** /**
* Constructor. * Constructor.
* *
* @param Command $command A Command instance to test. * @param Command $command A Command instance to test
*/ */
public function __construct(Command $command) public function __construct(Command $command)
{ {

View File

@ -68,8 +68,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
*/ */

View File

@ -380,7 +380,7 @@ class ErrorHandler
* @param int $line * @param int $line
* @param array $context * @param array $context
* *
* @return bool Returns false when no handling happens so that the PHP engine can handle the error itself. * @return bool Returns false when no handling happens so that the PHP engine can handle the error itself
* *
* @throws \ErrorException When $this->thrownErrors requests so * @throws \ErrorException When $this->thrownErrors requests so
* *

View File

@ -96,7 +96,7 @@ class ExceptionHandler
* *
* @param string $format The format for links to source files * @param string $format The format for links to source files
* *
* @return string The previous file link format. * @return string The previous file link format
*/ */
public function setFileLinkFormat($format) public function setFileLinkFormat($format)
{ {

View File

@ -18,7 +18,7 @@ use Symfony\Component\Debug\Exception\ContextErrorException;
class DebugClassLoaderTest extends \PHPUnit_Framework_TestCase class DebugClassLoaderTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* @var int Error reporting level before running tests. * @var int Error reporting level before running tests
*/ */
private $errorReporting; private $errorReporting;

View File

@ -126,7 +126,7 @@ class AnalyzeServiceReferencesPass implements RepeatablePassInterface
/** /**
* Returns a service definition given the full name or an alias. * Returns a service definition given the full name or an alias.
* *
* @param string $id A full id or alias for a service definition. * @param string $id A full id or alias for a service definition
* *
* @return Definition|null The definition related to the supplied id * @return Definition|null The definition related to the supplied id
*/ */

View File

@ -354,7 +354,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/** /**
* Returns all Scope children. * Returns all Scope children.
* *
* @return array An array of scope children. * @return array An array of scope children
* *
* @deprecated since version 2.8, to be removed in 3.0. * @deprecated since version 2.8, to be removed in 3.0.
*/ */
@ -510,7 +510,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
* parameter, the value will still be 'bar' as defined in the ContainerBuilder * parameter, the value will still be 'bar' as defined in the ContainerBuilder
* constructor. * constructor.
* *
* @param ContainerBuilder $container The ContainerBuilder instance to merge. * @param ContainerBuilder $container The ContainerBuilder instance to merge
* *
* @throws BadMethodCallException When this ContainerBuilder is frozen * @throws BadMethodCallException When this ContainerBuilder is frozen
*/ */
@ -1011,7 +1011,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
* *
* @param string $name The tag name * @param string $name The tag name
* *
* @return array An array of tags with the tagged service as key, holding a list of attribute arrays. * @return array An array of tags with the tagged service as key, holding a list of attribute arrays
*/ */
public function findTaggedServiceIds($name) public function findTaggedServiceIds($name)
{ {
@ -1067,7 +1067,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/** /**
* Returns the Service Conditionals. * Returns the Service Conditionals.
* *
* @param mixed $value An array of conditionals to return. * @param mixed $value An array of conditionals to return
* *
* @return array An array of Service conditionals * @return array An array of Service conditionals
*/ */

View File

@ -25,7 +25,7 @@ class DefinitionDecorator extends Definition
private $changes = array(); private $changes = array();
/** /**
* @param string $parent The id of Definition instance to decorate. * @param string $parent The id of Definition instance to decorate
*/ */
public function __construct($parent) public function __construct($parent)
{ {

View File

@ -570,22 +570,22 @@ class PhpDumper extends Dumper
if ($definition->isSynthetic()) { if ($definition->isSynthetic()) {
$return[] = '@throws RuntimeException always since this service is expected to be injected dynamically'; $return[] = '@throws RuntimeException always since this service is expected to be injected dynamically';
} elseif ($class = $definition->getClass()) { } elseif ($class = $definition->getClass()) {
$return[] = sprintf('@return %s A %s instance.', 0 === strpos($class, '%') ? 'object' : '\\'.ltrim($class, '\\'), ltrim($class, '\\')); $return[] = sprintf('@return %s A %s instance', 0 === strpos($class, '%') ? 'object' : '\\'.ltrim($class, '\\'), ltrim($class, '\\'));
} elseif ($definition->getFactory()) { } elseif ($definition->getFactory()) {
$factory = $definition->getFactory(); $factory = $definition->getFactory();
if (is_string($factory)) { if (is_string($factory)) {
$return[] = sprintf('@return object An instance returned by %s().', $factory); $return[] = sprintf('@return object An instance returned by %s()', $factory);
} elseif (is_array($factory) && (is_string($factory[0]) || $factory[0] instanceof Definition || $factory[0] instanceof Reference)) { } elseif (is_array($factory) && (is_string($factory[0]) || $factory[0] instanceof Definition || $factory[0] instanceof Reference)) {
if (is_string($factory[0]) || $factory[0] instanceof Reference) { if (is_string($factory[0]) || $factory[0] instanceof Reference) {
$return[] = sprintf('@return object An instance returned by %s::%s().', (string) $factory[0], $factory[1]); $return[] = sprintf('@return object An instance returned by %s::%s()', (string) $factory[0], $factory[1]);
} elseif ($factory[0] instanceof Definition) { } elseif ($factory[0] instanceof Definition) {
$return[] = sprintf('@return object An instance returned by %s::%s().', $factory[0]->getClass(), $factory[1]); $return[] = sprintf('@return object An instance returned by %s::%s()', $factory[0]->getClass(), $factory[1]);
} }
} }
} elseif ($definition->getFactoryClass(false)) { } elseif ($definition->getFactoryClass(false)) {
$return[] = sprintf('@return object An instance returned by %s::%s().', $definition->getFactoryClass(false), $definition->getFactoryMethod(false)); $return[] = sprintf('@return object An instance returned by %s::%s()', $definition->getFactoryClass(false), $definition->getFactoryMethod(false));
} elseif ($definition->getFactoryService(false)) { } elseif ($definition->getFactoryService(false)) {
$return[] = sprintf('@return object An instance returned by %s::%s().', $definition->getFactoryService(false), $definition->getFactoryMethod(false)); $return[] = sprintf('@return object An instance returned by %s::%s()', $definition->getFactoryService(false), $definition->getFactoryMethod(false));
} }
$scope = $definition->getScope(false); $scope = $definition->getScope(false);

View File

@ -52,7 +52,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \stdClass A stdClass instance. * @return \stdClass A stdClass instance
*/ */
protected function getTestService() protected function getTestService()
{ {

View File

@ -56,7 +56,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \stdClass A stdClass instance. * @return \stdClass A stdClass instance
*/ */
protected function getTestService() protected function getTestService()
{ {

View File

@ -50,7 +50,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \stdClass A stdClass instance. * @return \stdClass A stdClass instance
*/ */
protected function getBarService() protected function getBarService()
{ {

View File

@ -37,7 +37,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar\FooClass A Bar\FooClass instance. * @return \Bar\FooClass A Bar\FooClass instance
*/ */
protected function getServiceFromAnonymousFactoryService() protected function getServiceFromAnonymousFactoryService()
{ {
@ -50,7 +50,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar\FooClass A Bar\FooClass instance. * @return \Bar\FooClass A Bar\FooClass instance
*/ */
protected function getServiceWithMethodCallAndFactoryService() protected function getServiceWithMethodCallAndFactoryService()
{ {

View File

@ -37,7 +37,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \stdClass A stdClass instance. * @return \stdClass A stdClass instance
*/ */
protected function getDependsOnRequestService() protected function getDependsOnRequestService()
{ {
@ -54,7 +54,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Request A Request instance. * @return \Request A Request instance
*/ */
protected function getRequestService() protected function getRequestService()
{ {

View File

@ -58,7 +58,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar\FooClass A Bar\FooClass instance. * @return \Bar\FooClass A Bar\FooClass instance
*/ */
protected function getBarService() protected function getBarService()
{ {
@ -77,7 +77,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Baz A Baz instance. * @return \Baz A Baz instance
*/ */
protected function getBazService() protected function getBazService()
{ {
@ -94,7 +94,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \stdClass A stdClass instance. * @return \stdClass A stdClass instance
*/ */
protected function getConfiguredServiceService() protected function getConfiguredServiceService()
{ {
@ -111,7 +111,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \stdClass A stdClass instance. * @return \stdClass A stdClass instance
*/ */
protected function getDecoratedService() protected function getDecoratedService()
{ {
@ -124,7 +124,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \stdClass A stdClass instance. * @return \stdClass A stdClass instance
*/ */
protected function getDecoratorServiceService() protected function getDecoratorServiceService()
{ {
@ -137,7 +137,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \stdClass A stdClass instance. * @return \stdClass A stdClass instance
*/ */
protected function getDecoratorServiceWithNameService() protected function getDecoratorServiceWithNameService()
{ {
@ -167,7 +167,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar A Bar instance. * @return \Bar A Bar instance
*/ */
protected function getFactoryServiceService() protected function getFactoryServiceService()
{ {
@ -180,7 +180,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar\FooClass A Bar\FooClass instance. * @return \Bar\FooClass A Bar\FooClass instance
*/ */
protected function getFooService() protected function getFooService()
{ {
@ -204,7 +204,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return object A %baz_class% instance. * @return object A %baz_class% instance
*/ */
protected function getFoo_BazService() protected function getFoo_BazService()
{ {
@ -218,7 +218,7 @@ class ProjectServiceContainer extends Container
/** /**
* Gets the 'foo_bar' service. * Gets the 'foo_bar' service.
* *
* @return object A %foo_class% instance. * @return object A %foo_class% instance
*/ */
protected function getFooBarService() protected function getFooBarService()
{ {
@ -233,7 +233,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Foo A Foo instance. * @return \Foo A Foo instance
*/ */
protected function getFooWithInlineService() protected function getFooWithInlineService()
{ {
@ -250,7 +250,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar\FooClass A Bar\FooClass instance. * @return \Bar\FooClass A Bar\FooClass instance
*/ */
protected function getMethodCall1Service() protected function getMethodCall1Service()
{ {
@ -277,7 +277,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \FooBarBaz A FooBarBaz instance. * @return \FooBarBaz A FooBarBaz instance
*/ */
protected function getNewFactoryServiceService() protected function getNewFactoryServiceService()
{ {
@ -307,7 +307,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar\FooClass A Bar\FooClass instance. * @return \Bar\FooClass A Bar\FooClass instance
*/ */
protected function getServiceFromStaticMethodService() protected function getServiceFromStaticMethodService()
{ {
@ -324,7 +324,7 @@ class ProjectServiceContainer extends Container
* If you want to be able to request this service from the container directly, * If you want to be able to request this service from the container directly,
* make it public, otherwise you might end up with broken code. * make it public, otherwise you might end up with broken code.
* *
* @return \ConfClass A ConfClass instance. * @return \ConfClass A ConfClass instance
*/ */
protected function getConfiguratorServiceService() protected function getConfiguratorServiceService()
{ {
@ -345,7 +345,7 @@ class ProjectServiceContainer extends Container
* If you want to be able to request this service from the container directly, * If you want to be able to request this service from the container directly,
* make it public, otherwise you might end up with broken code. * make it public, otherwise you might end up with broken code.
* *
* @return \Bar A Bar instance. * @return \Bar A Bar instance
*/ */
protected function getInlinedService() protected function getInlinedService()
{ {
@ -367,7 +367,7 @@ class ProjectServiceContainer extends Container
* If you want to be able to request this service from the container directly, * If you want to be able to request this service from the container directly,
* make it public, otherwise you might end up with broken code. * make it public, otherwise you might end up with broken code.
* *
* @return \FactoryClass A FactoryClass instance. * @return \FactoryClass A FactoryClass instance
*/ */
protected function getNewFactoryService() protected function getNewFactoryService()
{ {

View File

@ -69,7 +69,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar\FooClass A Bar\FooClass instance. * @return \Bar\FooClass A Bar\FooClass instance
*/ */
protected function getBarService() protected function getBarService()
{ {
@ -88,7 +88,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Baz A Baz instance. * @return \Baz A Baz instance
*/ */
protected function getBazService() protected function getBazService()
{ {
@ -105,7 +105,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \stdClass A stdClass instance. * @return \stdClass A stdClass instance
*/ */
protected function getConfiguredServiceService() protected function getConfiguredServiceService()
{ {
@ -125,7 +125,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \stdClass A stdClass instance. * @return \stdClass A stdClass instance
*/ */
protected function getDecoratorServiceService() protected function getDecoratorServiceService()
{ {
@ -138,7 +138,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \stdClass A stdClass instance. * @return \stdClass A stdClass instance
*/ */
protected function getDecoratorServiceWithNameService() protected function getDecoratorServiceWithNameService()
{ {
@ -168,7 +168,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar A Bar instance. * @return \Bar A Bar instance
*/ */
protected function getFactoryServiceService() protected function getFactoryServiceService()
{ {
@ -181,7 +181,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar\FooClass A Bar\FooClass instance. * @return \Bar\FooClass A Bar\FooClass instance
*/ */
protected function getFooService() protected function getFooService()
{ {
@ -205,7 +205,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \BazClass A BazClass instance. * @return \BazClass A BazClass instance
*/ */
protected function getFoo_BazService() protected function getFoo_BazService()
{ {
@ -219,7 +219,7 @@ class ProjectServiceContainer extends Container
/** /**
* Gets the 'foo_bar' service. * Gets the 'foo_bar' service.
* *
* @return \Bar\FooClass A Bar\FooClass instance. * @return \Bar\FooClass A Bar\FooClass instance
*/ */
protected function getFooBarService() protected function getFooBarService()
{ {
@ -232,7 +232,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Foo A Foo instance. * @return \Foo A Foo instance
*/ */
protected function getFooWithInlineService() protected function getFooWithInlineService()
{ {
@ -254,7 +254,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar\FooClass A Bar\FooClass instance. * @return \Bar\FooClass A Bar\FooClass instance
*/ */
protected function getMethodCall1Service() protected function getMethodCall1Service()
{ {
@ -275,7 +275,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \FooBarBaz A FooBarBaz instance. * @return \FooBarBaz A FooBarBaz instance
*/ */
protected function getNewFactoryServiceService() protected function getNewFactoryServiceService()
{ {
@ -308,7 +308,7 @@ class ProjectServiceContainer extends Container
* This service is shared. * This service is shared.
* This method always returns the same instance of the service. * This method always returns the same instance of the service.
* *
* @return \Bar\FooClass A Bar\FooClass instance. * @return \Bar\FooClass A Bar\FooClass instance
*/ */
protected function getServiceFromStaticMethodService() protected function getServiceFromStaticMethodService()
{ {

View File

@ -320,7 +320,7 @@ class Crawler extends \SplObjectStorage
* *
* @param int $position The position * @param int $position The position
* *
* @return Crawler A new instance of the Crawler with the selected node, or an empty Crawler if it does not exist. * @return Crawler A new instance of the Crawler with the selected node, or an empty Crawler if it does not exist
*/ */
public function eq($position) public function eq($position)
{ {
@ -379,7 +379,7 @@ class Crawler extends \SplObjectStorage
* *
* @param \Closure $closure An anonymous function * @param \Closure $closure An anonymous function
* *
* @return Crawler A Crawler instance with the selected nodes. * @return Crawler A Crawler instance with the selected nodes
*/ */
public function reduce(\Closure $closure) public function reduce(\Closure $closure)
{ {

View File

@ -85,7 +85,7 @@ class Form extends Link implements \ArrayAccess
* *
* The returned array does not include file fields (@see getFiles). * The returned array does not include file fields (@see getFiles).
* *
* @return array An array of field values. * @return array An array of field values
*/ */
public function getValues() public function getValues()
{ {
@ -106,7 +106,7 @@ class Form extends Link implements \ArrayAccess
/** /**
* Gets the file field values. * Gets the file field values.
* *
* @return array An array of file field values. * @return array An array of file field values
*/ */
public function getFiles() public function getFiles()
{ {
@ -135,7 +135,7 @@ class Form extends Link implements \ArrayAccess
* This method converts fields with the array notation * This method converts fields with the array notation
* (like foo[bar] to arrays) like PHP does. * (like foo[bar] to arrays) like PHP does.
* *
* @return array An array of field values. * @return array An array of field values
*/ */
public function getPhpValues() public function getPhpValues()
{ {
@ -162,7 +162,7 @@ class Form extends Link implements \ArrayAccess
* For a compound file field foo[bar] it will create foo[bar][name], * For a compound file field foo[bar] it will create foo[bar][name],
* instead of foo[name][bar] which would be found in $_FILES. * instead of foo[name][bar] which would be found in $_FILES.
* *
* @return array An array of file field values. * @return array An array of file field values
*/ */
public function getPhpFiles() public function getPhpFiles()
{ {

View File

@ -47,7 +47,7 @@ class Event
* *
* @see Event::stopPropagation() * @see Event::stopPropagation()
* *
* @return bool Whether propagation was already stopped for this event. * @return bool Whether propagation was already stopped for this event
*/ */
public function isPropagationStopped() public function isPropagationStopped()
{ {
@ -109,7 +109,7 @@ class Event
/** /**
* Sets the event's name property. * Sets the event's name property.
* *
* @param string $name The event name. * @param string $name The event name
* *
* @deprecated since version 2.4, to be removed in 3.0. The event name is passed to the listener call. * @deprecated since version 2.4, to be removed in 3.0. The event name is passed to the listener call.
*/ */

View File

@ -171,9 +171,9 @@ class EventDispatcher implements EventDispatcherInterface
* This method can be overridden to add functionality that is executed * This method can be overridden to add functionality that is executed
* for each listener. * for each listener.
* *
* @param callable[] $listeners The event listeners. * @param callable[] $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)
{ {
@ -188,7 +188,7 @@ class EventDispatcher implements EventDispatcherInterface
/** /**
* Sorts the internal list of listeners for the given event by priority. * Sorts the internal list of listeners for the given event by priority.
* *
* @param string $eventName The name of the event. * @param string $eventName The name of the event
*/ */
private function sortListeners($eventName) private function sortListeners($eventName)
{ {

View File

@ -26,7 +26,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.
* *
* @return Event * @return Event
@ -49,7 +49,7 @@ interface EventDispatcherInterface
* The subscriber is asked for all the events he is * The subscriber is asked for all the events he is
* interested in and added as a listener for these events. * interested in and added as a listener for these events.
* *
* @param EventSubscriberInterface $subscriber The subscriber. * @param EventSubscriberInterface $subscriber The subscriber
*/ */
public function addSubscriber(EventSubscriberInterface $subscriber); public function addSubscriber(EventSubscriberInterface $subscriber);

View File

@ -37,8 +37,8 @@ class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
/** /**
* Encapsulate an event with $subject and $args. * Encapsulate an event with $subject and $args.
* *
* @param mixed $subject The subject of the event, usually an object. * @param mixed $subject The subject of the event, usually an object
* @param array $arguments Arguments to store in the event. * @param array $arguments Arguments to store in the event
*/ */
public function __construct($subject = null, array $arguments = array()) public function __construct($subject = null, array $arguments = array())
{ {
@ -49,7 +49,7 @@ class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
/** /**
* Getter for subject property. * Getter for subject property.
* *
* @return mixed $subject The observer subject. * @return mixed $subject The observer subject
*/ */
public function getSubject() public function getSubject()
{ {
@ -59,9 +59,9 @@ class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
/** /**
* Get argument by key. * Get argument by key.
* *
* @param string $key Key. * @param string $key Key
* *
* @return mixed Contents of array key. * @return mixed Contents of array key
* *
* @throws \InvalidArgumentException If key is not found. * @throws \InvalidArgumentException If key is not found.
*/ */
@ -77,8 +77,8 @@ class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
/** /**
* Add argument to event. * Add argument to event.
* *
* @param string $key Argument name. * @param string $key Argument name
* @param mixed $value Value. * @param mixed $value Value
* *
* @return GenericEvent * @return GenericEvent
*/ */
@ -102,7 +102,7 @@ class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
/** /**
* Set args property. * Set args property.
* *
* @param array $args Arguments. * @param array $args Arguments
* *
* @return GenericEvent * @return GenericEvent
*/ */
@ -116,7 +116,7 @@ class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
/** /**
* Has argument. * Has argument.
* *
* @param string $key Key of arguments array. * @param string $key Key of arguments array
* *
* @return bool * @return bool
*/ */
@ -128,7 +128,7 @@ class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
/** /**
* ArrayAccess for argument getter. * ArrayAccess for argument getter.
* *
* @param string $key Array key. * @param string $key Array key
* *
* @return mixed * @return mixed
* *
@ -142,8 +142,8 @@ class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
/** /**
* ArrayAccess for argument setter. * ArrayAccess for argument setter.
* *
* @param string $key Array key to set. * @param string $key Array key to set
* @param mixed $value Value. * @param mixed $value Value
*/ */
public function offsetSet($key, $value) public function offsetSet($key, $value)
{ {
@ -153,7 +153,7 @@ class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
/** /**
* ArrayAccess for unset argument. * ArrayAccess for unset argument.
* *
* @param string $key Array key. * @param string $key Array key
*/ */
public function offsetUnset($key) public function offsetUnset($key)
{ {
@ -165,7 +165,7 @@ class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
/** /**
* ArrayAccess has argument. * ArrayAccess has argument.
* *
* @param string $key Array key. * @param string $key Array key
* *
* @return bool * @return bool
*/ */

View File

@ -28,7 +28,7 @@ class ImmutableEventDispatcher implements EventDispatcherInterface
/** /**
* Creates an unmodifiable proxy for an event dispatcher. * Creates an unmodifiable proxy for an event dispatcher.
* *
* @param EventDispatcherInterface $dispatcher The proxied event dispatcher. * @param EventDispatcherInterface $dispatcher The proxied event dispatcher
*/ */
public function __construct(EventDispatcherInterface $dispatcher) public function __construct(EventDispatcherInterface $dispatcher)
{ {

View File

@ -21,7 +21,7 @@ interface IOExceptionInterface extends ExceptionInterface
/** /**
* Returns the associated path for the exception. * Returns the associated path for the exception.
* *
* @return string The path. * @return string The path
*/ */
public function getPath(); public function getPath();
} }

View File

@ -283,7 +283,7 @@ class Filesystem
/** /**
* Tells whether a file exists and is readable. * Tells whether a file exists and is readable.
* *
* @param string $filename Path to the file. * @param string $filename Path to the file
* *
* @throws IOException When windows path is longer than 258 characters * @throws IOException When windows path is longer than 258 characters
*/ */
@ -531,8 +531,8 @@ class Filesystem
/** /**
* Atomically dumps content into a file. * Atomically dumps content into a file.
* *
* @param string $filename The file to be written to. * @param string $filename The file to be written to
* @param string $content The data to write into the file. * @param string $content The data to write into the file
* @param null|int $mode The file mode (octal). If null, file permissions are not modified * @param null|int $mode The file mode (octal). If null, file permissions are not modified
* Deprecated since version 2.3.12, to be removed in 3.0. * Deprecated since version 2.3.12, to be removed in 3.0.
* *

View File

@ -45,7 +45,7 @@ class PathFilterIterator extends MultiplePcreFilterIterator
* *
* Use only / as directory separator (on Windows also). * Use only / as directory separator (on Windows also).
* *
* @param string $str Pattern: regexp or dirname. * @param string $str Pattern: regexp or dirname
* *
* @return string regexp corresponding to a given string or regexp * @return string regexp corresponding to a given string or regexp
*/ */

View File

@ -126,11 +126,11 @@ abstract class AbstractRendererEngine implements FormRendererEngineInterface
* *
* @see getResourceForBlock() * @see getResourceForBlock()
* *
* @param string $cacheKey The cache key of the form view. * @param string $cacheKey The cache key of the form view
* @param FormView $view The form view for finding the applying themes. * @param FormView $view The form view for finding the applying themes
* @param string $blockName The name of the block to load. * @param string $blockName The name of the block to load
* *
* @return bool True if the resource could be loaded, false otherwise. * @return bool True if the resource could be loaded, false otherwise
*/ */
abstract protected function loadResourceForBlockName($cacheKey, FormView $view, $blockName); abstract protected function loadResourceForBlockName($cacheKey, FormView $view, $blockName);
@ -148,7 +148,7 @@ abstract class AbstractRendererEngine implements FormRendererEngineInterface
* @param int $hierarchyLevel The level in the block hierarchy that * @param int $hierarchyLevel The level in the block hierarchy that
* should be loaded. * should be loaded.
* *
* @return bool True if the resource could be loaded, false otherwise. * @return bool True if the resource could be loaded, false otherwise
*/ */
private function loadResourceForBlockNameHierarchy($cacheKey, FormView $view, array $blockNameHierarchy, $hierarchyLevel) private function loadResourceForBlockNameHierarchy($cacheKey, FormView $view, array $blockNameHierarchy, $hierarchyLevel)
{ {

View File

@ -56,7 +56,7 @@ abstract class AbstractType implements FormTypeInterface
/** /**
* Configures the options for this type. * Configures the options for this type.
* *
* @param OptionsResolver $resolver The resolver for the options. * @param OptionsResolver $resolver The resolver for the options
*/ */
public function configureOptions(OptionsResolver $resolver) public function configureOptions(OptionsResolver $resolver)
{ {

View File

@ -55,7 +55,7 @@ abstract class AbstractTypeExtension implements FormTypeExtensionInterface
/** /**
* Configures the options for this type. * Configures the options for this type.
* *
* @param OptionsResolver $resolver The resolver for the options. * @param OptionsResolver $resolver The resolver for the options
*/ */
public function configureOptions(OptionsResolver $resolver) public function configureOptions(OptionsResolver $resolver)
{ {

View File

@ -39,7 +39,7 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Creates a new button from a form configuration. * Creates a new button from a form configuration.
* *
* @param FormConfigInterface $config The button's configuration. * @param FormConfigInterface $config The button's configuration
*/ */
public function __construct(FormConfigInterface $config) public function __construct(FormConfigInterface $config)
{ {
@ -51,7 +51,7 @@ class Button implements \IteratorAggregate, FormInterface
* *
* @param mixed $offset * @param mixed $offset
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function offsetExists($offset) public function offsetExists($offset)
{ {
@ -152,7 +152,7 @@ class Button implements \IteratorAggregate, FormInterface
* *
* @param string $name * @param string $name
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function has($name) public function has($name)
{ {
@ -226,7 +226,7 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return array Always returns an empty array. * @return array Always returns an empty array
*/ */
public function getExtraData() public function getExtraData()
{ {
@ -236,7 +236,7 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Returns the button's configuration. * Returns the button's configuration.
* *
* @return FormConfigInterface The configuration. * @return FormConfigInterface The configuration
*/ */
public function getConfig() public function getConfig()
{ {
@ -246,7 +246,7 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Returns whether the button is submitted. * Returns whether the button is submitted.
* *
* @return bool true if the button was submitted. * @return bool true if the button was submitted
*/ */
public function isSubmitted() public function isSubmitted()
{ {
@ -256,7 +256,7 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Returns the name by which the button is identified in forms. * Returns the name by which the button is identified in forms.
* *
* @return string The name of the button. * @return string The name of the button
*/ */
public function getName() public function getName()
{ {
@ -285,7 +285,7 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns true. * @return bool Always returns true
*/ */
public function isValid() public function isValid()
{ {
@ -295,7 +295,7 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function isRequired() public function isRequired()
{ {
@ -317,7 +317,7 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns true. * @return bool Always returns true
*/ */
public function isEmpty() public function isEmpty()
{ {
@ -327,7 +327,7 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns true. * @return bool Always returns true
*/ */
public function isSynchronized() public function isSynchronized()
{ {
@ -366,8 +366,8 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Submits data to the button. * Submits data to the button.
* *
* @param null|string $submittedData The data. * @param null|string $submittedData The data
* @param bool $clearMissing Not used. * @param bool $clearMissing Not used
* *
* @return Button The button instance * @return Button The button instance
* *
@ -423,7 +423,7 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return int Always returns 0. * @return int Always returns 0
*/ */
public function count() public function count()
{ {
@ -433,7 +433,7 @@ class Button implements \IteratorAggregate, FormInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return \EmptyIterator Always returns an empty iterator. * @return \EmptyIterator Always returns an empty iterator
*/ */
public function getIterator() public function getIterator()
{ {

View File

@ -55,8 +55,8 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Creates a new button builder. * Creates a new button builder.
* *
* @param string $name The name of the button. * @param string $name The name of the button
* @param array $options The button's options. * @param array $options The button's options
* *
* @throws InvalidArgumentException If the name is empty. * @throws InvalidArgumentException If the name is empty.
*/ */
@ -135,7 +135,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
* *
* @param string $name * @param string $name
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function has($name) public function has($name)
{ {
@ -145,7 +145,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Returns the children. * Returns the children.
* *
* @return array Always returns an empty array. * @return array Always returns an empty array
*/ */
public function all() public function all()
{ {
@ -285,7 +285,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
* *
* @param bool $disabled Whether the button is disabled * @param bool $disabled Whether the button is disabled
* *
* @return ButtonBuilder The button builder. * @return ButtonBuilder The button builder
*/ */
public function setDisabled($disabled) public function setDisabled($disabled)
{ {
@ -412,9 +412,9 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Sets the type of the button. * Sets the type of the button.
* *
* @param ResolvedFormTypeInterface $type The type of the button. * @param ResolvedFormTypeInterface $type The type of the button
* *
* @return ButtonBuilder The button builder. * @return ButtonBuilder The button builder
*/ */
public function setType(ResolvedFormTypeInterface $type) public function setType(ResolvedFormTypeInterface $type)
{ {
@ -570,7 +570,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function getMapped() public function getMapped()
{ {
@ -580,7 +580,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function getByReference() public function getByReference()
{ {
@ -590,7 +590,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns false. * @return bool Always returns false
* *
* @deprecated since version 2.3, to be removed in 3.0. * @deprecated since version 2.3, to be removed in 3.0.
* Use {@link getInheritData()} instead. * Use {@link getInheritData()} instead.
@ -605,7 +605,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function getCompound() public function getCompound()
{ {
@ -615,7 +615,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Returns the form type used to construct the button. * Returns the form type used to construct the button.
* *
* @return ResolvedFormTypeInterface The button's type. * @return ResolvedFormTypeInterface The button's type
*/ */
public function getType() public function getType()
{ {
@ -625,7 +625,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return array Always returns an empty array. * @return array Always returns an empty array
*/ */
public function getViewTransformers() public function getViewTransformers()
{ {
@ -635,7 +635,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return array Always returns an empty array. * @return array Always returns an empty array
*/ */
public function getModelTransformers() public function getModelTransformers()
{ {
@ -652,7 +652,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function getRequired() public function getRequired()
{ {
@ -662,7 +662,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Returns whether the button is disabled. * Returns whether the button is disabled.
* *
* @return bool Whether the button is disabled. * @return bool Whether the button is disabled
*/ */
public function getDisabled() public function getDisabled()
{ {
@ -672,7 +672,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function getErrorBubbling() public function getErrorBubbling()
{ {
@ -689,7 +689,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Returns additional attributes of the button. * Returns additional attributes of the button.
* *
* @return array An array of key-value combinations. * @return array An array of key-value combinations
*/ */
public function getAttributes() public function getAttributes()
{ {
@ -699,9 +699,9 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Returns whether the attribute with the given name exists. * Returns whether the attribute with the given name exists.
* *
* @param string $name The attribute name. * @param string $name The attribute name
* *
* @return bool Whether the attribute exists. * @return bool Whether the attribute exists
*/ */
public function hasAttribute($name) public function hasAttribute($name)
{ {
@ -711,10 +711,10 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Returns the value of the given attribute. * Returns the value of the given attribute.
* *
* @param string $name The attribute name. * @param string $name The attribute name
* @param mixed $default The value returned if the attribute does not exist. * @param mixed $default The value returned if the attribute does not exist
* *
* @return mixed The attribute value. * @return mixed The attribute value
*/ */
public function getAttribute($name, $default = null) public function getAttribute($name, $default = null)
{ {
@ -738,7 +738,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function getDataLocked() public function getDataLocked()
{ {
@ -776,7 +776,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function getAutoInitialize() public function getAutoInitialize()
{ {
@ -786,7 +786,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return bool Always returns false. * @return bool Always returns false
*/ */
public function getInheritData() public function getInheritData()
{ {
@ -796,7 +796,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Returns all options passed during the construction of the button. * Returns all options passed during the construction of the button.
* *
* @return array The passed options. * @return array The passed options
*/ */
public function getOptions() public function getOptions()
{ {
@ -808,7 +808,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
* *
* @param string $name The option name, * @param string $name The option name,
* *
* @return bool Whether the option exists. * @return bool Whether the option exists
*/ */
public function hasOption($name) public function hasOption($name)
{ {
@ -818,10 +818,10 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Returns the value of a specific option. * Returns the value of a specific option.
* *
* @param string $name The option name. * @param string $name The option name
* @param mixed $default The value returned if the option does not exist. * @param mixed $default The value returned if the option does not exist
* *
* @return mixed The option value. * @return mixed The option value
*/ */
public function getOption($name, $default = null) public function getOption($name, $default = null)
{ {
@ -831,7 +831,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return int Always returns 0. * @return int Always returns 0
*/ */
public function count() public function count()
{ {
@ -841,7 +841,7 @@ class ButtonBuilder implements \IteratorAggregate, FormBuilderInterface
/** /**
* Unsupported method. * Unsupported method.
* *
* @return \EmptyIterator Always returns an empty iterator. * @return \EmptyIterator Always returns an empty iterator
*/ */
public function getIterator() public function getIterator()
{ {

View File

@ -218,7 +218,7 @@ class ArrayChoiceList implements ChoiceListInterface
* Checks whether the given choices can be cast to strings without * Checks whether the given choices can be cast to strings without
* generating duplicates. * generating duplicates.
* *
* @param array $choices The choices. * @param array $choices The choices
* @param array|null $cache The cache for previously checked entries. Internal * @param array|null $cache The cache for previously checked entries. Internal
* *
* @return bool Returns true if the choices can be cast to strings and * @return bool Returns true if the choices can be cast to strings and

View File

@ -35,7 +35,7 @@ class ChoiceGroupView implements \IteratorAggregate
/** /**
* Creates a new choice group view. * Creates a new choice group view.
* *
* @param string $label The label of the group. * @param string $label The label of the group
* @param ChoiceGroupView[]|ChoiceView[] $choices The choice views in the * @param ChoiceGroupView[]|ChoiceView[] $choices The choice views in the
* group. * group.
*/ */

View File

@ -39,7 +39,7 @@ class ChoiceListView
/** /**
* Creates a new choice list view. * Creates a new choice list view.
* *
* @param ChoiceGroupView[]|ChoiceView[] $choices The choice views. * @param ChoiceGroupView[]|ChoiceView[] $choices The choice views
* @param ChoiceGroupView[]|ChoiceView[] $preferredChoices The preferred * @param ChoiceGroupView[]|ChoiceView[] $preferredChoices The preferred
* choice views. * choice views.
*/ */

View File

@ -45,9 +45,9 @@ class ChoiceView
/** /**
* Creates a new ChoiceView. * Creates a new ChoiceView.
* *
* @param mixed $data The original choice. * @param mixed $data The original choice
* @param string $value The view representation of the choice. * @param string $value The view representation of the choice
* @param string $label The label displayed to humans. * @param string $label The label displayed to humans
*/ */
public function __construct($data, $value, $label) public function __construct($data, $value, $label)
{ {

View File

@ -21,7 +21,7 @@ interface ClickableInterface
/** /**
* Returns whether this element was clicked. * Returns whether this element was clicked.
* *
* @return bool Whether this element was clicked. * @return bool Whether this element was clicked
*/ */
public function isClicked(); public function isClicked();
} }

View File

@ -19,8 +19,8 @@ interface DataMapperInterface
/** /**
* Maps properties of some data to a list of forms. * Maps properties of some data to a list of forms.
* *
* @param mixed $data Structured data. * @param mixed $data Structured data
* @param FormInterface[] $forms A list of {@link FormInterface} instances. * @param FormInterface[] $forms A list of {@link FormInterface} instances
* *
* @throws Exception\UnexpectedTypeException if the type of the data parameter is not supported. * @throws Exception\UnexpectedTypeException if the type of the data parameter is not supported.
*/ */
@ -29,8 +29,8 @@ interface DataMapperInterface
/** /**
* Maps the data of a list of forms into the properties of some data. * Maps the data of a list of forms into the properties of some data.
* *
* @param FormInterface[] $forms A list of {@link FormInterface} instances. * @param FormInterface[] $forms A list of {@link FormInterface} instances
* @param mixed $data Structured data. * @param mixed $data Structured data
* *
* @throws Exception\UnexpectedTypeException if the type of the data parameter is not supported. * @throws Exception\UnexpectedTypeException if the type of the data parameter is not supported.
*/ */

View File

@ -101,9 +101,9 @@ class ChoiceList implements ChoiceListInterface
* *
* Safe to be called multiple times. The list is cleared on every call. * Safe to be called multiple times. The list is cleared on every call.
* *
* @param array|\Traversable $choices The choices to write into the list. * @param array|\Traversable $choices The choices to write into the list
* @param array $labels The labels belonging to the choices. * @param array $labels The labels belonging to the choices
* @param array $preferredChoices The choices to display with priority. * @param array $preferredChoices The choices to display with priority
*/ */
protected function initialize($choices, array $labels, array $preferredChoices) protected function initialize($choices, array $labels, array $preferredChoices)
{ {
@ -264,9 +264,9 @@ class ChoiceList implements ChoiceListInterface
* view objects. * view objects.
* @param array $bucketForRemaining The bucket where to store the * @param array $bucketForRemaining The bucket where to store the
* non-preferred view objects. * non-preferred view objects.
* @param array|\Traversable $choices The list of choices. * @param array|\Traversable $choices The list of choices
* @param array $labels The labels corresponding to the choices. * @param array $labels The labels corresponding to the choices
* @param array $preferredChoices The preferred choices. * @param array $preferredChoices The preferred choices
* *
* @throws InvalidArgumentException If the structures of the choices and labels array do not match. * @throws InvalidArgumentException If the structures of the choices and labels array do not match.
* @throws InvalidConfigurationException If no valid value or index could be created for a choice. * @throws InvalidConfigurationException If no valid value or index could be created for a choice.
@ -306,14 +306,14 @@ class ChoiceList implements ChoiceListInterface
/** /**
* Recursively adds a choice group. * Recursively adds a choice group.
* *
* @param string $group The name of the group. * @param string $group The name of the group
* @param array $bucketForPreferred The bucket where to store the preferred * @param array $bucketForPreferred The bucket where to store the preferred
* view objects. * view objects.
* @param array $bucketForRemaining The bucket where to store the * @param array $bucketForRemaining The bucket where to store the
* non-preferred view objects. * non-preferred view objects.
* @param array $choices The list of choices in the group. * @param array $choices The list of choices in the group
* @param array $labels The labels corresponding to the choices in the group. * @param array $labels The labels corresponding to the choices in the group
* @param array $preferredChoices The preferred choices. * @param array $preferredChoices The preferred choices
* *
* @throws InvalidConfigurationException If no valid value or index could be created for a choice. * @throws InvalidConfigurationException If no valid value or index could be created for a choice.
*/ */
@ -348,9 +348,9 @@ class ChoiceList implements ChoiceListInterface
* view objects. * view objects.
* @param array $bucketForRemaining The bucket where to store the * @param array $bucketForRemaining The bucket where to store the
* non-preferred view objects. * non-preferred view objects.
* @param mixed $choice The choice to add. * @param mixed $choice The choice to add
* @param string $label The label for the choice. * @param string $label The label for the choice
* @param array $preferredChoices The preferred choices. * @param array $preferredChoices The preferred choices
* *
* @throws InvalidConfigurationException If no valid value or index could be created. * @throws InvalidConfigurationException If no valid value or index could be created.
*/ */
@ -387,10 +387,10 @@ class ChoiceList implements ChoiceListInterface
* Extension point to optimize performance by changing the structure of the * Extension point to optimize performance by changing the structure of the
* $preferredChoices array. * $preferredChoices array.
* *
* @param mixed $choice The choice to test. * @param mixed $choice The choice to test
* @param array $preferredChoices An array of preferred choices. * @param array $preferredChoices An array of preferred choices
* *
* @return bool Whether the choice is preferred. * @return bool Whether the choice is preferred
*/ */
protected function isPreferred($choice, array $preferredChoices) protected function isPreferred($choice, array $preferredChoices)
{ {
@ -421,7 +421,7 @@ class ChoiceList implements ChoiceListInterface
* *
* @param mixed $choice The choice to create a value for * @param mixed $choice The choice to create a value for
* *
* @return string A unique string. * @return string A unique string
*/ */
protected function createValue($choice) protected function createValue($choice)
{ {
@ -432,9 +432,9 @@ class ChoiceList implements ChoiceListInterface
* Fixes the data type of the given choice value to avoid comparison * Fixes the data type of the given choice value to avoid comparison
* problems. * problems.
* *
* @param mixed $value The choice value. * @param mixed $value The choice value
* *
* @return string The value as string. * @return string The value as string
*/ */
protected function fixValue($value) protected function fixValue($value)
{ {
@ -445,9 +445,9 @@ class ChoiceList implements ChoiceListInterface
* Fixes the data types of the given choice values to avoid comparison * Fixes the data types of the given choice values to avoid comparison
* problems. * problems.
* *
* @param array $values The choice values. * @param array $values The choice values
* *
* @return array The values as strings. * @return array The values as strings
*/ */
protected function fixValues(array $values) protected function fixValues(array $values)
{ {
@ -462,9 +462,9 @@ class ChoiceList implements ChoiceListInterface
* Fixes the data type of the given choice index to avoid comparison * Fixes the data type of the given choice index to avoid comparison
* problems. * problems.
* *
* @param mixed $index The choice index. * @param mixed $index The choice index
* *
* @return int|string The index as PHP array key. * @return int|string The index as PHP array key
*/ */
protected function fixIndex($index) protected function fixIndex($index)
{ {
@ -479,9 +479,9 @@ class ChoiceList implements ChoiceListInterface
* Fixes the data types of the given choice indices to avoid comparison * Fixes the data types of the given choice indices to avoid comparison
* problems. * problems.
* *
* @param array $indices The choice indices. * @param array $indices The choice indices
* *
* @return array The indices as strings. * @return array The indices as strings
*/ */
protected function fixIndices(array $indices) protected function fixIndices(array $indices)
{ {
@ -510,9 +510,9 @@ class ChoiceList implements ChoiceListInterface
/** /**
* Fixes the data type of the given choices to avoid comparison problems. * Fixes the data type of the given choices to avoid comparison problems.
* *
* @param array $choices The choices. * @param array $choices The choices
* *
* @return array The fixed choices. * @return array The fixed choices
* *
* @see fixChoice() * @see fixChoice()
*/ */

View File

@ -88,7 +88,7 @@ class ObjectChoiceList extends ChoiceList
* @param string $valuePath A property path pointing to the property used * @param string $valuePath A property path pointing to the property used
* for the choice values. If not given, integers * for the choice values. If not given, integers
* are generated instead. * are generated instead.
* @param PropertyAccessorInterface $propertyAccessor The reflection graph for reading property paths. * @param PropertyAccessorInterface $propertyAccessor The reflection graph for reading property paths
*/ */
public function __construct($choices, $labelPath = null, array $preferredChoices = array(), $groupPath = null, $valuePath = null, PropertyAccessorInterface $propertyAccessor = null) public function __construct($choices, $labelPath = null, array $preferredChoices = array(), $groupPath = null, $valuePath = null, PropertyAccessorInterface $propertyAccessor = null)
{ {
@ -105,9 +105,9 @@ class ObjectChoiceList extends ChoiceList
* *
* Safe to be called multiple times. The list is cleared on every call. * Safe to be called multiple times. The list is cleared on every call.
* *
* @param array|\Traversable $choices The choices to write into the list. * @param array|\Traversable $choices The choices to write into the list
* @param array $labels Ignored. * @param array $labels Ignored
* @param array $preferredChoices The choices to display with priority. * @param array $preferredChoices The choices to display with priority
* *
* @throws InvalidArgumentException When passing a hierarchy of choices and using * @throws InvalidArgumentException When passing a hierarchy of choices and using
* the "groupPath" option at the same time. * the "groupPath" option at the same time.
@ -238,7 +238,7 @@ class ObjectChoiceList extends ChoiceList
* *
* @param mixed $choice The choice to create a value for * @param mixed $choice The choice to create a value for
* *
* @return int|string A unique value without character limitations. * @return int|string A unique value without character limitations
*/ */
protected function createValue($choice) protected function createValue($choice)
{ {

View File

@ -87,9 +87,9 @@ class SimpleChoiceList extends ChoiceList
* view objects. * view objects.
* @param array $bucketForRemaining The bucket where to store the * @param array $bucketForRemaining The bucket where to store the
* non-preferred view objects. * non-preferred view objects.
* @param array|\Traversable $choices The list of choices. * @param array|\Traversable $choices The list of choices
* @param array $labels Ignored. * @param array $labels Ignored
* @param array $preferredChoices The preferred choices. * @param array $preferredChoices The preferred choices
*/ */
protected function addChoices(array &$bucketForPreferred, array &$bucketForRemaining, $choices, array $labels, array $preferredChoices) protected function addChoices(array &$bucketForPreferred, array &$bucketForRemaining, $choices, array $labels, array $preferredChoices)
{ {
@ -126,10 +126,10 @@ class SimpleChoiceList extends ChoiceList
* Optimized for performance by treating the preferred choices as array * Optimized for performance by treating the preferred choices as array
* where choices are stored in the keys. * where choices are stored in the keys.
* *
* @param mixed $choice The choice to test. * @param mixed $choice The choice to test
* @param array $preferredChoices An array of preferred choices. * @param array $preferredChoices An array of preferred choices
* *
* @return bool Whether the choice is preferred. * @return bool Whether the choice is preferred
*/ */
protected function isPreferred($choice, array $preferredChoices) protected function isPreferred($choice, array $preferredChoices)
{ {

View File

@ -42,9 +42,9 @@ class BooleanToStringTransformer implements DataTransformerInterface
/** /**
* Transforms a Boolean into a string. * Transforms a Boolean into a string.
* *
* @param bool $value Boolean value. * @param bool $value Boolean value
* *
* @return string String value. * @return string String value
* *
* @throws TransformationFailedException If the given value is not a Boolean. * @throws TransformationFailedException If the given value is not a Boolean.
*/ */
@ -64,9 +64,9 @@ 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 bool Boolean value. * @return bool Boolean value
* *
* @throws TransformationFailedException If the given value is not a string. * @throws TransformationFailedException If the given value is not a string.
*/ */

View File

@ -53,7 +53,7 @@ class DateTimeToArrayTransformer extends BaseDateTimeTransformer
* *
* @param \DateTime|\DateTimeInterface $dateTime A DateTime object * @param \DateTime|\DateTimeInterface $dateTime A DateTime object
* *
* @return array Localized date. * @return array Localized date
* *
* @throws TransformationFailedException If the given value is not an * @throws TransformationFailedException If the given value is not an
* instance of \DateTime or \DateTimeInterface * instance of \DateTime or \DateTimeInterface

View File

@ -72,7 +72,7 @@ class DateTimeToLocalizedStringTransformer extends BaseDateTimeTransformer
* *
* @param \DateTime|\DateTimeInterface $dateTime A DateTime object * @param \DateTime|\DateTimeInterface $dateTime A DateTime object
* *
* @return string|array Localized date string/array. * @return string|array Localized date string/array
* *
* @throws TransformationFailedException If the given value is not an instance * @throws TransformationFailedException If the given value is not an instance
* of \DateTime or \DateTimeInterface or * of \DateTime or \DateTimeInterface or

View File

@ -23,7 +23,7 @@ class DateTimeToRfc3339Transformer extends BaseDateTimeTransformer
* *
* @param \DateTime|\DateTimeInterface $dateTime A DateTime object * @param \DateTime|\DateTimeInterface $dateTime A DateTime object
* *
* @return string The formatted date. * @return string The formatted date
* *
* @throws TransformationFailedException If the given value is not an * @throws TransformationFailedException If the given value is not an
* instance of \DateTime or \DateTimeInterface * instance of \DateTime or \DateTimeInterface

View File

@ -22,9 +22,9 @@ class IntegerToLocalizedStringTransformer extends NumberToLocalizedStringTransfo
/** /**
* Constructs a transformer. * Constructs a transformer.
* *
* @param int $scale Unused. * @param int $scale Unused
* @param bool $grouping Whether thousands should be grouped. * @param bool $grouping Whether thousands should be grouped
* @param int $roundingMode One of the ROUND_ constants in this class. * @param int $roundingMode One of the ROUND_ constants in this class
*/ */
public function __construct($scale = 0, $grouping = false, $roundingMode = self::ROUND_DOWN) public function __construct($scale = 0, $grouping = false, $roundingMode = self::ROUND_DOWN)
{ {

View File

@ -47,7 +47,7 @@ class MoneyToLocalizedStringTransformer extends NumberToLocalizedStringTransform
* *
* @param int|float $value Normalized number * @param int|float $value Normalized number
* *
* @return string Localized money string. * @return string Localized money string
* *
* @throws TransformationFailedException If the given value is not numeric or * @throws TransformationFailedException If the given value is not numeric or
* if the value can not be transformed. * if the value can not be transformed.

View File

@ -120,9 +120,9 @@ class NumberToLocalizedStringTransformer implements DataTransformerInterface
/** /**
* Transforms a number type into localized number. * Transforms a number type into localized number.
* *
* @param int|float $value Number value. * @param int|float $value Number value
* *
* @return string Localized value. * @return string Localized value
* *
* @throws TransformationFailedException If the given value is not numeric * @throws TransformationFailedException If the given value is not numeric
* or if the value can not be transformed. * or if the value can not be transformed.
@ -257,9 +257,9 @@ class NumberToLocalizedStringTransformer implements DataTransformerInterface
/** /**
* Rounds a number according to the configured scale and rounding mode. * Rounds a number according to the configured scale and rounding mode.
* *
* @param int|float $number A number. * @param int|float $number A number
* *
* @return int|float The rounded number. * @return int|float The rounded number
*/ */
private function round($number) private function round($number)
{ {

View File

@ -101,9 +101,9 @@ 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 string $value Percentage value. * @param string $value Percentage value
* *
* @return int|float Normalized value. * @return int|float Normalized value
* *
* @throws TransformationFailedException If the given value is not a string or * @throws TransformationFailedException If the given value is not a string or
* if the value could not be transformed. * if the value could not be transformed.

View File

@ -445,9 +445,9 @@ class ChoiceType extends AbstractType
/** /**
* Adds the sub fields for an expanded choice field. * Adds the sub fields for an expanded choice field.
* *
* @param FormBuilderInterface $builder The form builder. * @param FormBuilderInterface $builder The form builder
* @param array $choiceViews The choice view objects. * @param array $choiceViews The choice view objects
* @param array $options The build options. * @param array $options The build options
*/ */
private function addSubForms(FormBuilderInterface $builder, array $choiceViews, array $options) private function addSubForms(FormBuilderInterface $builder, array $choiceViews, array $options)
{ {
@ -516,12 +516,12 @@ class ChoiceType extends AbstractType
* are lost. Store them in a utility array that is used from the * are lost. Store them in a utility array that is used from the
* "choice_label" closure by default. * "choice_label" closure by default.
* *
* @param array|\Traversable $choices The choice labels indexed by choices. * @param array|\Traversable $choices The choice labels indexed by choices
* @param object $choiceLabels The object that receives the choice labels * @param object $choiceLabels The object that receives the choice labels
* indexed by generated keys. * indexed by generated keys.
* @param int $nextKey The next generated key. * @param int $nextKey The next generated key
* *
* @return array The choices in a normalized array with labels replaced by generated keys. * @return array The choices in a normalized array with labels replaced by generated keys
* *
* @internal Public only to be accessible from closures on PHP 5.3. Don't * @internal Public only to be accessible from closures on PHP 5.3. Don't
* use this method as it may be removed without notice and will be in 3.0. * use this method as it may be removed without notice and will be in 3.0.

View File

@ -48,11 +48,11 @@ class TemplatingRendererEngine extends AbstractRendererEngine
* *
* @see getResourceForBlock() * @see getResourceForBlock()
* *
* @param string $cacheKey The cache key of the form view. * @param string $cacheKey The cache key of the form view
* @param FormView $view The form view for finding the applying themes. * @param FormView $view The form view for finding the applying themes
* @param string $blockName The name of the block to load. * @param string $blockName The name of the block to load
* *
* @return bool True if the resource could be loaded, false otherwise. * @return bool True if the resource could be loaded, false otherwise
*/ */
protected function loadResourceForBlockName($cacheKey, FormView $view, $blockName) protected function loadResourceForBlockName($cacheKey, FormView $view, $blockName)
{ {
@ -106,11 +106,11 @@ class TemplatingRendererEngine extends AbstractRendererEngine
/** /**
* Tries to load the resource for a block from a theme. * Tries to load the resource for a block from a theme.
* *
* @param string $cacheKey The cache key for storing the resource. * @param string $cacheKey The cache key for storing the resource
* @param string $blockName The name of the block to load a resource for. * @param string $blockName The name of the block to load a resource for
* @param mixed $theme The theme to load the block from. * @param mixed $theme The theme to load the block from
* *
* @return bool True if the resource could be loaded, false otherwise. * @return bool True if the resource could be loaded, false otherwise
*/ */
protected function loadResourceFromTheme($cacheKey, $blockName, $theme) protected function loadResourceFromTheme($cacheKey, $blockName, $theme)
{ {

View File

@ -153,9 +153,9 @@ class FormValidator extends ConstraintValidator
/** /**
* Returns whether the data of a form may be walked. * Returns whether the data of a form may be walked.
* *
* @param FormInterface $form The form to test. * @param FormInterface $form The form to test
* *
* @return bool Whether the graph walker may walk the data. * @return bool Whether the graph walker may walk the data
*/ */
private static function allowDataWalking(FormInterface $form) private static function allowDataWalking(FormInterface $form)
{ {
@ -185,9 +185,9 @@ class FormValidator extends ConstraintValidator
/** /**
* Returns the validation groups of the given form. * Returns the validation groups of the given form.
* *
* @param FormInterface $form The form. * @param FormInterface $form The form
* *
* @return array The validation groups. * @return array The validation groups
*/ */
private static function getValidationGroups(FormInterface $form) private static function getValidationGroups(FormInterface $form)
{ {
@ -222,10 +222,10 @@ class FormValidator extends ConstraintValidator
/** /**
* Post-processes the validation groups option for a given form. * Post-processes the validation groups option for a given form.
* *
* @param array|callable $groups The validation groups. * @param array|callable $groups The validation groups
* @param FormInterface $form The validated form. * @param FormInterface $form The validated form
* *
* @return array The validation groups. * @return array The validation groups
*/ */
private static function resolveValidationGroups($groups, FormInterface $form) private static function resolveValidationGroups($groups, FormInterface $form)
{ {

View File

@ -55,9 +55,9 @@ class MappingRule
* If the rule matches, the form mapped by the rule is returned. * If the rule matches, the form mapped by the rule is returned.
* Otherwise this method returns false. * Otherwise this method returns false.
* *
* @param string $propertyPath The property path to match against the rule. * @param string $propertyPath The property path to match against the rule
* *
* @return null|FormInterface The mapped form or null. * @return null|FormInterface The mapped form or null
*/ */
public function match($propertyPath) public function match($propertyPath)
{ {
@ -69,9 +69,9 @@ class MappingRule
/** /**
* Matches a property path against a prefix of the rule path. * Matches a property path against a prefix of the rule path.
* *
* @param string $propertyPath The property path to match against the rule. * @param string $propertyPath The property path to match against the rule
* *
* @return bool Whether the property path is a prefix of the rule or not. * @return bool Whether the property path is a prefix of the rule or not
*/ */
public function isPrefix($propertyPath) public function isPrefix($propertyPath)
{ {

View File

@ -141,10 +141,10 @@ class ViolationMapper implements ViolationMapperInterface
* If a matching child is found, it is returned. Otherwise * If a matching child is found, it is returned. Otherwise
* null is returned. * null is returned.
* *
* @param FormInterface $form The form to search. * @param FormInterface $form The form to search
* @param PropertyPathIteratorInterface $it The iterator at its current position. * @param PropertyPathIteratorInterface $it The iterator at its current position
* *
* @return null|FormInterface The found match or null. * @return null|FormInterface The found match or null
*/ */
private function matchChild(FormInterface $form, PropertyPathIteratorInterface $it) private function matchChild(FormInterface $form, PropertyPathIteratorInterface $it)
{ {
@ -212,10 +212,10 @@ class ViolationMapper implements ViolationMapperInterface
/** /**
* Reconstructs a property path from a violation path and a form tree. * Reconstructs a property path from a violation path and a form tree.
* *
* @param ViolationPath $violationPath The violation path. * @param ViolationPath $violationPath The violation path
* @param FormInterface $origin The root form of the tree. * @param FormInterface $origin The root form of the tree
* *
* @return RelativePath The reconstructed path. * @return RelativePath The reconstructed path
*/ */
private function reconstructPath(ViolationPath $violationPath, FormInterface $origin) private function reconstructPath(ViolationPath $violationPath, FormInterface $origin)
{ {

View File

@ -23,7 +23,7 @@ interface ViolationMapperInterface
* Maps a constraint violation to a form in the form tree under * Maps a constraint violation to a form in the form tree under
* the given form. * the given form.
* *
* @param ConstraintViolation $violation The violation to map. * @param ConstraintViolation $violation The violation to map
* @param FormInterface $form The root form of the tree * @param FormInterface $form The root form of the tree
* to map it to. * to map it to.
* @param bool $allowNonSynchronized Whether to allow * @param bool $allowNonSynchronized Whether to allow

View File

@ -206,9 +206,9 @@ class ViolationPath implements \IteratorAggregate, PropertyPathInterface
* In this example, "address" and "office" map to forms, while * In this example, "address" and "office" map to forms, while
* "street does not. * "street does not.
* *
* @param int $index The element index. * @param int $index The element index
* *
* @return bool Whether the element maps to a form. * @return bool Whether the element maps to a form
* *
* @throws OutOfBoundsException If the offset is invalid. * @throws OutOfBoundsException If the offset is invalid.
*/ */

View File

@ -162,7 +162,7 @@ class Form implements \IteratorAggregate, FormInterface
/** /**
* Creates a new form based on the given configuration. * Creates a new form based on the given configuration.
* *
* @param FormConfigInterface $config The form configuration. * @param FormConfigInterface $config The form configuration
* *
* @throws LogicException if a data mapper is not provided for a compound form * @throws LogicException if a data mapper is not provided for a compound form
*/ */
@ -994,8 +994,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
* *
* @throws AlreadySubmittedException If the form has already been submitted. * @throws AlreadySubmittedException If the form has already been submitted.
* @throws LogicException When trying to add a child to a non-compound form. * @throws LogicException When trying to add a child to a non-compound form.

View File

@ -246,9 +246,9 @@ class FormBuilder extends FormConfigBuilder implements \IteratorAggregate, FormB
/** /**
* Converts an unresolved child into a {@link FormBuilder} instance. * Converts an unresolved child into a {@link FormBuilder} instance.
* *
* @param string $name The name of the unresolved child. * @param string $name The name of the unresolved child
* *
* @return FormBuilder The created instance. * @return FormBuilder The created instance
*/ */
private function resolveChild($name) private function resolveChild($name)
{ {

View File

@ -27,7 +27,7 @@ interface FormBuilderInterface extends \Traversable, \Countable, FormConfigBuild
* @param string|FormTypeInterface $type * @param string|FormTypeInterface $type
* @param array $options * @param array $options
* *
* @return FormBuilderInterface The builder object. * @return FormBuilderInterface The builder object
*/ */
public function add($child, $type = null, array $options = array()); public function add($child, $type = null, array $options = array());
@ -38,7 +38,7 @@ interface FormBuilderInterface extends \Traversable, \Countable, FormConfigBuild
* @param string|FormTypeInterface $type The type of the form or null if name is a property * @param string|FormTypeInterface $type The type of the form or null if name is a property
* @param array $options The options * @param array $options The options
* *
* @return FormBuilderInterface The created builder. * @return FormBuilderInterface The created builder
*/ */
public function create($name, $type = null, array $options = array()); public function create($name, $type = null, array $options = array());
@ -58,7 +58,7 @@ interface FormBuilderInterface extends \Traversable, \Countable, FormConfigBuild
* *
* @param string $name * @param string $name
* *
* @return FormBuilderInterface The builder object. * @return FormBuilderInterface The builder object
*/ */
public function remove($name); public function remove($name);

View File

@ -349,7 +349,7 @@ class FormConfigBuilder implements FormConfigBuilderInterface
/** /**
* Alias of {@link getInheritData()}. * Alias of {@link getInheritData()}.
* *
* @return FormConfigBuilder The configuration object. * @return FormConfigBuilder The configuration object
* *
* @deprecated since version 2.3, to be removed in 3.0. * @deprecated since version 2.3, to be removed in 3.0.
* Use {@link getInheritData()} instead. * Use {@link getInheritData()} instead.
@ -713,9 +713,9 @@ class FormConfigBuilder implements FormConfigBuilderInterface
/** /**
* Alias of {@link setInheritData()}. * Alias of {@link setInheritData()}.
* *
* @param bool $inheritData Whether the form should inherit its parent's data. * @param bool $inheritData Whether the form should inherit its parent's data
* *
* @return FormConfigBuilder The configuration object. * @return FormConfigBuilder The configuration object
* *
* @deprecated since version 2.3, to be removed in 3.0. * @deprecated since version 2.3, to be removed in 3.0.
* Use {@link setInheritData()} instead. * Use {@link setInheritData()} instead.
@ -882,7 +882,7 @@ class FormConfigBuilder implements FormConfigBuilderInterface
/** /**
* Validates whether the given variable is a valid form name. * Validates whether the given variable is a valid form name.
* *
* @param string|int $name The tested form name. * @param string|int $name The tested form name
* *
* @throws UnexpectedTypeException If the name is not a string or an integer. * @throws UnexpectedTypeException If the name is not a string or an integer.
* @throws InvalidArgumentException If the name contains invalid characters. * @throws InvalidArgumentException If the name contains invalid characters.
@ -911,9 +911,9 @@ class FormConfigBuilder implements FormConfigBuilderInterface
* * contains only letters, digits, numbers, underscores ("_"), * * contains only letters, digits, numbers, underscores ("_"),
* hyphens ("-") and colons (":") * hyphens ("-") and colons (":")
* *
* @param string $name The tested form name. * @param string $name The tested form name
* *
* @return bool Whether the name is valid. * @return bool Whether the name is valid
*/ */
public static function isValidName($name) public static function isValidName($name)
{ {

View File

@ -22,22 +22,22 @@ interface FormConfigBuilderInterface extends FormConfigInterface
/** /**
* Adds an event listener to an event on this form. * Adds an event listener to an event on this form.
* *
* @param string $eventName The name of the event to listen to. * @param string $eventName The name of the event to listen to
* @param callable $listener The listener to execute. * @param callable $listener The listener to execute
* @param int $priority The priority of the listener. Listeners * @param int $priority The priority of the listener. Listeners
* with a higher priority are called before * with a higher priority are called before
* listeners with a lower priority. * listeners with a lower priority.
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function addEventListener($eventName, $listener, $priority = 0); public function addEventListener($eventName, $listener, $priority = 0);
/** /**
* Adds an event subscriber for events on this form. * Adds an event subscriber for events on this form.
* *
* @param EventSubscriberInterface $subscriber The subscriber to attach. * @param EventSubscriberInterface $subscriber The subscriber to attach
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function addEventSubscriber(EventSubscriberInterface $subscriber); public function addEventSubscriber(EventSubscriberInterface $subscriber);
@ -52,14 +52,14 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* @param DataTransformerInterface $viewTransformer * @param DataTransformerInterface $viewTransformer
* @param bool $forcePrepend if set to true, prepend instead of appending * @param bool $forcePrepend if set to true, prepend instead of appending
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function addViewTransformer(DataTransformerInterface $viewTransformer, $forcePrepend = false); public function addViewTransformer(DataTransformerInterface $viewTransformer, $forcePrepend = false);
/** /**
* Clears the view transformers. * Clears the view transformers.
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function resetViewTransformers(); public function resetViewTransformers();
@ -74,14 +74,14 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* @param DataTransformerInterface $modelTransformer * @param DataTransformerInterface $modelTransformer
* @param bool $forceAppend if set to true, append instead of prepending * @param bool $forceAppend if set to true, append instead of prepending
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function addModelTransformer(DataTransformerInterface $modelTransformer, $forceAppend = false); public function addModelTransformer(DataTransformerInterface $modelTransformer, $forceAppend = false);
/** /**
* Clears the normalization transformers. * Clears the normalization transformers.
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function resetModelTransformers(); public function resetModelTransformers();
@ -91,16 +91,16 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* @param string $name The name of the attribute * @param string $name The name of the attribute
* @param mixed $value The value of the attribute * @param mixed $value The value of the attribute
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setAttribute($name, $value); public function setAttribute($name, $value);
/** /**
* Sets the attributes. * Sets the attributes.
* *
* @param array $attributes The attributes. * @param array $attributes The attributes
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setAttributes(array $attributes); public function setAttributes(array $attributes);
@ -109,7 +109,7 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* *
* @param DataMapperInterface $dataMapper * @param DataMapperInterface $dataMapper
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setDataMapper(DataMapperInterface $dataMapper = null); public function setDataMapper(DataMapperInterface $dataMapper = null);
@ -118,16 +118,16 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* *
* @param bool $disabled Whether the form is disabled * @param bool $disabled Whether the form is disabled
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setDisabled($disabled); public function setDisabled($disabled);
/** /**
* Sets the data used for the client data when no value is submitted. * Sets the data used for the client data when no value is submitted.
* *
* @param mixed $emptyData The empty data. * @param mixed $emptyData The empty data
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setEmptyData($emptyData); public function setEmptyData($emptyData);
@ -136,7 +136,7 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* *
* @param bool $errorBubbling * @param bool $errorBubbling
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setErrorBubbling($errorBubbling); public function setErrorBubbling($errorBubbling);
@ -145,7 +145,7 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* *
* @param bool $required * @param bool $required
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setRequired($required); public function setRequired($required);
@ -156,7 +156,7 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* The property path or null if the path should be set * The property path or null if the path should be set
* automatically based on the form's name. * automatically based on the form's name.
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setPropertyPath($propertyPath); public function setPropertyPath($propertyPath);
@ -164,9 +164,9 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* Sets whether the form should be mapped to an element of its * Sets whether the form should be mapped to an element of its
* parent's data. * parent's data.
* *
* @param bool $mapped Whether the form should be mapped. * @param bool $mapped Whether the form should be mapped
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setMapped($mapped); public function setMapped($mapped);
@ -176,25 +176,25 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* @param bool $byReference Whether the data should be * @param bool $byReference Whether the data should be
* modified by reference. * modified by reference.
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setByReference($byReference); public function setByReference($byReference);
/** /**
* Sets whether the form should read and write the data of its parent. * Sets whether the form should read and write the data of its parent.
* *
* @param bool $inheritData Whether the form should inherit its parent's data. * @param bool $inheritData Whether the form should inherit its parent's data
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setInheritData($inheritData); public function setInheritData($inheritData);
/** /**
* Sets whether the form should be compound. * Sets whether the form should be compound.
* *
* @param bool $compound Whether the form should be compound. * @param bool $compound Whether the form should be compound
* *
* @return self The configuration object. * @return self The configuration object
* *
* @see FormConfigInterface::getCompound() * @see FormConfigInterface::getCompound()
*/ */
@ -203,18 +203,18 @@ interface FormConfigBuilderInterface extends FormConfigInterface
/** /**
* Set the types. * Set the types.
* *
* @param ResolvedFormTypeInterface $type The type of the form. * @param ResolvedFormTypeInterface $type The type of the form
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setType(ResolvedFormTypeInterface $type); public function setType(ResolvedFormTypeInterface $type);
/** /**
* Sets the initial data of the form. * Sets the initial data of the form.
* *
* @param mixed $data The data of the form in application format. * @param mixed $data The data of the form in application format
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setData($data); public function setData($data);
@ -225,34 +225,34 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* this configuration. The data can only be modified then by * this configuration. The data can only be modified then by
* submitting the form. * submitting the form.
* *
* @param bool $locked Whether to lock the default data. * @param bool $locked Whether to lock the default data
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setDataLocked($locked); public function setDataLocked($locked);
/** /**
* Sets the form factory used for creating new forms. * Sets the form factory used for creating new forms.
* *
* @param FormFactoryInterface $formFactory The form factory. * @param FormFactoryInterface $formFactory The form factory
*/ */
public function setFormFactory(FormFactoryInterface $formFactory); public function setFormFactory(FormFactoryInterface $formFactory);
/** /**
* Sets the target URL of the form. * Sets the target URL of the form.
* *
* @param string $action The target URL of the form. * @param string $action The target URL of the form
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setAction($action); public function setAction($action);
/** /**
* Sets the HTTP method used by the form. * Sets the HTTP method used by the form.
* *
* @param string $method The HTTP method of the form. * @param string $method The HTTP method of the form
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setMethod($method); public function setMethod($method);
@ -261,7 +261,7 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* *
* @param RequestHandlerInterface $requestHandler * @param RequestHandlerInterface $requestHandler
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setRequestHandler(RequestHandlerInterface $requestHandler); public function setRequestHandler(RequestHandlerInterface $requestHandler);
@ -275,7 +275,7 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* In the second case, you need to call * In the second case, you need to call
* {@link FormInterface::initialize()} manually. * {@link FormInterface::initialize()} manually.
* *
* @return self The configuration object. * @return self The configuration object
*/ */
public function setAutoInitialize($initialize); public function setAutoInitialize($initialize);

View File

@ -24,21 +24,21 @@ interface FormConfigInterface
/** /**
* Returns the event dispatcher used to dispatch form events. * Returns the event dispatcher used to dispatch form events.
* *
* @return EventDispatcherInterface The dispatcher. * @return EventDispatcherInterface The dispatcher
*/ */
public function getEventDispatcher(); public function getEventDispatcher();
/** /**
* Returns the name of the form used as HTTP parameter. * Returns the name of the form used as HTTP parameter.
* *
* @return string The form name. * @return string The form name
*/ */
public function getName(); public function getName();
/** /**
* Returns the property path that the form should be mapped to. * Returns the property path that the form should be mapped to.
* *
* @return null|PropertyPathInterface The property path. * @return null|PropertyPathInterface The property path
*/ */
public function getPropertyPath(); public function getPropertyPath();
@ -46,21 +46,21 @@ interface FormConfigInterface
* Returns whether the form should be mapped to an element of its * Returns whether the form should be mapped to an element of its
* parent's data. * parent's data.
* *
* @return bool Whether the form is mapped. * @return bool Whether the form is mapped
*/ */
public function getMapped(); public function getMapped();
/** /**
* Returns whether the form's data should be modified by reference. * Returns whether the form's data should be modified by reference.
* *
* @return bool Whether to modify the form's data by reference. * @return bool Whether to modify the form's data by reference
*/ */
public function getByReference(); public function getByReference();
/** /**
* Returns whether the form should read and write the data of its parent. * Returns whether the form should read and write the data of its parent.
* *
* @return bool Whether the form should inherit its parent's data. * @return bool Whether the form should inherit its parent's data
*/ */
public function getInheritData(); public function getInheritData();
@ -71,103 +71,103 @@ interface FormConfigInterface
* children. A form can be compound and have no children at all, like * children. A form can be compound and have no children at all, like
* for example an empty collection form. * for example an empty collection form.
* *
* @return bool Whether the form is compound. * @return bool Whether the form is compound
*/ */
public function getCompound(); public function getCompound();
/** /**
* Returns the form types used to construct the form. * Returns the form types used to construct the form.
* *
* @return ResolvedFormTypeInterface The form's type. * @return ResolvedFormTypeInterface The form's type
*/ */
public function getType(); public function getType();
/** /**
* Returns the view transformers of the form. * Returns the view transformers of the form.
* *
* @return DataTransformerInterface[] An array of {@link DataTransformerInterface} instances. * @return DataTransformerInterface[] An array of {@link DataTransformerInterface} instances
*/ */
public function getViewTransformers(); public function getViewTransformers();
/** /**
* Returns the model transformers of the form. * Returns the model transformers of the form.
* *
* @return DataTransformerInterface[] An array of {@link DataTransformerInterface} instances. * @return DataTransformerInterface[] An array of {@link DataTransformerInterface} instances
*/ */
public function getModelTransformers(); public function getModelTransformers();
/** /**
* Returns the data mapper of the form. * Returns the data mapper of the form.
* *
* @return DataMapperInterface The data mapper. * @return DataMapperInterface The data mapper
*/ */
public function getDataMapper(); public function getDataMapper();
/** /**
* Returns whether the form is required. * Returns whether the form is required.
* *
* @return bool Whether the form is required. * @return bool Whether the form is required
*/ */
public function getRequired(); public function getRequired();
/** /**
* Returns whether the form is disabled. * Returns whether the form is disabled.
* *
* @return bool Whether the form is disabled. * @return bool Whether the form is disabled
*/ */
public function getDisabled(); public function getDisabled();
/** /**
* Returns whether errors attached to the form will bubble to its parent. * Returns whether errors attached to the form will bubble to its parent.
* *
* @return bool Whether errors will bubble up. * @return bool Whether errors will bubble up
*/ */
public function getErrorBubbling(); public function getErrorBubbling();
/** /**
* Returns the data that should be returned when the form is empty. * Returns the data that should be returned when the form is empty.
* *
* @return mixed The data returned if the form is empty. * @return mixed The data returned if the form is empty
*/ */
public function getEmptyData(); public function getEmptyData();
/** /**
* Returns additional attributes of the form. * Returns additional attributes of the form.
* *
* @return array An array of key-value combinations. * @return array An array of key-value combinations
*/ */
public function getAttributes(); public function getAttributes();
/** /**
* Returns whether the attribute with the given name exists. * Returns whether the attribute with the given name exists.
* *
* @param string $name The attribute name. * @param string $name The attribute name
* *
* @return bool Whether the attribute exists. * @return bool Whether the attribute exists
*/ */
public function hasAttribute($name); public function hasAttribute($name);
/** /**
* Returns the value of the given attribute. * Returns the value of the given attribute.
* *
* @param string $name The attribute name. * @param string $name The attribute name
* @param mixed $default The value returned if the attribute does not exist. * @param mixed $default The value returned if the attribute does not exist
* *
* @return mixed The attribute value. * @return mixed The attribute value
*/ */
public function getAttribute($name, $default = null); public function getAttribute($name, $default = null);
/** /**
* Returns the initial data of the form. * Returns the initial data of the form.
* *
* @return mixed The initial form data. * @return mixed The initial form data
*/ */
public function getData(); public function getData();
/** /**
* Returns the class of the form data or null if the data is scalar or an array. * Returns the class of the form data or null if the data is scalar or an array.
* *
* @return string The data class or null. * @return string The data class or null
*/ */
public function getDataClass(); public function getDataClass();
@ -178,35 +178,35 @@ interface FormConfigInterface
* this configuration. The data can only be modified then by * this configuration. The data can only be modified then by
* submitting the form. * submitting the form.
* *
* @return bool Whether the data is locked. * @return bool Whether the data is locked
*/ */
public function getDataLocked(); public function getDataLocked();
/** /**
* Returns the form factory used for creating new forms. * Returns the form factory used for creating new forms.
* *
* @return FormFactoryInterface The form factory. * @return FormFactoryInterface The form factory
*/ */
public function getFormFactory(); public function getFormFactory();
/** /**
* Returns the target URL of the form. * Returns the target URL of the form.
* *
* @return string The target URL of the form. * @return string The target URL of the form
*/ */
public function getAction(); public function getAction();
/** /**
* Returns the HTTP method used by the form. * Returns the HTTP method used by the form.
* *
* @return string The HTTP method of the form. * @return string The HTTP method of the form
*/ */
public function getMethod(); public function getMethod();
/** /**
* Returns the request handler used by the form. * Returns the request handler used by the form.
* *
* @return RequestHandlerInterface The request handler. * @return RequestHandlerInterface The request handler
*/ */
public function getRequestHandler(); public function getRequestHandler();
@ -221,7 +221,7 @@ interface FormConfigInterface
/** /**
* Returns all options passed during the construction of the form. * Returns all options passed during the construction of the form.
* *
* @return array The passed options. * @return array The passed options
*/ */
public function getOptions(); public function getOptions();
@ -230,17 +230,17 @@ interface FormConfigInterface
* *
* @param string $name The option name, * @param string $name The option name,
* *
* @return bool Whether the option exists. * @return bool Whether the option exists
*/ */
public function hasOption($name); public function hasOption($name);
/** /**
* Returns the value of a specific option. * Returns the value of a specific option.
* *
* @param string $name The option name. * @param string $name The option name
* @param mixed $default The value returned if the option does not exist. * @param mixed $default The value returned if the option does not exist
* *
* @return mixed The option value. * @return mixed The option value
*/ */
public function getOption($name, $default = null); public function getOption($name, $default = null);
} }

View File

@ -99,7 +99,7 @@ class FormErrorIterator implements \RecursiveIterator, \SeekableIterator, \Array
/** /**
* Returns the iterated form. * Returns the iterated form.
* *
* @return FormInterface The form whose errors are iterated by this object. * @return FormInterface The form whose errors are iterated by this object
*/ */
public function getForm() public function getForm()
{ {
@ -128,7 +128,7 @@ class FormErrorIterator implements \RecursiveIterator, \SeekableIterator, \Array
/** /**
* Returns the current position of the iterator. * Returns the current position of the iterator.
* *
* @return int The 0-indexed position. * @return int The 0-indexed position
*/ */
public function key() public function key()
{ {
@ -138,7 +138,7 @@ class FormErrorIterator implements \RecursiveIterator, \SeekableIterator, \Array
/** /**
* Returns whether the iterator's position is valid. * Returns whether the iterator's position is valid.
* *
* @return bool Whether the iterator is valid. * @return bool Whether the iterator is valid
*/ */
public function valid() public function valid()
{ {

View File

@ -163,9 +163,9 @@ class FormFactory implements FormFactoryInterface
* Wraps a type into a ResolvedFormTypeInterface implementation and connects * Wraps a type into a ResolvedFormTypeInterface implementation and connects
* it with its parent type. * it with its parent type.
* *
* @param FormTypeInterface $type The type to resolve. * @param FormTypeInterface $type The type to resolve
* *
* @return ResolvedFormTypeInterface The resolved type. * @return ResolvedFormTypeInterface The resolved type
*/ */
private function resolveType(FormTypeInterface $type) private function resolveType(FormTypeInterface $type)
{ {

View File

@ -23,86 +23,86 @@ interface FormFactoryBuilderInterface
* *
* @param ResolvedFormTypeFactoryInterface $resolvedTypeFactory * @param ResolvedFormTypeFactoryInterface $resolvedTypeFactory
* *
* @return FormFactoryBuilderInterface The builder. * @return FormFactoryBuilderInterface The builder
*/ */
public function setResolvedTypeFactory(ResolvedFormTypeFactoryInterface $resolvedTypeFactory); public function setResolvedTypeFactory(ResolvedFormTypeFactoryInterface $resolvedTypeFactory);
/** /**
* Adds an extension to be loaded by the factory. * Adds an extension to be loaded by the factory.
* *
* @param FormExtensionInterface $extension The extension. * @param FormExtensionInterface $extension The extension
* *
* @return FormFactoryBuilderInterface The builder. * @return FormFactoryBuilderInterface The builder
*/ */
public function addExtension(FormExtensionInterface $extension); public function addExtension(FormExtensionInterface $extension);
/** /**
* Adds a list of extensions to be loaded by the factory. * Adds a list of extensions to be loaded by the factory.
* *
* @param FormExtensionInterface[] $extensions The extensions. * @param FormExtensionInterface[] $extensions The extensions
* *
* @return FormFactoryBuilderInterface The builder. * @return FormFactoryBuilderInterface The builder
*/ */
public function addExtensions(array $extensions); public function addExtensions(array $extensions);
/** /**
* Adds a form type to the factory. * Adds a form type to the factory.
* *
* @param FormTypeInterface $type The form type. * @param FormTypeInterface $type The form type
* *
* @return FormFactoryBuilderInterface The builder. * @return FormFactoryBuilderInterface The builder
*/ */
public function addType(FormTypeInterface $type); public function addType(FormTypeInterface $type);
/** /**
* Adds a list of form types to the factory. * Adds a list of form types to the factory.
* *
* @param FormTypeInterface[] $types The form types. * @param FormTypeInterface[] $types The form types
* *
* @return FormFactoryBuilderInterface The builder. * @return FormFactoryBuilderInterface The builder
*/ */
public function addTypes(array $types); public function addTypes(array $types);
/** /**
* Adds a form type extension to the factory. * Adds a form type extension to the factory.
* *
* @param FormTypeExtensionInterface $typeExtension The form type extension. * @param FormTypeExtensionInterface $typeExtension The form type extension
* *
* @return FormFactoryBuilderInterface The builder. * @return FormFactoryBuilderInterface The builder
*/ */
public function addTypeExtension(FormTypeExtensionInterface $typeExtension); public function addTypeExtension(FormTypeExtensionInterface $typeExtension);
/** /**
* Adds a list of form type extensions to the factory. * Adds a list of form type extensions to the factory.
* *
* @param FormTypeExtensionInterface[] $typeExtensions The form type extensions. * @param FormTypeExtensionInterface[] $typeExtensions The form type extensions
* *
* @return FormFactoryBuilderInterface The builder. * @return FormFactoryBuilderInterface The builder
*/ */
public function addTypeExtensions(array $typeExtensions); public function addTypeExtensions(array $typeExtensions);
/** /**
* Adds a type guesser to the factory. * Adds a type guesser to the factory.
* *
* @param FormTypeGuesserInterface $typeGuesser The type guesser. * @param FormTypeGuesserInterface $typeGuesser The type guesser
* *
* @return FormFactoryBuilderInterface The builder. * @return FormFactoryBuilderInterface The builder
*/ */
public function addTypeGuesser(FormTypeGuesserInterface $typeGuesser); public function addTypeGuesser(FormTypeGuesserInterface $typeGuesser);
/** /**
* Adds a list of type guessers to the factory. * Adds a list of type guessers to the factory.
* *
* @param FormTypeGuesserInterface[] $typeGuessers The type guessers. * @param FormTypeGuesserInterface[] $typeGuessers The type guessers
* *
* @return FormFactoryBuilderInterface The builder. * @return FormFactoryBuilderInterface The builder
*/ */
public function addTypeGuessers(array $typeGuessers); public function addTypeGuessers(array $typeGuessers);
/** /**
* Builds and returns the factory. * Builds and returns the factory.
* *
* @return FormFactoryInterface The form factory. * @return FormFactoryInterface The form factory
*/ */
public function getFormFactory(); public function getFormFactory();
} }

View File

@ -23,7 +23,7 @@ interface FormInterface extends \ArrayAccess, \Traversable, \Countable
/** /**
* Sets the parent form. * Sets the parent form.
* *
* @param FormInterface|null $parent The parent form or null if it's the root. * @param FormInterface|null $parent The parent form or null if it's the root
* *
* @return FormInterface The form instance * @return FormInterface The form instance
* *
@ -36,16 +36,16 @@ interface FormInterface extends \ArrayAccess, \Traversable, \Countable
/** /**
* Returns the parent form. * Returns the parent form.
* *
* @return FormInterface|null The parent form or null if there is none. * @return FormInterface|null The parent form or null if there is none
*/ */
public function getParent(); public function getParent();
/** /**
* Adds or replaces a child to the form. * Adds or replaces a child to the form.
* *
* @param FormInterface|string|int $child The FormInterface instance or the name of the child. * @param FormInterface|string|int $child The FormInterface instance or the name of the child
* @param string|null $type The child's type, if a name was passed. * @param string|null $type The child's type, if a name was passed
* @param array $options The child's options, if a name was passed. * @param array $options The child's options, if a name was passed
* *
* @return FormInterface The form instance * @return FormInterface The form instance
* *
@ -132,7 +132,7 @@ interface FormInterface extends \ArrayAccess, \Traversable, \Countable
/** /**
* Returns the normalized data of the field. * Returns the normalized data of the field.
* *
* @return mixed When the field is not submitted, the default data is returned. * @return mixed When the field is not submitted, the default data is returned
* When the field is submitted, the normalized submitted data is * When the field is submitted, the normalized submitted data is
* returned if the field is valid, null otherwise. * returned if the field is valid, null otherwise.
*/ */
@ -155,7 +155,7 @@ interface FormInterface extends \ArrayAccess, \Traversable, \Countable
/** /**
* Returns the form's configuration. * Returns the form's configuration.
* *
* @return FormConfigInterface The configuration. * @return FormConfigInterface The configuration
*/ */
public function getConfig(); public function getConfig();
@ -169,14 +169,14 @@ interface FormInterface extends \ArrayAccess, \Traversable, \Countable
/** /**
* Returns the name by which the form is identified in forms. * Returns the name by which the form is identified in forms.
* *
* @return string The name of the form. * @return string The name of the form
*/ */
public function getName(); public function getName();
/** /**
* Returns the property path that the form is mapped to. * Returns the property path that the form is mapped to.
* *
* @return \Symfony\Component\PropertyAccess\PropertyPathInterface The property path. * @return \Symfony\Component\PropertyAccess\PropertyPathInterface The property path
*/ */
public function getPropertyPath(); public function getPropertyPath();
@ -251,7 +251,7 @@ interface FormInterface extends \ArrayAccess, \Traversable, \Countable
* *
* Should be called on the root form after constructing the tree. * Should be called on the root form after constructing the tree.
* *
* @return FormInterface The form instance. * @return FormInterface The form instance
*/ */
public function initialize(); public function initialize();
@ -263,16 +263,16 @@ interface FormInterface extends \ArrayAccess, \Traversable, \Countable
* {@link RequestHandlerInterface} instance, which determines whether to * {@link RequestHandlerInterface} instance, which determines whether to
* submit the form or not. * submit the form or not.
* *
* @param mixed $request The request to handle. * @param mixed $request The request to handle
* *
* @return FormInterface The form instance. * @return FormInterface The form instance
*/ */
public function handleRequest($request = null); public function handleRequest($request = null);
/** /**
* Submits data to the form, transforms and validates it. * Submits data to the form, transforms and validates it.
* *
* @param null|string|array $submittedData The submitted data. * @param null|string|array $submittedData The submitted data
* @param bool $clearMissing Whether to set fields to NULL * @param bool $clearMissing Whether to set fields to NULL
* when they are missing in the * when they are missing in the
* submitted data. * submitted data.

View File

@ -53,7 +53,7 @@ class FormRegistry implements FormRegistryInterface
* Constructor. * Constructor.
* *
* @param FormExtensionInterface[] $extensions An array of FormExtensionInterface * @param FormExtensionInterface[] $extensions An array of FormExtensionInterface
* @param ResolvedFormTypeFactoryInterface $resolvedTypeFactory The factory for resolved form types. * @param ResolvedFormTypeFactoryInterface $resolvedTypeFactory The factory for resolved form types
* *
* @throws UnexpectedTypeException if any extension does not implement FormExtensionInterface * @throws UnexpectedTypeException if any extension does not implement FormExtensionInterface
*/ */
@ -107,9 +107,9 @@ class FormRegistry implements FormRegistryInterface
* Wraps a type into a ResolvedFormTypeInterface implementation and connects * Wraps a type into a ResolvedFormTypeInterface implementation and connects
* it with its parent type. * it with its parent type.
* *
* @param FormTypeInterface $type The type to resolve. * @param FormTypeInterface $type The type to resolve
* *
* @return ResolvedFormTypeInterface The resolved type. * @return ResolvedFormTypeInterface The resolved type
*/ */
private function resolveAndAddType(FormTypeInterface $type) private function resolveAndAddType(FormTypeInterface $type)
{ {

View File

@ -21,7 +21,7 @@ interface FormRendererEngineInterface
/** /**
* Sets the theme(s) to be used for rendering a view and its children. * Sets the theme(s) to be used for rendering a view and its children.
* *
* @param FormView $view The view to assign the theme(s) to. * @param FormView $view The view to assign the theme(s) to
* @param mixed $themes The theme(s). The type of these themes * @param mixed $themes The theme(s). The type of these themes
* is open to the implementation. * is open to the implementation.
*/ */
@ -36,13 +36,13 @@ interface FormRendererEngineInterface
* The type of the resource is decided by the implementation. The resource * The type of the resource is decided by the implementation. The resource
* is later passed to {@link renderBlock()} by the rendering algorithm. * is later passed to {@link renderBlock()} by the rendering algorithm.
* *
* @param FormView $view The view for determining the used themes. * @param FormView $view The view for determining the used themes
* First the themes attached directly to the * First the themes attached directly to the
* view with {@link setTheme()} are considered, * view with {@link setTheme()} are considered,
* then the ones of its parent etc. * then the ones of its parent etc.
* @param string $blockName The name of the block to render. * @param string $blockName The name of the block to render
* *
* @return mixed The renderer resource or false, if none was found. * @return mixed The renderer resource or false, if none was found
*/ */
public function getResourceForBlockName(FormView $view, $blockName); public function getResourceForBlockName(FormView $view, $blockName);
@ -70,7 +70,7 @@ interface FormRendererEngineInterface
* The type of the resource is decided by the implementation. The resource * The type of the resource is decided by the implementation. The resource
* is later passed to {@link renderBlock()} by the rendering algorithm. * is later passed to {@link renderBlock()} by the rendering algorithm.
* *
* @param FormView $view The view for determining the used themes. * @param FormView $view The view for determining the used themes
* First the themes attached directly to * First the themes attached directly to
* the view with {@link setTheme()} are * the view with {@link setTheme()} are
* considered, then the ones of its parent etc. * considered, then the ones of its parent etc.
@ -80,7 +80,7 @@ interface FormRendererEngineInterface
* looking. Level 0 indicates the root block, i.e. * looking. Level 0 indicates the root block, i.e.
* the first element of $blockNameHierarchy. * the first element of $blockNameHierarchy.
* *
* @return mixed The renderer resource or false, if none was found. * @return mixed The renderer resource or false, if none was found
*/ */
public function getResourceForBlockNameHierarchy(FormView $view, array $blockNameHierarchy, $hierarchyLevel); public function getResourceForBlockNameHierarchy(FormView $view, array $blockNameHierarchy, $hierarchyLevel);
@ -110,7 +110,7 @@ interface FormRendererEngineInterface
* The type of the resource is decided by the implementation. The resource * The type of the resource is decided by the implementation. The resource
* is later passed to {@link renderBlock()} by the rendering algorithm. * is later passed to {@link renderBlock()} by the rendering algorithm.
* *
* @param FormView $view The view for determining the used themes. * @param FormView $view The view for determining the used themes
* First the themes attached directly to * First the themes attached directly to
* the view with {@link setTheme()} are * the view with {@link setTheme()} are
* considered, then the ones of its parent etc. * considered, then the ones of its parent etc.
@ -120,7 +120,7 @@ interface FormRendererEngineInterface
* looking. Level 0 indicates the root block, i.e. * looking. Level 0 indicates the root block, i.e.
* the first element of $blockNameHierarchy. * the first element of $blockNameHierarchy.
* *
* @return int|bool The hierarchy level or false, if no resource was found. * @return int|bool The hierarchy level or false, if no resource was found
*/ */
public function getResourceHierarchyLevel(FormView $view, array $blockNameHierarchy, $hierarchyLevel); public function getResourceHierarchyLevel(FormView $view, array $blockNameHierarchy, $hierarchyLevel);
@ -131,12 +131,12 @@ interface FormRendererEngineInterface
* or {@link getResourceForBlockHierarchy()}. The type of the resource is * or {@link getResourceForBlockHierarchy()}. The type of the resource is
* decided by the implementation. * decided by the implementation.
* *
* @param FormView $view The view to render. * @param FormView $view The view to render
* @param mixed $resource The renderer resource. * @param mixed $resource The renderer resource
* @param string $blockName The name of the block to render. * @param string $blockName The name of the block to render
* @param array $variables The variables to pass to the template. * @param array $variables The variables to pass to the template
* *
* @return string The HTML markup. * @return string The HTML markup
*/ */
public function renderBlock(FormView $view, $resource, $blockName, array $variables = array()); public function renderBlock(FormView $view, $resource, $blockName, array $variables = array());
} }

View File

@ -21,14 +21,14 @@ interface FormRendererInterface
/** /**
* Returns the engine used by this renderer. * Returns the engine used by this renderer.
* *
* @return FormRendererEngineInterface The renderer engine. * @return FormRendererEngineInterface The renderer engine
*/ */
public function getEngine(); public function getEngine();
/** /**
* Sets the theme(s) to be used for rendering a view and its children. * Sets the theme(s) to be used for rendering a view and its children.
* *
* @param FormView $view The view to assign the theme(s) to. * @param FormView $view The view to assign the theme(s) to
* @param mixed $themes The theme(s). The type of these themes * @param mixed $themes The theme(s). The type of these themes
* is open to the implementation. * is open to the implementation.
*/ */
@ -37,9 +37,9 @@ interface FormRendererInterface
/** /**
* Renders a named block of the form theme. * Renders a named block of the form theme.
* *
* @param FormView $view The view for which to render the block. * @param FormView $view The view for which to render the block
* @param string $blockName The name of the block. * @param string $blockName The name of the block
* @param array $variables The variables to pass to the template. * @param array $variables The variables to pass to the template
* *
* @return string The HTML markup * @return string The HTML markup
*/ */
@ -55,9 +55,9 @@ interface FormRendererInterface
* If this method is called recursively, the block search is continued * If this method is called recursively, the block search is continued
* where a block was found before. * where a block was found before.
* *
* @param FormView $view The view for which to render the block. * @param FormView $view The view for which to render the block
* @param string $blockNameSuffix The suffix of the block name. * @param string $blockNameSuffix The suffix of the block name
* @param array $variables The variables to pass to the template. * @param array $variables The variables to pass to the template
* *
* @return string The HTML markup * @return string The HTML markup
*/ */
@ -95,9 +95,9 @@ interface FormRendererInterface
* of the resulting string is capitalized, while all other letters are * of the resulting string is capitalized, while all other letters are
* turned to lowercase. * turned to lowercase.
* *
* @param string $text The text to humanize. * @param string $text The text to humanize
* *
* @return string The humanized text. * @return string The humanized text
*/ */
public function humanize($text); public function humanize($text);
} }

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