Remove useless docblocks

This commit is contained in:
Nicolas Grekas 2017-10-28 20:51:46 +02:00
parent 711bdc950d
commit 2443511324
223 changed files with 263 additions and 1444 deletions

View File

@ -22,11 +22,11 @@ use Symfony\Component\Config\Resource\FileResource;
*/
class DoctrineValidationPass implements CompilerPassInterface
{
/**
* @var string
*/
private $managerType;
/**
* @param string $managerType
*/
public function __construct($managerType)
{
$this->managerType = $managerType;

View File

@ -26,9 +26,6 @@ use Symfony\Component\DependencyInjection\Reference;
*/
class RegisterEventListenersAndSubscribersPass implements CompilerPassInterface
{
/**
* @var string|string[]
*/
private $connections;
private $eventManagers;
private $managerTemplate;

View File

@ -113,7 +113,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
* present to enable the mapping. Set to false
* to not do any check, optional.
* @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
* @param string[] $aliasMap Map of alias to namespace
*/
@ -178,7 +178,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
/**
* Create the service definition for the metadata driver.
*
* @param ContainerBuilder $container passed on in case an extending class
* @param ContainerBuilder $container Passed on in case an extending class
* needs access to the container
*
* @return Definition|Reference the metadata driver to add to all chain drivers

View File

@ -20,9 +20,6 @@ use Symfony\Component\ExpressionLanguage\ParserCache\ParserCacheInterface;
*/
class DoctrineParserCache implements ParserCacheInterface
{
/**
* @var Cache
*/
private $cache;
public function __construct(Cache $cache)

View File

@ -23,29 +23,10 @@ use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
*/
class DoctrineChoiceLoader implements ChoiceLoaderInterface
{
/**
* @var ChoiceListFactoryInterface
*/
private $factory;
/**
* @var ObjectManager
*/
private $manager;
/**
* @var string
*/
private $class;
/**
* @var IdReader
*/
private $idReader;
/**
* @var null|EntityLoaderInterface
*/
private $objectLoader;
/**
@ -60,13 +41,10 @@ class DoctrineChoiceLoader implements ChoiceLoaderInterface
* passed which optimizes the object loading for one of the Doctrine
* mapper implementations.
*
* @param ChoiceListFactoryInterface $factory The factory for creating
* the loaded choice list
* @param ChoiceListFactoryInterface $factory The factory for creating the loaded choice list
* @param ObjectManager $manager The object manager
* @param string $class The class name of the
* loaded objects
* @param IdReader $idReader the reader for the object
* IDs
* @param string $class The class name of the loaded objects
* @param IdReader $idReader The reader for the object IDs
* @param null|EntityLoaderInterface $objectLoader The objects loader
*/
public function __construct(ChoiceListFactoryInterface $factory, ObjectManager $manager, $class, IdReader $idReader = null, EntityLoaderInterface $objectLoader = null)

View File

@ -24,29 +24,10 @@ use Symfony\Component\Form\Exception\RuntimeException;
*/
class IdReader
{
/**
* @var ObjectManager
*/
private $om;
/**
* @var ClassMetadata
*/
private $classMetadata;
/**
* @var bool
*/
private $singleId;
/**
* @var bool
*/
private $intId;
/**
* @var string
*/
private $idField;
/**

View File

@ -25,14 +25,7 @@ class DoctrineOrmExtension extends AbstractExtension
{
protected $registry;
/**
* @var PropertyAccessorInterface
*/
private $propertyAccessor;
/**
* @var ChoiceListFactoryInterface
*/
private $choiceListFactory;
public function __construct(ManagerRegistry $registry, PropertyAccessorInterface $propertyAccessor = null, ChoiceListFactoryInterface $choiceListFactory = null)

View File

@ -25,9 +25,6 @@ use Symfony\Component\Validator\ConstraintValidator;
*/
class UniqueEntityValidator extends ConstraintValidator
{
/**
* @var ManagerRegistry
*/
private $registry;
public function __construct(ManagerRegistry $registry)

View File

@ -25,19 +25,8 @@ use Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface;
*/
class ProxyDumper implements DumperInterface
{
/**
* @var string
*/
private $salt;
/**
* @var LazyLoadingValueHolderGenerator
*/
private $proxyGenerator;
/**
* @var BaseGeneratorStrategy
*/
private $classGenerator;
/**

View File

@ -23,10 +23,6 @@ use Twig\Extension\AbstractExtension;
class StopwatchExtension extends AbstractExtension
{
private $stopwatch;
/**
* @var bool
*/
private $enabled;
public function __construct(Stopwatch $stopwatch = null, $enabled = true)

View File

@ -30,9 +30,6 @@ use Twig\NodeVisitor\AbstractNodeVisitor;
*/
class TranslationDefaultDomainNodeVisitor extends AbstractNodeVisitor
{
/**
* @var Scope
*/
private $scope;
public function __construct()

View File

@ -42,11 +42,6 @@ class TwigExtractor extends AbstractFileExtractor implements ExtractorInterface
*/
private $prefix = '';
/**
* The twig environment.
*
* @var Environment
*/
private $twig;
public function __construct(Environment $twig)

View File

@ -21,9 +21,6 @@ use Symfony\Component\DependencyInjection\ContainerInterface;
*/
class SessionListener extends BaseSessionListener
{
/**
* @var ContainerInterface
*/
private $container;
public function __construct(ContainerInterface $container)

View File

@ -43,8 +43,8 @@ class TranslationLoader
/**
* Loads translation messages from a directory to the catalogue.
*
* @param string $directory the directory to look into
* @param MessageCatalogue $catalogue the catalogue
* @param string $directory The directory to look into
* @param MessageCatalogue $catalogue The catalogue
*/
public function loadMessages($directory, MessageCatalogue $catalogue)
{

View File

@ -31,12 +31,12 @@ use Twig\Loader\ExistsLoaderInterface;
class ExceptionController
{
protected $twig;
/**
* @var bool Show error (false) or exception (true) pages by default
*/
protected $debug;
/**
* @param Environment $twig
* @param bool $debug Show error (false) or exception (true) pages by default
*/
public function __construct(Environment $twig, $debug)
{
$this->twig = $twig;

View File

@ -49,12 +49,6 @@ namespace Symfony\Component\ClassLoader;
class XcacheClassLoader
{
private $prefix;
/**
* A class loader object that implements the findFile() method.
*
* @var object
*/
private $decorated;
/**

View File

@ -19,9 +19,6 @@ namespace Symfony\Component\Config;
*/
class ConfigCacheFactory implements ConfigCacheFactoryInterface
{
/**
* @var bool Debug flag passed to the ConfigCache
*/
private $debug;
/**

View File

@ -81,7 +81,7 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
/**
* Sets the xml remappings that should be performed.
*
* @param array $remappings an array of the form array(array(string, string))
* @param array $remappings An array of the form array(array(string, string))
*/
public function setXmlRemappings(array $remappings)
{

View File

@ -67,7 +67,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
/**
* Sets a prototype for child nodes.
*
* @param string $type the type of node
* @param string $type The type of node
*
* @return NodeDefinition
*/
@ -97,7 +97,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
*
* This method is applicable to prototype nodes only.
*
* @param int|string|array|null $children the number of children|The child name|The children names to be added
* @param int|string|array|null $children The number of children|The child name|The children names to be added
*
* @return $this
*/

View File

@ -61,7 +61,7 @@ class NodeBuilder implements NodeParentInterface
/**
* Creates a child scalar node.
*
* @param string $name the name of the node
* @param string $name The name of the node
*
* @return ScalarNodeDefinition The child node
*/
@ -85,7 +85,7 @@ class NodeBuilder implements NodeParentInterface
/**
* Creates a child integer node.
*
* @param string $name the name of the node
* @param string $name The name of the node
*
* @return IntegerNodeDefinition The child node
*/
@ -97,7 +97,7 @@ class NodeBuilder implements NodeParentInterface
/**
* Creates a child float node.
*
* @param string $name the name of the node
* @param string $name The name of the node
*
* @return FloatNodeDefinition The child node
*/

View File

@ -27,8 +27,6 @@ final class ConsoleEvents
* instance.
*
* @Event
*
* @var string
*/
const COMMAND = 'console.command';
@ -40,8 +38,6 @@ final class ConsoleEvents
* instance.
*
* @Event
*
* @var string
*/
const TERMINATE = 'console.terminate';
@ -54,8 +50,6 @@ final class ConsoleEvents
* instance.
*
* @Event
*
* @var string
*/
const EXCEPTION = 'console.exception';
}

View File

@ -25,8 +25,6 @@ class ConsoleCommandEvent extends ConsoleEvent
/**
* Indicates if the command should be run or skipped.
*
* @var bool
*/
private $commandShouldRun = true;

View File

@ -22,7 +22,6 @@ use Symfony\Component\Console\Output\OutputInterface;
*/
class ProgressBar
{
// options
private $barWidth = 28;
private $barChar;
private $emptyBarChar = '-';
@ -30,10 +29,6 @@ class ProgressBar
private $format;
private $internalFormat;
private $redrawFreq = 1;
/**
* @var OutputInterface
*/
private $output;
private $step = 0;
private $max;

View File

@ -29,9 +29,6 @@ class TableHelper extends Helper
const LAYOUT_BORDERLESS = 1;
const LAYOUT_COMPACT = 2;
/**
* @var Table
*/
private $table;
public function __construct($triggerDeprecationError = true)

View File

@ -307,7 +307,7 @@ class InputDefinition
/**
* Gets an InputOption by shortcut.
*
* @param string $shortcut the Shortcut name
* @param string $shortcut The Shortcut name
*
* @return InputOption An InputOption object
*/

View File

@ -16,9 +16,6 @@ namespace Symfony\Component\Console\Output;
*/
class BufferedOutput extends Output
{
/**
* @var string
*/
private $buffer = '';
/**

View File

@ -28,9 +28,6 @@ use Symfony\Component\Console\Formatter\OutputFormatterInterface;
*/
class ConsoleOutput extends StreamOutput implements ConsoleOutputInterface
{
/**
* @var StreamOutput
*/
private $stderr;
/**

View File

@ -21,14 +21,7 @@ namespace Symfony\Component\CssSelector\Node;
*/
class ElementNode extends AbstractNode
{
/**
* @var string|null
*/
private $namespace;
/**
* @var string|null
*/
private $element;
/**

View File

@ -21,19 +21,8 @@ namespace Symfony\Component\CssSelector\Parser;
*/
class Reader
{
/**
* @var string
*/
private $source;
/**
* @var int
*/
private $length;
/**
* @var int
*/
private $position = 0;
/**

View File

@ -29,19 +29,8 @@ class Token
const TYPE_NUMBER = 'number';
const TYPE_STRING = 'string';
/**
* @var int
*/
private $type;
/**
* @var string
*/
private $value;
/**
* @var int
*/
private $position;
/**

View File

@ -21,64 +21,17 @@ namespace Symfony\Component\CssSelector\Parser\Tokenizer;
*/
class TokenizerPatterns
{
/**
* @var string
*/
private $unicodeEscapePattern;
/**
* @var string
*/
private $simpleEscapePattern;
/**
* @var string
*/
private $newLineEscapePattern;
/**
* @var string
*/
private $escapePattern;
/**
* @var string
*/
private $stringEscapePattern;
/**
* @var string
*/
private $nonAsciiPattern;
/**
* @var string
*/
private $nmCharPattern;
/**
* @var string
*/
private $nmStartPattern;
/**
* @var string
*/
private $identifierPattern;
/**
* @var string
*/
private $hashPattern;
/**
* @var string
*/
private $numberPattern;
/**
* @var string
*/
private $quotedStringPattern;
public function __construct()

View File

@ -29,9 +29,6 @@ class NodeExtension extends AbstractExtension
const ATTRIBUTE_NAME_IN_LOWER_CASE = 2;
const ATTRIBUTE_VALUE_IN_LOWER_CASE = 4;
/**
* @var int
*/
private $flags;
/**

View File

@ -21,19 +21,8 @@ namespace Symfony\Component\CssSelector\XPath;
*/
class XPathExpr
{
/**
* @var string
*/
private $path;
/**
* @var string
*/
private $element;
/**
* @var string
*/
private $condition;
/**

View File

@ -26,9 +26,6 @@ class RepeatedPass implements CompilerPassInterface
*/
private $repeat = false;
/**
* @var RepeatablePassInterface[]
*/
private $passes;
/**

View File

@ -104,7 +104,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
* If you are not using the loaders and therefore don't want
* to depend on the Config component, set this flag to false.
*
* @param bool $track true if you want to track resources, false otherwise
* @param bool $track True if you want to track resources, false otherwise
*/
public function setResourceTracking($track)
{
@ -114,7 +114,7 @@ class ContainerBuilder extends Container implements TaggedContainerInterface
/**
* Checks if resources are tracked.
*
* @return bool true if resources are tracked, false otherwise
* @return bool true If resources are tracked, false otherwise
*/
public function isTrackingResources()
{

View File

@ -38,15 +38,11 @@ class PhpDumper extends Dumper
{
/**
* Characters that might appear in the generated variable name as first character.
*
* @var string
*/
const FIRST_CHARS = 'abcdefghijklmnopqrstuvwxyz';
/**
* Characters that might appear in the generated variable name as any but the first character.
*
* @var string
*/
const NON_FIRST_CHARS = 'abcdefghijklmnopqrstuvwxyz0123456789_';

View File

@ -25,11 +25,10 @@ interface InstantiatorInterface
/**
* Instantiates a proxy object.
*
* @param ContainerInterface $container the container from which the service is being requested
* @param Definition $definition the definition of the requested service
* @param string $id identifier of the requested service
* @param callable $realInstantiator zero-argument callback that is capable of producing the real
* service instance
* @param ContainerInterface $container The container from which the service is being requested
* @param Definition $definition The definition of the requested service
* @param string $id Identifier of the requested service
* @param callable $realInstantiator Zero-argument callback that is capable of producing the real service instance
*
* @return object
*/

View File

@ -31,7 +31,7 @@ interface DumperInterface
* Generates the code to be used to instantiate a proxy in the dumped factory code.
*
* @param Definition $definition
* @param string $id service identifier
* @param string $id Service identifier
*
* @return string
*/

View File

@ -20,9 +20,6 @@ use Symfony\Component\CssSelector\CssSelector;
*/
class Crawler extends \SplObjectStorage
{
/**
* @var string The current URI
*/
protected $uri;
/**
@ -41,14 +38,14 @@ class Crawler extends \SplObjectStorage
private $baseHref;
/**
* @param mixed $node A Node to use as the base for the crawling
* @param string $currentUri The current URI
* @param string $baseHref The base href value
* @param mixed $node A Node to use as the base for the crawling
* @param string $uri The current URI
* @param string $baseHref The base href value
*/
public function __construct($node = null, $currentUri = null, $baseHref = null)
public function __construct($node = null, $uri = null, $baseHref = null)
{
$this->uri = $currentUri;
$this->baseHref = $baseHref ?: $currentUri;
$this->uri = $uri;
$this->baseHref = $baseHref ?: $uri;
$this->add($node);
}

View File

@ -19,19 +19,8 @@ use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
*/
class RegisterListenersPass implements CompilerPassInterface
{
/**
* @var string
*/
protected $dispatcherService;
/**
* @var string
*/
protected $listenerTag;
/**
* @var string
*/
protected $subscriberTag;
/**

View File

@ -26,7 +26,7 @@ interface EventDispatcherInterface
* @param string $eventName The name of the event to dispatch. The name of
* the event is the name of the method that is
* 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
*
* @return Event

View File

@ -20,22 +20,13 @@ namespace Symfony\Component\EventDispatcher;
*/
class GenericEvent extends Event implements \ArrayAccess, \IteratorAggregate
{
/**
* Event subject.
*
* @var mixed usually object or callable
*/
protected $subject;
/**
* Array of arguments.
*/
protected $arguments;
/**
* 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 or a callable
* @param array $arguments Arguments to store in the event
*/
public function __construct($subject = null, array $arguments = array())

View File

@ -21,9 +21,6 @@ use Symfony\Component\ExpressionLanguage\ParserCache\ParserCacheInterface;
*/
class ExpressionLanguage
{
/**
* @var ParserCacheInterface
*/
private $cache;
private $lexer;
private $parser;

View File

@ -56,7 +56,7 @@ class LockHandler
/**
* Lock the resource.
*
* @param bool $blocking wait until the lock is released
* @param bool $blocking Wait until the lock is released
*
* @return bool Returns true if the lock was acquired, false otherwise
*

View File

@ -66,7 +66,7 @@ class FilesystemTestCase extends TestCase
}
/**
* @param int $expectedFilePerms expected file permissions as three digits (i.e. 755)
* @param int $expectedFilePerms Expected file permissions as three digits (i.e. 755)
* @param string $filePath
*/
protected function assertFilePermissions($expectedFilePerms, $filePath)

View File

@ -26,9 +26,6 @@ use Symfony\Component\Finder\Comparator\DateComparator;
*/
abstract class AbstractFindAdapter extends AbstractAdapter
{
/**
* @var Shell
*/
protected $shell;
public function __construct()

View File

@ -18,9 +18,6 @@ use Symfony\Component\Finder\Glob as FinderGlob;
*/
class Glob implements ValueInterface
{
/**
* @var string
*/
private $pattern;
/**

View File

@ -13,9 +13,9 @@ namespace Symfony\Component\Finder\Tests\Iterator;
class MockSplFileInfo extends \SplFileInfo
{
const TYPE_DIRECTORY = 1;
const TYPE_FILE = 2;
const TYPE_UNKNOWN = 3;
const TYPE_DIRECTORY = 1;
const TYPE_FILE = 2;
const TYPE_UNKNOWN = 3;
private $contents = null;
private $mode = null;

View File

@ -125,13 +125,13 @@ abstract class AbstractRendererEngine implements FormRendererEngineInterface
*
* @see getResourceForBlockHierarchy()
*
* @param string $cacheKey the cache key used for storing the
* @param string $cacheKey The cache key used for storing the
* resource
* @param FormView $view the form view for finding the applying
* @param FormView $view The form view for finding the applying
* themes
* @param array $blockNameHierarchy the block hierarchy, with the most
* @param array $blockNameHierarchy The block hierarchy, with the most
* specific block name at the end
* @param int $hierarchyLevel the level in the block hierarchy that
* @param int $hierarchyLevel The level in the block hierarchy that
* should be loaded
*
* @return bool True if the resource could be loaded, false otherwise

View File

@ -16,18 +16,7 @@ use Symfony\Component\Form\Exception\TransformationFailedException;
class CallbackTransformer implements DataTransformerInterface
{
/**
* The callback used for forward transform.
*
* @var callable
*/
private $transform;
/**
* The callback used for reverse transform.
*
* @var callable
*/
private $reverseTransform;
/**

View File

@ -27,11 +27,6 @@ use Symfony\Component\Form\ChoiceList\Loader\ChoiceLoaderInterface;
*/
class LazyChoiceList implements ChoiceListInterface
{
/**
* The choice loader.
*
* @var ChoiceLoaderInterface
*/
private $loader;
/**
@ -56,8 +51,7 @@ class LazyChoiceList implements ChoiceListInterface
* argument.
*
* @param ChoiceLoaderInterface $loader The choice loader
* @param null|callable $value The callable generating the choice
* values
* @param null|callable $value The callable generating the choice values
*/
public function __construct(ChoiceLoaderInterface $loader, $value = null)
{

View File

@ -18,26 +18,14 @@ namespace Symfony\Component\Form\ChoiceList\View;
*/
class ChoiceGroupView implements \IteratorAggregate
{
/**
* The label of the group.
*
* @var string
*/
public $label;
/**
* The choice views in the group.
*
* @var ChoiceGroupView[]|ChoiceView[]
*/
public $choices;
/**
* Creates a new choice group view.
*
* @param string $label The label of the group
* @param ChoiceGroupView[]|ChoiceView[] $choices the choice views in the
* group
* @param ChoiceGroupView[]|ChoiceView[] $choices the choice views in the group
*/
public function __construct($label, array $choices = array())
{

View File

@ -22,26 +22,14 @@ namespace Symfony\Component\Form\ChoiceList\View;
*/
class ChoiceListView
{
/**
* The choices.
*
* @var ChoiceGroupView[]|ChoiceView[]
*/
public $choices;
/**
* The preferred choices.
*
* @var ChoiceGroupView[]|ChoiceView[]
*/
public $preferredChoices;
/**
* Creates a new choice list view.
*
* @param ChoiceGroupView[]|ChoiceView[] $choices The choice views
* @param ChoiceGroupView[]|ChoiceView[] $preferredChoices the preferred
* choice views
* @param ChoiceGroupView[]|ChoiceView[] $preferredChoices the preferred choice views
*/
public function __construct(array $choices = array(), array $preferredChoices = array())
{

View File

@ -21,25 +21,8 @@ namespace Symfony\Component\Form\Extension\Core\View;
*/
class ChoiceView
{
/**
* The label displayed to humans.
*
* @var string
*/
public $label;
/**
* The view representation of the choice.
*
* @var string
*/
public $value;
/**
* The original choice value.
*
* @var mixed
*/
public $data;
/**

View File

@ -74,7 +74,7 @@ class ChoiceList implements ChoiceListInterface
* level of the hierarchy may also be a \Traversable.
* @param array $labels The array of labels. The structure of this array
* should match the structure of $choices.
* @param array $preferredChoices a flat array of choices that should be
* @param array $preferredChoices A flat array of choices that should be
* presented to the user with priority
*
* @throws UnexpectedTypeException if the choices are not an array or \Traversable
@ -252,10 +252,8 @@ class ChoiceList implements ChoiceListInterface
/**
* Recursively adds the given choices to the list.
*
* @param array $bucketForPreferred the bucket where to store the preferred
* view objects
* @param array $bucketForRemaining the bucket where to store the
* non-preferred view objects
* @param array $bucketForPreferred The bucket where to store the preferred view objects
* @param array $bucketForRemaining The bucket where to store the non-preferred view objects
* @param array|\Traversable $choices The list of choices
* @param array $labels The labels corresponding to the choices
* @param array $preferredChoices The preferred choices
@ -299,10 +297,8 @@ class ChoiceList implements ChoiceListInterface
* Recursively adds a choice group.
*
* @param string $group The name of the group
* @param array $bucketForPreferred the bucket where to store the preferred
* view objects
* @param array $bucketForRemaining the bucket where to store the
* non-preferred view objects
* @param array $bucketForPreferred The bucket where to store the preferred view objects
* @param array $bucketForRemaining The bucket where to store the non-preferred view objects
* @param array $choices The list of choices in the group
* @param array $labels The labels corresponding to the choices in the group
* @param array $preferredChoices The preferred choices
@ -336,10 +332,8 @@ class ChoiceList implements ChoiceListInterface
/**
* Adds a new choice.
*
* @param array $bucketForPreferred the bucket where to store the preferred
* view objects
* @param array $bucketForRemaining the bucket where to store the
* non-preferred view objects
* @param array $bucketForPreferred The bucket where to store the preferred view objects
* @param array $bucketForRemaining The bucket where to store the non-preferred view objects
* @param mixed $choice The choice to add
* @param string $label The label for the choice
* @param array $preferredChoices The preferred choices

View File

@ -80,7 +80,7 @@ class ObjectChoiceList extends ChoiceList
* by calling the getter on the object. If the
* path is NULL, the object's __toString() method
* is used instead.
* @param array $preferredChoices a flat array of choices that should be
* @param array $preferredChoices A flat array of choices that should be
* presented to the user with priority
* @param string $groupPath A property path pointing to the property used
* to group the choices. Only allowed if

View File

@ -44,7 +44,7 @@ class SimpleChoiceList extends ChoiceList
* as hierarchy of unlimited depth by creating nested
* arrays. The title of the sub-hierarchy is stored
* in the array key pointing to the nested array.
* @param array $preferredChoices a flat array of choices that should be
* @param array $preferredChoices A flat array of choices that should be
* presented to the user with priority
*/
public function __construct(array $choices, array $preferredChoices = array())
@ -83,10 +83,8 @@ class SimpleChoiceList extends ChoiceList
* Takes care of splitting the single $choices array passed in the
* constructor into choices and labels.
*
* @param array $bucketForPreferred the bucket where to store the preferred
* view objects
* @param array $bucketForRemaining the bucket where to store the
* non-preferred view objects
* @param array $bucketForPreferred The bucket where to store the preferred view objects
* @param array $bucketForRemaining The bucket where to store the non-preferred view objects
* @param array|\Traversable $choices The list of choices
* @param array $labels Ignored
* @param array $preferredChoices The preferred choices

View File

@ -26,14 +26,7 @@ use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
*/
class CoreExtension extends AbstractExtension
{
/**
* @var PropertyAccessorInterface
*/
private $propertyAccessor;
/**
* @var ChoiceListFactoryInterface
*/
private $choiceListFactory;
public function __construct(PropertyAccessorInterface $propertyAccessor = null, ChoiceListFactoryInterface $choiceListFactory = null)

View File

@ -22,17 +22,10 @@ use Symfony\Component\Form\Exception\TransformationFailedException;
*/
class BooleanToStringTransformer implements DataTransformerInterface
{
/**
* The value emitted upon transform if the input is true.
*
* @var string
*/
private $trueValue;
/**
* Sets the value emitted upon transform if the input is true.
*
* @param string $trueValue
* @param string $trueValue The value emitted upon transform if the input is true
*/
public function __construct($trueValue)
{

View File

@ -47,8 +47,7 @@ class ChoiceToBooleanArrayTransformer implements DataTransformerInterface
* depending on whether a given option is selected. If this field is rendered
* as select tag, the value is not modified.
*
* @param mixed $choice an array if "multiple" is set to true, a scalar
* value otherwise
* @param mixed $choice An array if "multiple" is set to true, a scalar value otherwise
*
* @return mixed An array
*
@ -87,10 +86,8 @@ class ChoiceToBooleanArrayTransformer implements DataTransformerInterface
*
* @return mixed A scalar value
*
* @throws TransformationFailedException if the given value is not an array,
* if the recuperation of the choices
* fails or if some choice can't be
* found
* @throws TransformationFailedException if the given value is not an array, if the recuperation
* of the choices fails, or if some choice can't be found
*/
public function reverseTransform($values)
{

View File

@ -150,7 +150,7 @@ class DateTimeToLocalizedStringTransformer extends BaseDateTimeTransformer
/**
* Returns a preconfigured IntlDateFormatter instance.
*
* @param bool $ignoreTimezone use UTC regardless of the configured timezone
* @param bool $ignoreTimezone Use UTC regardless of the configured timezone
*
* @return \IntlDateFormatter
*

View File

@ -32,7 +32,6 @@ class PercentToLocalizedStringTransformer implements DataTransformerInterface
);
private $type;
private $scale;
/**

View File

@ -21,27 +21,12 @@ use Symfony\Component\Form\Exception\UnexpectedTypeException;
*/
class MergeCollectionListener implements EventSubscriberInterface
{
/**
* Whether elements may be added to the collection.
*
* @var bool
*/
private $allowAdd;
/**
* Whether elements may be removed from the collection.
*
* @var bool
*/
private $allowDelete;
/**
* Creates a new listener.
*
* @param bool $allowAdd whether values might be added to the
* collection
* @param bool $allowDelete whether values might be removed from the
* collection
* @param bool $allowAdd Whether values might be added to the collection
* @param bool $allowDelete Whether values might be removed from the collection
*/
public function __construct($allowAdd = false, $allowDelete = false)
{

View File

@ -34,8 +34,8 @@ class ResizeFormListener implements EventSubscriberInterface
/**
* @param string $type
* @param array $options
* @param bool $allowAdd whether children could be added to the group
* @param bool $allowDelete whether children could be removed from the group
* @param bool $allowAdd Whether children could be added to the group
* @param bool $allowDelete Whether children could be removed from the group
* @param bool $deleteEmpty
*/
public function __construct($type, array $options = array(), $allowAdd = false, $allowDelete = false, $deleteEmpty = false)

View File

@ -44,11 +44,6 @@ class ChoiceType extends AbstractType
*/
const DEPRECATED_EMPTY_VALUE = '__deprecated_empty_value__';
/**
* Caches created choice lists.
*
* @var ChoiceListFactoryInterface
*/
private $choiceListFactory;
public function __construct(ChoiceListFactoryInterface $choiceListFactory = null)

View File

@ -30,7 +30,6 @@ use Symfony\Component\OptionsResolver\OptionsResolver;
class DateTimeType extends AbstractType
{
const DEFAULT_DATE_FORMAT = \IntlDateFormatter::MEDIUM;
const DEFAULT_TIME_FORMAT = \IntlDateFormatter::MEDIUM;
/**

View File

@ -27,7 +27,6 @@ use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
class DateType extends AbstractType
{
const DEFAULT_FORMAT = \IntlDateFormatter::MEDIUM;
const HTML5_FORMAT = 'yyyy-MM-dd';
private static $acceptedFormats = array(

View File

@ -24,9 +24,6 @@ use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
class FormType extends BaseType
{
/**
* @var PropertyAccessorInterface
*/
private $propertyAccessor;
public function __construct(PropertyAccessorInterface $propertyAccessor = null)

View File

@ -25,19 +25,8 @@ use Symfony\Component\Translation\TranslatorInterface;
*/
class CsrfExtension extends AbstractExtension
{
/**
* @var CsrfTokenManagerInterface
*/
private $tokenManager;
/**
* @var TranslatorInterface
*/
private $translator;
/**
* @var null|string
*/
private $translationDomain;
/**

View File

@ -27,9 +27,6 @@ use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
*/
class CsrfProviderAdapter implements CsrfTokenManagerInterface
{
/**
* @var CsrfProviderInterface
*/
private $csrfProvider;
public function __construct(CsrfProviderInterface $csrfProvider)

View File

@ -23,9 +23,6 @@ use Symfony\Component\Security\Csrf\CsrfTokenManagerInterface;
*/
class CsrfTokenManagerAdapter implements CsrfProviderInterface
{
/**
* @var CsrfTokenManagerInterface
*/
private $tokenManager;
public function __construct(CsrfTokenManagerInterface $tokenManager)

View File

@ -30,11 +30,6 @@ use Symfony\Component\Security\Core\Util\StringUtils;
*/
class DefaultCsrfProvider implements CsrfProviderInterface
{
/**
* A secret value used for generating the CSRF token.
*
* @var string
*/
protected $secret;
/**

View File

@ -30,11 +30,6 @@ use Symfony\Component\HttpFoundation\Session\Session;
*/
class SessionCsrfProvider extends DefaultCsrfProvider
{
/**
* The user session from which the session ID is returned.
*
* @var Session
*/
protected $session;
/**
@ -43,7 +38,7 @@ class SessionCsrfProvider extends DefaultCsrfProvider
* A recommended value for the secret is a generated value with at least
* 32 characters and mixed letters, digits and special characters.
*
* @param Session $session The user session
* @param Session $session The user session from which the session ID is returned
* @param string $secret A secret value included in the CSRF token
*/
public function __construct(Session $session, $secret)

View File

@ -28,50 +28,12 @@ use Symfony\Component\Translation\TranslatorInterface;
*/
class CsrfValidationListener implements EventSubscriberInterface
{
/**
* The name of the CSRF field.
*
* @var string
*/
private $fieldName;
/**
* The generator for CSRF tokens.
*
* @var CsrfTokenManagerInterface
*/
private $tokenManager;
/**
* A text mentioning the tokenId of the CSRF token.
*
* Validation of the token will only succeed if it was generated in the
* same session and with the same tokenId.
*
* @var string
*/
private $tokenId;
/**
* The message displayed in case of an error.
*
* @var string
*/
private $errorMessage;
/**
* @var TranslatorInterface
*/
private $translator;
/**
* @var null|string
*/
private $translationDomain;
/**
* @var ServerParams
*/
private $serverParams;
public static function getSubscribedEvents()
@ -81,6 +43,17 @@ class CsrfValidationListener implements EventSubscriberInterface
);
}
/**
* @param string $fieldName The name of the CSRF field
* @param CsrfTokenManagerInterface $tokenManager The generator for CSRF tokens
* @param string $tokenId A text mentioning the tokenId of the CSRF token
* Validation of the token will only succeed if it was generated in the
* same session and with the same tokenId
* @param string $errorMessage The message displayed in case of an error
* @param TranslatorInterface $translator
* @param null|string $translationDomain
* @param ServerParams $serverParams
*/
public function __construct($fieldName, $tokenManager, $tokenId, $errorMessage, TranslatorInterface $translator = null, $translationDomain = null, ServerParams $serverParams = null)
{
if ($tokenManager instanceof CsrfProviderInterface) {

View File

@ -36,31 +36,20 @@ class FormTypeCsrfExtension extends AbstractTypeExtension
*/
private $defaultTokenManager;
/**
* @var bool
*/
private $defaultEnabled;
/**
* @var string
*/
private $defaultFieldName;
/**
* @var TranslatorInterface
*/
private $translator;
/**
* @var null|string
*/
private $translationDomain;
/**
* @var ServerParams
*/
private $serverParams;
/**
* @param CsrfTokenManagerInterface|CsrfProviderInterface $defaultTokenManager
* @param bool $defaultEnabled
* @param string $defaultFieldName
* @param TranslatorInterface $translator
* @param null|string $translationDomain
* @param ServerParams $serverParams
*/
public function __construct($defaultTokenManager, $defaultEnabled = true, $defaultFieldName = '_token', TranslatorInterface $translator = null, $translationDomain = null, ServerParams $serverParams = null)
{
if ($defaultTokenManager instanceof CsrfProviderInterface) {

View File

@ -11,7 +11,6 @@
namespace Symfony\Component\Form\Extension\DataCollector;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Form\AbstractExtension;
/**
@ -22,9 +21,6 @@ use Symfony\Component\Form\AbstractExtension;
*/
class DataCollectorExtension extends AbstractExtension
{
/**
* @var EventSubscriberInterface
*/
private $dataCollector;
public function __construct(FormDataCollectorInterface $dataCollector)

View File

@ -24,9 +24,6 @@ use Symfony\Component\Form\FormEvents;
*/
class DataCollectorListener implements EventSubscriberInterface
{
/**
* @var FormDataCollectorInterface
*/
private $dataCollector;
public function __construct(FormDataCollectorInterface $dataCollector)

View File

@ -25,14 +25,7 @@ use Symfony\Component\Form\ResolvedFormTypeInterface;
*/
class ResolvedTypeDataCollectorProxy implements ResolvedFormTypeInterface
{
/**
* @var ResolvedFormTypeInterface
*/
private $proxiedType;
/**
* @var FormDataCollectorInterface
*/
private $dataCollector;
public function __construct(ResolvedFormTypeInterface $proxiedType, FormDataCollectorInterface $dataCollector)

View File

@ -24,14 +24,7 @@ use Symfony\Component\Form\ResolvedFormTypeInterface;
*/
class ResolvedTypeFactoryDataCollectorProxy implements ResolvedFormTypeFactoryInterface
{
/**
* @var ResolvedFormTypeFactoryInterface
*/
private $proxiedFactory;
/**
* @var FormDataCollectorInterface
*/
private $dataCollector;
public function __construct(ResolvedFormTypeFactoryInterface $proxiedFactory, FormDataCollectorInterface $dataCollector)

View File

@ -25,7 +25,7 @@ use Symfony\Component\Form\FormBuilderInterface;
class DataCollectorTypeExtension extends AbstractTypeExtension
{
/**
* @var \Symfony\Component\EventDispatcher\EventSubscriberInterface
* @var DataCollectorListener
*/
private $listener;

View File

@ -26,9 +26,6 @@ use Symfony\Component\HttpFoundation\Request;
*/
class HttpFoundationRequestHandler implements RequestHandlerInterface
{
/**
* @var ServerParams
*/
private $serverParams;
/**

View File

@ -20,9 +20,6 @@ use Symfony\Component\Templating\EngineInterface;
*/
class TemplatingRendererEngine extends AbstractRendererEngine
{
/**
* @var EngineInterface
*/
private $engine;
public function __construct(EngineInterface $engine, array $defaultThemes = array())

View File

@ -24,14 +24,7 @@ use Symfony\Component\OptionsResolver\OptionsResolver;
*/
class FormTypeValidatorExtension extends BaseValidatorExtension
{
/**
* @var ValidatorInterface
*/
private $validator;
/**
* @var ViolationMapper
*/
private $violationMapper;
/**

View File

@ -250,7 +250,7 @@ class ValidatorTypeGuesser implements FormTypeGuesserInterface
* @param string $property The property for which to find constraints
* @param \Closure $closure The closure that returns a guess
* for a given constraint
* @param mixed $defaultValue the default value assumed if no other value
* @param mixed $defaultValue The default value assumed if no other value
* can be guessed
*
* @return Guess|null The guessed value with the highest confidence

View File

@ -19,21 +19,15 @@ use Symfony\Component\Form\Exception\ErrorMappingException;
*/
class MappingRule
{
/**
* @var FormInterface
*/
private $origin;
/**
* @var string
*/
private $propertyPath;
/**
* @var string
*/
private $targetPath;
/**
* @param FormInterface $origin
* @param string $propertyPath
* @param string $targetPath
*/
public function __construct(FormInterface $origin, $propertyPath, $targetPath)
{
$this->origin = $origin;

View File

@ -19,9 +19,6 @@ use Symfony\Component\PropertyAccess\PropertyPath;
*/
class RelativePath extends PropertyPath
{
/**
* @var FormInterface
*/
private $root;
/**

View File

@ -24,10 +24,8 @@ interface ViolationMapperInterface
* the given form.
*
* @param ConstraintViolation $violation The violation to map
* @param FormInterface $form the root form of the tree
* to map it to
* @param bool $allowNonSynchronized whether to allow
* mapping to non-synchronized forms
* @param FormInterface $form The root form of the tree to map it to
* @param bool $allowNonSynchronized Whether to allow mapping to non-synchronized forms
*/
public function mapViolation(ConstraintViolation $violation, FormInterface $form, $allowNonSynchronized = false);
}

View File

@ -48,8 +48,7 @@ class ViolationPath implements \IteratorAggregate, PropertyPathInterface
/**
* Creates a new violation path from a string.
*
* @param string $violationPath the property path of a {@link \Symfony\Component\Validator\ConstraintViolation}
* object
* @param string $violationPath The property path of a {@link \Symfony\Component\Validator\ConstraintViolation} object
*/
public function __construct($violationPath)
{

View File

@ -48,7 +48,7 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* view to the normalized format.
*
* @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 $this The configuration object
*/
@ -70,7 +70,7 @@ interface FormConfigBuilderInterface extends FormConfigInterface
* normalized to the model format.
*
* @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 $this The configuration object
*/
@ -146,7 +146,7 @@ interface FormConfigBuilderInterface extends FormConfigInterface
/**
* Sets the property path that the form should be mapped to.
*
* @param null|string|PropertyPathInterface $propertyPath the property path or null if the path should be set
* @param null|string|PropertyPathInterface $propertyPath The property path or null if the path should be set
* automatically based on the form's name
*
* @return $this The configuration object
@ -166,7 +166,7 @@ interface FormConfigBuilderInterface extends FormConfigInterface
/**
* Sets whether the form's data should be modified by reference.
*
* @param bool $byReference whether the data should be
* @param bool $byReference Whether the data should be
* modified by reference
*
* @return $this The configuration object

View File

@ -32,26 +32,17 @@ class FormErrorIterator implements \RecursiveIterator, \SeekableIterator, \Array
{
/**
* The prefix used for indenting nested error messages.
*
* @var string
*/
const INDENTATION = ' ';
/**
* @var FormInterface
*/
private $form;
/**
* @var FormError[]|FormErrorIterator[]
*/
private $errors;
/**
* Creates a new iterator.
*
* @param FormInterface $form The erroneous form
* @param array $errors The form errors
* @param FormInterface $form The erroneous form
* @param FormError[]|FormErrorIterator[] $errors The form errors
*
* @throws InvalidArgumentException If the errors are invalid
*/

View File

@ -15,14 +15,7 @@ use Symfony\Component\Form\Exception\UnexpectedTypeException;
class FormFactory implements FormFactoryInterface
{
/**
* @var FormRegistryInterface
*/
private $registry;
/**
* @var ResolvedFormTypeFactoryInterface
*/
private $resolvedTypeFactory;
public function __construct(FormRegistryInterface $registry, ResolvedFormTypeFactoryInterface $resolvedTypeFactory)

View File

@ -268,7 +268,7 @@ interface FormInterface extends \ArrayAccess, \Traversable, \Countable
* Submits data to the form, transforms and validates it.
*
* @param mixed $submittedData The submitted data
* @param bool $clearMissing whether to set fields to NULL when they
* @param bool $clearMissing Whether to set fields to NULL when they
* are missing in the submitted data
*
* @return $this

View File

@ -40,7 +40,7 @@ interface FormRendererEngineInterface
* First the themes attached directly to the
* view with {@link setTheme()} are considered,
* 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
*/
@ -74,7 +74,7 @@ interface FormRendererEngineInterface
* First the themes attached directly to
* the view with {@link setTheme()} are
* considered, then the ones of its parent etc.
* @param array $blockNameHierarchy the block name hierarchy, with the root block
* @param array $blockNameHierarchy The block name hierarchy, with the root block
* at the beginning
* @param int $hierarchyLevel The level in the hierarchy at which to start
* looking. Level 0 indicates the root block, i.e.
@ -114,7 +114,7 @@ interface FormRendererEngineInterface
* First the themes attached directly to
* the view with {@link setTheme()} are
* considered, then the ones of its parent etc.
* @param array $blockNameHierarchy the block name hierarchy, with the root block
* @param array $blockNameHierarchy The block name hierarchy, with the root block
* at the beginning
* @param int $hierarchyLevel The level in the hierarchy at which to start
* looking. Level 0 indicates the root block, i.e.

View File

@ -26,29 +26,21 @@ abstract class Guess
{
/**
* Marks an instance with a value that is extremely likely to be correct.
*
* @var int
*/
const VERY_HIGH_CONFIDENCE = 3;
/**
* Marks an instance with a value that is very likely to be correct.
*
* @var int
*/
const HIGH_CONFIDENCE = 2;
/**
* Marks an instance with a value that is likely to be correct.
*
* @var int
*/
const MEDIUM_CONFIDENCE = 1;
/**
* Marks an instance with a value that may be correct.
*
* @var int
*/
const LOW_CONFIDENCE = 0;

View File

@ -20,19 +20,8 @@ use Symfony\Component\Form\Exception\InvalidArgumentException;
*/
class PreloadedExtension implements FormExtensionInterface
{
/**
* @var FormTypeInterface[]
*/
private $types = array();
/**
* @var array[FormTypeExtensionInterface[]]
*/
private $typeExtensions = array();
/**
* @var FormTypeGuesserInterface
*/
private $typeGuesser;
/**

View File

@ -29,11 +29,8 @@ use Symfony\Component\Validator\ConstraintViolationInterface;
class ViolationMapperTest extends TestCase
{
const LEVEL_0 = 0;
const LEVEL_1 = 1;
const LEVEL_1B = 2;
const LEVEL_2 = 3;
/**

View File

@ -58,9 +58,9 @@ class OrderedHashMapIterator implements \Iterator
/**
* Creates a new iterator.
*
* @param array $elements the elements of the map, indexed by their
* @param array $elements The elements of the map, indexed by their
* keys
* @param array $orderedKeys the keys of the map in the order in which
* @param array $orderedKeys The keys of the map in the order in which
* they should be iterated
* @param array $managedCursors An array from which to reference the
* iterator's cursor as long as it is alive.

View File

@ -18,24 +18,9 @@ namespace Symfony\Component\HttpFoundation;
*/
class AcceptHeaderItem
{
/**
* @var string
*/
private $value;
/**
* @var float
*/
private $quality = 1.0;
/**
* @var int
*/
private $index = 0;
/**
* @var array
*/
private $attributes = array();
/**

View File

@ -24,41 +24,10 @@ use Symfony\Component\HttpFoundation\File\MimeType\ExtensionGuesser;
*/
class UploadedFile extends File
{
/**
* Whether the test mode is activated.
*
* Local files are used in test mode hence the code should not enforce HTTP uploads.
*
* @var bool
*/
private $test = false;
/**
* The original name of the uploaded file.
*
* @var string
*/
private $originalName;
/**
* The mime type provided by the uploader.
*
* @var string
*/
private $mimeType;
/**
* The file size provided by the uploader.
*
* @var int|null
*/
private $size;
/**
* The UPLOAD_ERR_XXX constant provided by the uploader.
*
* @var int
*/
private $error;
/**
@ -76,11 +45,12 @@ class UploadedFile extends File
* Calling any other method on an non-valid instance will cause an unpredictable result.
*
* @param string $path The full temporary path to the file
* @param string $originalName The original file name
* @param string $originalName The original file name of the uploaded file
* @param string|null $mimeType The type of the file as provided by PHP; null defaults to application/octet-stream
* @param int|null $size The file size
* @param int|null $size The file size provided by the uploader
* @param int|null $error The error constant of the upload (one of PHP's UPLOAD_ERR_XXX constants); null defaults to UPLOAD_ERR_OK
* @param bool $test Whether the test mode is active
* Local files are used in test mode hence the code should not enforce HTTP uploads
*
* @throws FileException If file_uploads is disabled
* @throws FileNotFoundException If the file does not exist

View File

@ -714,9 +714,9 @@ class Request
* It is better to explicitly get request parameters from the appropriate
* public property instead (query, attributes, request).
*
* @param string $key the key
* @param mixed $default the default value if the parameter key does not exist
* @param bool $deep is parameter deep in multidimensional array
* @param string $key The key
* @param mixed $default The default value if the parameter key does not exist
* @param bool $deep Is parameter deep in multidimensional array
*
* @return mixed
*/

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