[2.3] CS And DocBlock Fixes

This commit is contained in:
Graham Campbell 2014-12-21 17:00:50 +00:00 committed by Fabien Potencier
parent ff52a9f928
commit 83c15db887
452 changed files with 1137 additions and 1029 deletions

View File

@ -24,6 +24,7 @@ class ContainerAwareEventManager extends EventManager
{ {
/** /**
* Map of registered listeners. * Map of registered listeners.
*
* <event> => <listeners> * <event> => <listeners>
* *
* @var array * @var array

View File

@ -16,7 +16,7 @@ use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\Config\Resource\FileResource; use Symfony\Component\Config\Resource\FileResource;
/** /**
* Registers additional validators * Registers additional validators.
* *
* @author Benjamin Eberlei <kontakt@beberlei.de> * @author Benjamin Eberlei <kontakt@beberlei.de>
*/ */
@ -43,7 +43,7 @@ class DoctrineValidationPass implements CompilerPassInterface
/** /**
* Gets the validation mapping files for the format and extends them with * Gets the validation mapping files for the format and extends them with
* files matching a doctrine search pattern (Resources/config/validation.orm.xml) * files matching a doctrine search pattern (Resources/config/validation.orm.xml).
* *
* @param ContainerBuilder $container * @param ContainerBuilder $container
* @param string $mapping * @param string $mapping

View File

@ -35,12 +35,14 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
/** /**
* DI object for the driver to use, either a service definition for a * DI object for the driver to use, either a service definition for a
* private service or a reference for a public service. * private service or a reference for a public service.
*
* @var Definition|Reference * @var Definition|Reference
*/ */
protected $driver; protected $driver;
/** /**
* List of namespaces handled by the driver * List of namespaces handled by the driver.
*
* @var string[] * @var string[]
*/ */
protected $namespaces; protected $namespaces;
@ -48,14 +50,16 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
/** /**
* List of potential container parameters that hold the object manager name * List of potential container parameters that hold the object manager name
* to register the mappings with the correct metadata driver, for example * to register the mappings with the correct metadata driver, for example
* array('acme.manager', 'doctrine.default_entity_manager') * array('acme.manager', 'doctrine.default_entity_manager').
*
* @var string[] * @var string[]
*/ */
protected $managerParameters; protected $managerParameters;
/** /**
* Naming pattern of the metadata chain driver service ids, for example * Naming pattern of the metadata chain driver service ids, for example
* 'doctrine.orm.%s_metadata_driver' * 'doctrine.orm.%s_metadata_driver'.
*
* @var string * @var string
*/ */
protected $driverPattern; protected $driverPattern;
@ -64,6 +68,7 @@ abstract class RegisterMappingsPass implements CompilerPassInterface
* A name for a parameter in the container. If set, this compiler pass will * A name for a parameter in the container. If set, this compiler pass will
* only do anything if the parameter is present. (But regardless of the * only do anything if the parameter is present. (But regardless of the
* value of that parameter. * value of that parameter.
*
* @var string * @var string
*/ */
protected $enabledParameter; protected $enabledParameter;

View File

@ -18,7 +18,7 @@ use Doctrine\Common\Persistence\ObjectManager;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface; use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
/** /**
* A choice list presenting a list of Doctrine entities as choices * A choice list presenting a list of Doctrine entities as choices.
* *
* @author Bernhard Schussek <bschussek@gmail.com> * @author Bernhard Schussek <bschussek@gmail.com>
*/ */
@ -41,7 +41,7 @@ class EntityChoiceList extends ObjectChoiceList
/** /**
* Contains the query builder that builds the query for fetching the * Contains the query builder that builds the query for fetching the
* entities * entities.
* *
* This property should only be accessed through queryBuilder. * This property should only be accessed through queryBuilder.
* *
@ -50,21 +50,21 @@ class EntityChoiceList extends ObjectChoiceList
private $entityLoader; private $entityLoader;
/** /**
* The identifier field, if the identifier is not composite * The identifier field, if the identifier is not composite.
* *
* @var array * @var array
*/ */
private $idField = null; private $idField = null;
/** /**
* Whether to use the identifier for index generation * Whether to use the identifier for index generation.
* *
* @var bool * @var bool
*/ */
private $idAsIndex = false; private $idAsIndex = false;
/** /**
* Whether to use the identifier for value generation * Whether to use the identifier for value generation.
* *
* @var bool * @var bool
*/ */
@ -98,7 +98,7 @@ class EntityChoiceList extends ObjectChoiceList
* 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)
{ {
$this->em = $manager; $this->em = $manager;
$this->entityLoader = $entityLoader; $this->entityLoader = $entityLoader;
@ -128,7 +128,7 @@ class EntityChoiceList extends ObjectChoiceList
} }
/** /**
* Returns the list of entities * Returns the list of entities.
* *
* @return array * @return array
* *
@ -144,7 +144,7 @@ class EntityChoiceList extends ObjectChoiceList
} }
/** /**
* Returns the values for the entities * Returns the values for the entities.
* *
* @return array * @return array
* *

View File

@ -17,13 +17,13 @@ use Doctrine\DBAL\Connection;
use Doctrine\ORM\EntityManager; use Doctrine\ORM\EntityManager;
/** /**
* Getting Entities through the ORM QueryBuilder * Getting Entities through the ORM QueryBuilder.
*/ */
class ORMQueryBuilderLoader implements EntityLoaderInterface class ORMQueryBuilderLoader implements EntityLoaderInterface
{ {
/** /**
* Contains the query builder that builds the query for fetching the * Contains the query builder that builds the query for fetching the
* entities * entities.
* *
* This property should only be accessed through queryBuilder. * This property should only be accessed through queryBuilder.
* *
@ -32,7 +32,7 @@ class ORMQueryBuilderLoader implements EntityLoaderInterface
private $queryBuilder; private $queryBuilder;
/** /**
* Construct an ORM Query Builder Loader * Construct an ORM Query Builder Loader.
* *
* @param QueryBuilder|\Closure $queryBuilder * @param QueryBuilder|\Closure $queryBuilder
* @param EntityManager $manager * @param EntityManager $manager

View File

@ -39,7 +39,7 @@ interface RegistryInterface extends ManagerRegistryInterface
public function getEntityManager($name = null); public function getEntityManager($name = null);
/** /**
* Gets an array of all registered entity managers * Gets an array of all registered entity managers.
* *
* @return array An array of EntityManager instances * @return array An array of EntityManager instances
*/ */

View File

@ -39,14 +39,14 @@ class DoctrineTokenProvider implements TokenProviderInterface
{ {
/** /**
* Doctrine DBAL database connection * Doctrine DBAL database connection
* F.ex. service id: doctrine.dbal.default_connection * F.ex. service id: doctrine.dbal.default_connection.
* *
* @var \Doctrine\DBAL\Connection * @var \Doctrine\DBAL\Connection
*/ */
private $conn; private $conn;
/** /**
* new DoctrineTokenProvider for the RemembeMe authentication service * new DoctrineTokenProvider for the RemembeMe authentication service.
* *
* @param \Doctrine\DBAL\Connection $conn * @param \Doctrine\DBAL\Connection $conn
*/ */

View File

@ -14,7 +14,7 @@ namespace Symfony\Bridge\Doctrine\Tests;
use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper; use Symfony\Bridge\Doctrine\Test\DoctrineTestHelper;
/** /**
* Class DoctrineOrmTestCase * Class DoctrineOrmTestCase.
* *
* @deprecated Deprecated as of Symfony 2.4, to be removed in Symfony 3.0. * @deprecated Deprecated as of Symfony 2.4, to be removed in Symfony 3.0.
* Use {@link DoctrineTestHelper} instead. * Use {@link DoctrineTestHelper} instead.

View File

@ -27,6 +27,7 @@ class AssociationEntity
/** /**
* @ORM\ManyToOne(targetEntity="SingleIntIdEntity") * @ORM\ManyToOne(targetEntity="SingleIntIdEntity")
*
* @var \Symfony\Bridge\Doctrine\Tests\Fixtures\SingleIntIdEntity * @var \Symfony\Bridge\Doctrine\Tests\Fixtures\SingleIntIdEntity
*/ */
public $single; public $single;
@ -37,6 +38,7 @@ class AssociationEntity
* @ORM\JoinColumn(name="composite_id1", referencedColumnName="id1"), * @ORM\JoinColumn(name="composite_id1", referencedColumnName="id1"),
* @ORM\JoinColumn(name="composite_id2", referencedColumnName="id2") * @ORM\JoinColumn(name="composite_id2", referencedColumnName="id2")
* }) * })
*
* @var \Symfony\Bridge\Doctrine\Tests\Fixtures\CompositeIntIdEntity * @var \Symfony\Bridge\Doctrine\Tests\Fixtures\CompositeIntIdEntity
*/ */
public $composite; public $composite;

View File

@ -14,7 +14,7 @@ namespace Symfony\Bridge\Doctrine\Validator\Constraints;
use Symfony\Component\Validator\Constraint; use Symfony\Component\Validator\Constraint;
/** /**
* Constraint for the Unique Entity validator * Constraint for the Unique Entity validator.
* *
* @Annotation * @Annotation
* @Target({"CLASS", "ANNOTATION"}) * @Target({"CLASS", "ANNOTATION"})

View File

@ -34,7 +34,7 @@ class ChromePhpHandler extends BaseChromePhpHandler
private $response; private $response;
/** /**
* Adds the headers to the response once it's created * Adds the headers to the response once it's created.
*/ */
public function onKernelResponse(FilterResponseEvent $event) public function onKernelResponse(FilterResponseEvent $event)
{ {
@ -73,7 +73,7 @@ class ChromePhpHandler extends BaseChromePhpHandler
} }
/** /**
* Override default behavior since we check it in onKernelResponse * Override default behavior since we check it in onKernelResponse.
*/ */
protected function headersAccepted() protected function headersAccepted()
{ {

View File

@ -34,7 +34,7 @@ class FirePHPHandler extends BaseFirePHPHandler
private $response; private $response;
/** /**
* Adds the headers to the response once it's created * Adds the headers to the response once it's created.
*/ */
public function onKernelResponse(FilterResponseEvent $event) public function onKernelResponse(FilterResponseEvent $event)
{ {
@ -74,7 +74,7 @@ class FirePHPHandler extends BaseFirePHPHandler
} }
/** /**
* Override default behavior since we check the user agent in onKernelResponse * Override default behavior since we check the user agent in onKernelResponse.
*/ */
protected function headersAccepted() protected function headersAccepted()
{ {

View File

@ -15,7 +15,7 @@ use Monolog\Handler\SwiftMailerHandler as BaseSwiftMailerHandler;
use Symfony\Component\HttpKernel\Event\PostResponseEvent; use Symfony\Component\HttpKernel\Event\PostResponseEvent;
/** /**
* Extended SwiftMailerHandler that flushes mail queue if necessary * Extended SwiftMailerHandler that flushes mail queue if necessary.
* *
* @author Philipp Kräutli <pkraeutli@astina.ch> * @author Philipp Kräutli <pkraeutli@astina.ch>
*/ */
@ -34,7 +34,7 @@ class SwiftMailerHandler extends BaseSwiftMailerHandler
} }
/** /**
* After the kernel has been terminated we will always flush messages * After the kernel has been terminated we will always flush messages.
* *
* @param PostResponseEvent $event * @param PostResponseEvent $event
*/ */
@ -56,7 +56,7 @@ class SwiftMailerHandler extends BaseSwiftMailerHandler
} }
/** /**
* Flushes the mail queue if a memory spool is used * Flushes the mail queue if a memory spool is used.
*/ */
private function flushMemorySpool() private function flushMemorySpool()
{ {

View File

@ -16,7 +16,7 @@ use Symfony\Component\HttpKernel\Event\GetResponseEvent;
use Symfony\Component\HttpKernel\HttpKernelInterface; use Symfony\Component\HttpKernel\HttpKernelInterface;
/** /**
* WebProcessor override to read from the HttpFoundation's Request * WebProcessor override to read from the HttpFoundation's Request.
* *
* @author Jordi Boggiano <j.boggiano@seld.be> * @author Jordi Boggiano <j.boggiano@seld.be>
*/ */

View File

@ -24,21 +24,21 @@ use Symfony\Component\HttpKernel\DataCollector\DataCollector;
class PropelDataCollector extends DataCollector class PropelDataCollector extends DataCollector
{ {
/** /**
* Propel logger * Propel logger.
* *
* @var \Symfony\Bridge\Propel1\Logger\PropelLogger * @var \Symfony\Bridge\Propel1\Logger\PropelLogger
*/ */
private $logger; private $logger;
/** /**
* Propel configuration * Propel configuration.
* *
* @var \PropelConfiguration * @var \PropelConfiguration
*/ */
protected $propelConfiguration; protected $propelConfiguration;
/** /**
* Constructor * Constructor.
* *
* @param PropelLogger $logger A Propel logger. * @param PropelLogger $logger A Propel logger.
* @param \PropelConfiguration $propelConfiguration The Propel configuration object. * @param \PropelConfiguration $propelConfiguration The Propel configuration object.

View File

@ -29,7 +29,7 @@ use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
class ModelChoiceList extends ObjectChoiceList class ModelChoiceList extends ObjectChoiceList
{ {
/** /**
* The fields of which the identifier of the underlying class consists * The fields of which the identifier of the underlying class consists.
* *
* This property should only be accessed through identifier. * This property should only be accessed through identifier.
* *

View File

@ -16,7 +16,7 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\Form\FormEvent; use Symfony\Component\Form\FormEvent;
/** /**
* listener class for propel1_translatable_collection * listener class for propel1_translatable_collection.
* *
* @author Patrick Kaufmann * @author Patrick Kaufmann
*/ */

View File

@ -15,7 +15,7 @@ use Symfony\Component\Form\FormEvent;
use Symfony\Component\Form\FormEvents; use Symfony\Component\Form\FormEvents;
/** /**
* Event Listener class for propel1_translation * Event Listener class for propel1_translation.
* *
* @author Patrick Kaufmann * @author Patrick Kaufmann
*/ */

View File

@ -18,7 +18,7 @@ use Symfony\Component\OptionsResolver\OptionsResolverInterface;
use Symfony\Bridge\Propel1\Form\EventListener\TranslationCollectionFormListener; use Symfony\Bridge\Propel1\Form\EventListener\TranslationCollectionFormListener;
/** /**
* form type for i18n-columns in propel * form type for i18n-columns in propel.
* *
* @author Patrick Kaufmann * @author Patrick Kaufmann
*/ */

View File

@ -17,7 +17,7 @@ use Symfony\Component\OptionsResolver\OptionsResolverInterface;
use Symfony\Bridge\Propel1\Form\EventListener\TranslationFormListener; use Symfony\Bridge\Propel1\Form\EventListener\TranslationFormListener;
/** /**
* Translation type class * Translation type class.
* *
* @author Patrick Kaufmann * @author Patrick Kaufmann
*/ */

View File

@ -45,7 +45,7 @@ class PropelUserProvider implements UserProviderInterface
protected $property; protected $property;
/** /**
* Default constructor * Default constructor.
* *
* @param string $class The User model class. * @param string $class The User model class.
* @param string|null $property The property to use to retrieve a user. * @param string|null $property The property to use to retrieve a user.

View File

@ -51,7 +51,7 @@ class ItemQuery
} }
/** /**
* Method from the TableMap API * Method from the TableMap API.
*/ */
public function hasColumn($column) public function hasColumn($column)
{ {
@ -59,7 +59,7 @@ class ItemQuery
} }
/** /**
* Method from the TableMap API * Method from the TableMap API.
*/ */
public function getColumn($column) public function getColumn($column)
{ {
@ -69,7 +69,7 @@ class ItemQuery
} }
/** /**
* Method from the TableMap API * Method from the TableMap API.
*/ */
public function getRelations() public function getRelations()
{ {

View File

@ -32,7 +32,7 @@ class RuntimeInstantiator implements InstantiatorInterface
private $factory; private $factory;
/** /**
* Constructor * Constructor.
*/ */
public function __construct() public function __construct()
{ {

View File

@ -37,7 +37,7 @@ class ProxyDumper implements DumperInterface
private $classGenerator; private $classGenerator;
/** /**
* Constructor * Constructor.
*/ */
public function __construct() public function __construct()
{ {

View File

@ -18,7 +18,7 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
/** /**
* Integration tests for {@see \Symfony\Component\DependencyInjection\ContainerBuilder} combined * Integration tests for {@see \Symfony\Component\DependencyInjection\ContainerBuilder} combined
* with the ProxyManager bridge * with the ProxyManager bridge.
* *
* @author Marco Pivetta <ocramius@gmail.com> * @author Marco Pivetta <ocramius@gmail.com>
*/ */

View File

@ -17,7 +17,7 @@ use Symfony\Component\DependencyInjection\Dumper\PhpDumper;
/** /**
* Integration tests for {@see \Symfony\Component\DependencyInjection\Dumper\PhpDumper} combined * Integration tests for {@see \Symfony\Component\DependencyInjection\Dumper\PhpDumper} combined
* with the ProxyManager bridge * with the ProxyManager bridge.
* *
* @author Marco Pivetta <ocramius@gmail.com> * @author Marco Pivetta <ocramius@gmail.com>
*/ */
@ -45,7 +45,7 @@ class PhpDumperTest extends \PHPUnit_Framework_TestCase
} }
/** /**
* Verifies that the generated container retrieves the same proxy instance on multiple subsequent requests * Verifies that the generated container retrieves the same proxy instance on multiple subsequent requests.
*/ */
public function testDumpContainerWithProxyServiceWillShareProxies() public function testDumpContainerWithProxyServiceWillShareProxies()
{ {

View File

@ -11,7 +11,7 @@ use Symfony\Component\DependencyInjection\Parameter;
use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag; use Symfony\Component\DependencyInjection\ParameterBag\FrozenParameterBag;
/** /**
* ProjectServiceContainer * ProjectServiceContainer.
* *
* This class has been auto-generated * This class has been auto-generated
* by the Symfony Dependency Injection Component. * by the Symfony Dependency Injection Component.

View File

@ -17,7 +17,7 @@ use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\DependencyInjection\Definition; use Symfony\Component\DependencyInjection\Definition;
/** /**
* Tests for {@see \Symfony\Bridge\ProxyManager\LazyProxy\Instantiator\RuntimeInstantiator} * Tests for {@see \Symfony\Bridge\ProxyManager\LazyProxy\Instantiator\RuntimeInstantiator}.
* *
* @author Marco Pivetta <ocramius@gmail.com> * @author Marco Pivetta <ocramius@gmail.com>
* *

View File

@ -15,7 +15,7 @@ use Symfony\Bridge\ProxyManager\LazyProxy\PhpDumper\ProxyDumper;
use Symfony\Component\DependencyInjection\Definition; use Symfony\Component\DependencyInjection\Definition;
/** /**
* Tests for {@see \Symfony\Bridge\ProxyManager\LazyProxy\PhpDumper\ProxyDumper} * Tests for {@see \Symfony\Bridge\ProxyManager\LazyProxy\PhpDumper\ProxyDumper}.
* *
* @author Marco Pivetta <ocramius@gmail.com> * @author Marco Pivetta <ocramius@gmail.com>
* *

View File

@ -18,7 +18,7 @@ use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Config\Definition\ConfigurationInterface; use Symfony\Component\Config\Definition\ConfigurationInterface;
/** /**
* A console command for dumping available configuration reference * A console command for dumping available configuration reference.
* *
* @author Kevin Bond <kevinbond@gmail.com> * @author Kevin Bond <kevinbond@gmail.com>
*/ */

View File

@ -29,6 +29,7 @@ abstract class ContainerAwareCommand extends Command implements ContainerAwareIn
/** /**
* @return ContainerInterface * @return ContainerInterface
*
* @throws \LogicException * @throws \LogicException
*/ */
protected function getContainer() protected function getContainer()

View File

@ -22,7 +22,7 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\Config\FileLocator; use Symfony\Component\Config\FileLocator;
/** /**
* A console command for retrieving information about services * A console command for retrieving information about services.
* *
* @author Ryan Weaver <ryan@thatsquality.com> * @author Ryan Weaver <ryan@thatsquality.com>
*/ */
@ -269,7 +269,7 @@ EOF
} }
/** /**
* Renders detailed service information about one service * Renders detailed service information about one service.
*/ */
protected function outputService(OutputInterface $output, $serviceId) protected function outputService(OutputInterface $output, $serviceId)
{ {
@ -409,7 +409,7 @@ EOF
} }
/** /**
* Renders list of tagged services grouped by tag * Renders list of tagged services grouped by tag.
* *
* @param OutputInterface $output * @param OutputInterface $output
* @param bool $showPrivate * @param bool $showPrivate

View File

@ -17,7 +17,7 @@ use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Routing\RouterInterface; use Symfony\Component\Routing\RouterInterface;
/** /**
* A console command for retrieving information about routes * A console command for retrieving information about routes.
* *
* @author Fabien Potencier <fabien@symfony.com> * @author Fabien Potencier <fabien@symfony.com>
* @author Tobias Schultze <http://tobion.de> * @author Tobias Schultze <http://tobion.de>
@ -101,7 +101,7 @@ EOF
$format = '%-'.$maxName.'s %-'.$maxMethod.'s %-'.$maxScheme.'s %-'.$maxHost.'s %s'; $format = '%-'.$maxName.'s %-'.$maxMethod.'s %-'.$maxScheme.'s %-'.$maxHost.'s %s';
$formatHeader = '%-'.($maxName + 19).'s %-'.($maxMethod + 19).'s %-'.($maxScheme + 19).'s %-'.($maxHost + 19).'s %s'; $formatHeader = '%-'.($maxName + 19).'s %-'.($maxMethod + 19).'s %-'.($maxScheme + 19).'s %-'.($maxHost + 19).'s %s';
$output->writeln(sprintf($formatHeader, '<comment>Name</comment>', '<comment>Method</comment>', '<comment>Scheme</comment>', '<comment>Host</comment>', '<comment>Path</comment>')); $output->writeln(sprintf($formatHeader, '<comment>Name</comment>', '<comment>Method</comment>', '<comment>Scheme</comment>', '<comment>Host</comment>', '<comment>Path</comment>'));
foreach ($routes as $name => $route) { foreach ($routes as $name => $route) {
$method = $route->getMethods() ? implode('|', $route->getMethods()) : 'ANY'; $method = $route->getMethods() ? implode('|', $route->getMethods()) : 'ANY';

View File

@ -164,7 +164,7 @@ class Controller extends ContainerAware
} }
/** /**
* Creates and returns a form builder instance * Creates and returns a form builder instance.
* *
* @param mixed $data The initial data for the form * @param mixed $data The initial data for the form
* @param array $options Options for the form * @param array $options Options for the form
@ -203,7 +203,7 @@ class Controller extends ContainerAware
} }
/** /**
* Get a user from the Security Context * Get a user from the Security Context.
* *
* @return mixed * @return mixed
* *

View File

@ -16,7 +16,7 @@ use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
/** /**
* Adds all services with the tags "form.type" and "form.type_guesser" as * Adds all services with the tags "form.type" and "form.type_guesser" as
* arguments of the "form.extension" service * arguments of the "form.extension" service.
* *
* @author Bernhard Schussek <bschussek@gmail.com> * @author Bernhard Schussek <bschussek@gmail.com>
*/ */

View File

@ -16,7 +16,7 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
/** /**
* Adds tagged data_collector services to profiler service * Adds tagged data_collector services to profiler service.
* *
* @author Fabien Potencier <fabien@symfony.com> * @author Fabien Potencier <fabien@symfony.com>
*/ */

View File

@ -16,7 +16,7 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
/** /**
* Adds tagged routing.loader services to routing.resolver service * Adds tagged routing.loader services to routing.resolver service.
* *
* @author Fabien Potencier <fabien@symfony.com> * @author Fabien Potencier <fabien@symfony.com>
*/ */

View File

@ -16,7 +16,7 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
/** /**
* Adds tagged translation.formatter services to translation writer * Adds tagged translation.formatter services to translation writer.
*/ */
class TranslationDumperPass implements CompilerPassInterface class TranslationDumperPass implements CompilerPassInterface
{ {

View File

@ -16,7 +16,7 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
/** /**
* Adds tagged translation.extractor services to translation extractor * Adds tagged translation.extractor services to translation extractor.
*/ */
class TranslationExtractorPass implements CompilerPassInterface class TranslationExtractorPass implements CompilerPassInterface
{ {

View File

@ -57,7 +57,7 @@ class TestSessionListener implements EventSubscriberInterface
/** /**
* Checks if session was initialized and saves if current request is master * Checks if session was initialized and saves if current request is master
* Runs on 'kernel.response' in test environment * Runs on 'kernel.response' in test environment.
* *
* @param FilterResponseEvent $event * @param FilterResponseEvent $event
*/ */

View File

@ -49,7 +49,7 @@ class RequestHelper extends Helper
} }
/** /**
* Returns the locale * Returns the locale.
* *
* @return string * @return string
*/ */

View File

@ -34,7 +34,7 @@ class SessionHelper extends Helper
} }
/** /**
* Returns an attribute * Returns an attribute.
* *
* @param string $name The attribute name * @param string $name The attribute name
* @param mixed $default The default value * @param mixed $default The default value

View File

@ -34,7 +34,7 @@ class TemplateReference extends BaseTemplateReference
/** /**
* Returns the path to the template * Returns the path to the template
* - as a path when the template is not part of a bundle * - as a path when the template is not part of a bundle
* - as a resource when the template is part of a bundle * - as a resource when the template is part of a bundle.
* *
* @return string A path to the template or a resource * @return string A path to the template or a resource
*/ */

View File

@ -26,8 +26,9 @@ class ProfilerPassTest extends \PHPUnit_Framework_TestCase
/** /**
* Tests that collectors that specify a template but no "id" will throw * Tests that collectors that specify a template but no "id" will throw
* an exception (both are needed if the template is specified). Thus, * an exception (both are needed if the template is specified).
* a fully-valid tag looks something like this: *
* Thus, a fully-valid tag looks something like this:
* *
* <tag name="data_collector" template="YourBundle:Collector:templatename" id="your_collector_name" /> * <tag name="data_collector" template="YourBundle:Collector:templatename" id="your_collector_name" />
*/ */

View File

@ -16,7 +16,7 @@ use Symfony\Component\DependencyInjection\Reference;
use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\SerializerPass; use Symfony\Bundle\FrameworkBundle\DependencyInjection\Compiler\SerializerPass;
/** /**
* Tests for the SerializerPass class * Tests for the SerializerPass class.
* *
* @author Javier Lopez <f12loalf@gmail.com> * @author Javier Lopez <f12loalf@gmail.com>
*/ */

View File

@ -18,8 +18,6 @@ use Symfony\Bundle\FrameworkBundle\Tests\Templating\Helper\Fixtures\StubTemplate
use Symfony\Bundle\FrameworkBundle\Tests\Templating\Helper\Fixtures\StubTranslator; use Symfony\Bundle\FrameworkBundle\Tests\Templating\Helper\Fixtures\StubTranslator;
use Symfony\Component\Templating\PhpEngine; use Symfony\Component\Templating\PhpEngine;
use Symfony\Component\Templating\Loader\FilesystemLoader; use Symfony\Component\Templating\Loader\FilesystemLoader;
// should probably be moved to the Translation component
use Symfony\Bundle\FrameworkBundle\Templating\Helper\TranslatorHelper; use Symfony\Bundle\FrameworkBundle\Templating\Helper\TranslatorHelper;
class FormHelperDivLayoutTest extends AbstractDivLayoutTest class FormHelperDivLayoutTest extends AbstractDivLayoutTest

View File

@ -18,8 +18,6 @@ use Symfony\Bundle\FrameworkBundle\Tests\Templating\Helper\Fixtures\StubTemplate
use Symfony\Bundle\FrameworkBundle\Tests\Templating\Helper\Fixtures\StubTranslator; use Symfony\Bundle\FrameworkBundle\Tests\Templating\Helper\Fixtures\StubTranslator;
use Symfony\Component\Templating\PhpEngine; use Symfony\Component\Templating\PhpEngine;
use Symfony\Component\Templating\Loader\FilesystemLoader; use Symfony\Component\Templating\Loader\FilesystemLoader;
// should probably be moved to the Translation component
use Symfony\Bundle\FrameworkBundle\Templating\Helper\TranslatorHelper; use Symfony\Bundle\FrameworkBundle\Templating\Helper\TranslatorHelper;
class FormHelperTableLayoutTest extends AbstractTableLayoutTest class FormHelperTableLayoutTest extends AbstractTableLayoutTest

View File

@ -103,7 +103,7 @@ class PhpExtractor implements ExtractorInterface
/** /**
* Extracts the message from the iterator while the tokens * Extracts the message from the iterator while the tokens
* match allowed message tokens * match allowed message tokens.
*/ */
private function getMessage(\Iterator $tokenIterator) private function getMessage(\Iterator $tokenIterator)
{ {

View File

@ -77,7 +77,7 @@ class PhpStringTokenParser
if ('\'' === $str[$bLength]) { if ('\'' === $str[$bLength]) {
return str_replace( return str_replace(
array('\\\\', '\\\''), array('\\\\', '\\\''),
array( '\\', '\''), array( '\\', '\''),
substr($str, $bLength + 1, -1) substr($str, $bLength + 1, -1)
); );
} else { } else {

View File

@ -31,6 +31,7 @@ class TranslationLoader
/** /**
* Adds a loader to the translation extractor. * Adds a loader to the translation extractor.
*
* @param string $format The format of the loader * @param string $format The format of the loader
* @param LoaderInterface $loader * @param LoaderInterface $loader
*/ */

View File

@ -17,7 +17,7 @@ use Symfony\Component\Console\Output\OutputInterface;
use Doctrine\DBAL\Schema\SchemaException; use Doctrine\DBAL\Schema\SchemaException;
/** /**
* Installs the tables required by the ACL system * Installs the tables required by the ACL system.
* *
* @author Johannes M. Schmitt <schmittjoh@gmail.com> * @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/ */

View File

@ -16,7 +16,7 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
/** /**
* Adds all configured security voters to the access decision manager * Adds all configured security voters to the access decision manager.
* *
* @author Johannes M. Schmitt <schmittjoh@gmail.com> * @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/ */

View File

@ -17,7 +17,9 @@ use Symfony\Component\Config\Definition\Builder\ArrayNodeDefinition;
use Symfony\Component\Config\Definition\ConfigurationInterface; use Symfony\Component\Config\Definition\ConfigurationInterface;
/** /**
* This class contains the configuration information for the following tags: * This class contains the configuration information.
*
* This information is for the following tags:
* *
* * security.config * * security.config
* * security.acl * * security.acl

View File

@ -18,7 +18,7 @@ use Symfony\Component\DependencyInjection\Reference;
/** /**
* AbstractFactory is the base class for all classes inheriting from * AbstractFactory is the base class for all classes inheriting from
* AbstractAuthenticationListener * AbstractAuthenticationListener.
* *
* @author Lukas Kahwe Smith <smith@pooteeweet.org> * @author Lukas Kahwe Smith <smith@pooteeweet.org>
* @author Johannes M. Schmitt <schmittjoh@gmail.com> * @author Johannes M. Schmitt <schmittjoh@gmail.com>

View File

@ -16,7 +16,7 @@ use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\DependencyInjection\ContainerInterface;
/** /**
* This is a lazy-loading firewall map implementation * This is a lazy-loading firewall map implementation.
* *
* Listeners will only be initialized if we really need them. * Listeners will only be initialized if we really need them.
* *

View File

@ -16,7 +16,7 @@ use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface; use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
/** /**
* Adds tagged twig.extension services to twig service * Adds tagged twig.extension services to twig service.
* *
* @author Fabien Potencier <fabien@symfony.com> * @author Fabien Potencier <fabien@symfony.com>
*/ */

View File

@ -17,7 +17,7 @@ use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
use Symfony\Component\DependencyInjection\Exception\LogicException; use Symfony\Component\DependencyInjection\Exception\LogicException;
/** /**
* Adds services tagged twig.loader as Twig loaders * Adds services tagged twig.loader as Twig loaders.
* *
* @author Daniel Leech <daniel@dantleech.com> * @author Daniel Leech <daniel@dantleech.com>
*/ */

View File

@ -15,7 +15,7 @@ use Symfony\Bundle\TwigBundle\TokenParser\RenderTokenParser;
use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\DependencyInjection\ContainerInterface;
/** /**
* Twig extension for Symfony actions helper * Twig extension for Symfony actions helper.
* *
* @author Fabien Potencier <fabien@symfony.com> * @author Fabien Potencier <fabien@symfony.com>
* *

View File

@ -14,7 +14,7 @@ namespace Symfony\Bundle\TwigBundle\Extension;
use Symfony\Component\DependencyInjection\ContainerInterface; use Symfony\Component\DependencyInjection\ContainerInterface;
/** /**
* Twig extension for Symfony assets helper * Twig extension for Symfony assets helper.
* *
* @author Fabien Potencier <fabien@symfony.com> * @author Fabien Potencier <fabien@symfony.com>
*/ */

View File

@ -15,7 +15,7 @@ use Symfony\Component\Config\Definition\Builder\TreeBuilder;
use Symfony\Component\Config\Definition\ConfigurationInterface; use Symfony\Component\Config\Definition\ConfigurationInterface;
/** /**
* This class contains the configuration information for the bundle * This class contains the configuration information for the bundle.
* *
* This information is solely responsible for how the different configuration * This information is solely responsible for how the different configuration
* sections are normalized, and merged. * sections are normalized, and merged.

View File

@ -16,7 +16,7 @@ use Symfony\Component\HttpKernel\Profiler\Profiler;
use Symfony\Component\HttpKernel\Profiler\Profile; use Symfony\Component\HttpKernel\Profiler\Profile;
/** /**
* Profiler Templates Manager * Profiler Templates Manager.
* *
* @author Fabien Potencier <fabien@symfony.com> * @author Fabien Potencier <fabien@symfony.com>
* @author Artur Wielogórski <wodor@wodor.net> * @author Artur Wielogórski <wodor@wodor.net>

View File

@ -24,7 +24,7 @@ class WebProfilerExtensionTest extends TestCase
{ {
private $kernel; private $kernel;
/** /**
* @var Symfony\Component\DependencyInjection\Container $container * @var Symfony\Component\DependencyInjection\Container
*/ */
private $container; private $container;

View File

@ -66,7 +66,7 @@ class TemplateManagerTest extends TestCase
} }
/** /**
* if template exists in both profile and profiler then its name should be returned * if template exists in both profile and profiler then its name should be returned.
*/ */
public function testGetNameValidTemplate() public function testGetNameValidTemplate()
{ {
@ -85,7 +85,7 @@ class TemplateManagerTest extends TestCase
/** /**
* template should be loaded for 'foo' because other collectors are * template should be loaded for 'foo' because other collectors are
* missing in profile or in profiler * missing in profile or in profiler.
*/ */
public function testGetTemplates() public function testGetTemplates()
{ {

View File

@ -16,7 +16,7 @@ use Symfony\Component\ClassLoader\ClassMapGenerator;
class ClassMapGeneratorTest extends \PHPUnit_Framework_TestCase class ClassMapGeneratorTest extends \PHPUnit_Framework_TestCase
{ {
/** /**
* @var string $workspace * @var string|null
*/ */
private $workspace = null; private $workspace = null;

View File

@ -17,7 +17,7 @@ use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
use Symfony\Component\Config\Definition\Exception\InvalidTypeException; use Symfony\Component\Config\Definition\Exception\InvalidTypeException;
/** /**
* The base node class * The base node class.
* *
* @author Johannes M. Schmitt <schmittjoh@gmail.com> * @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/ */
@ -187,7 +187,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.
*/ */

View File

@ -337,7 +337,7 @@ class ArrayNodeDefinition extends NodeDefinition implements ParentNodeDefinition
} }
/** /**
* Returns a node builder to be used to add children and prototype * Returns a node builder to be used to add children and prototype.
* *
* @return NodeBuilder The node builder * @return NodeBuilder The node builder
*/ */

View File

@ -31,7 +31,7 @@ class BooleanNodeDefinition extends ScalarNodeDefinition
} }
/** /**
* Instantiate a Node * Instantiate a Node.
* *
* @return BooleanNode The node * @return BooleanNode The node
*/ */

View File

@ -36,7 +36,7 @@ class EnumNodeDefinition extends ScalarNodeDefinition
} }
/** /**
* Instantiate a Node * Instantiate a Node.
* *
* @return EnumNode The node * @return EnumNode The node
* *

View File

@ -26,7 +26,7 @@ class ExprBuilder
public $thenPart; public $thenPart;
/** /**
* Constructor * Constructor.
* *
* @param NodeDefinition $node The related node * @param NodeDefinition $node The related node
*/ */
@ -196,7 +196,7 @@ class ExprBuilder
} }
/** /**
* Returns the related node * Returns the related node.
* *
* @return NodeDefinition * @return NodeDefinition
* *

View File

@ -23,7 +23,7 @@ class MergeBuilder
public $allowOverwrite; public $allowOverwrite;
/** /**
* Constructor * Constructor.
* *
* @param NodeDefinition $node The related node * @param NodeDefinition $node The related node
*/ */

View File

@ -22,8 +22,7 @@ class NodeBuilder implements NodeParentInterface
protected $nodeMapping; protected $nodeMapping;
/** /**
* Constructor * Constructor.
*
*/ */
public function __construct() public function __construct()
{ {

View File

@ -39,7 +39,7 @@ abstract class NodeDefinition implements NodeParentInterface
protected $attributes = array(); protected $attributes = array();
/** /**
* Constructor * Constructor.
* *
* @param string $name The name of the node * @param string $name The name of the node
* @param NodeParentInterface $parent The parent * @param NodeParentInterface $parent The parent
@ -336,7 +336,7 @@ abstract class NodeDefinition implements NodeParentInterface
} }
/** /**
* Instantiate and configure the node according to this definition * Instantiate and configure the node according to this definition.
* *
* @return NodeInterface $node The node instance * @return NodeInterface $node The node instance
* *

View File

@ -12,7 +12,7 @@
namespace Symfony\Component\Config\Definition\Builder; namespace Symfony\Component\Config\Definition\Builder;
/** /**
* An interface that must be implemented by all node parents * An interface that must be implemented by all node parents.
* *
* @author Victor Berchet <victor@suumit.com> * @author Victor Berchet <victor@suumit.com>
*/ */

View File

@ -23,7 +23,7 @@ class NormalizationBuilder
public $remappings; public $remappings;
/** /**
* Constructor * Constructor.
* *
* @param NodeDefinition $node The related node * @param NodeDefinition $node The related node
*/ */

View File

@ -12,7 +12,7 @@
namespace Symfony\Component\Config\Definition\Builder; namespace Symfony\Component\Config\Definition\Builder;
/** /**
* An interface that must be implemented by nodes which can have children * An interface that must be implemented by nodes which can have children.
* *
* @author Victor Berchet <victor@suumit.com> * @author Victor Berchet <victor@suumit.com>
*/ */

View File

@ -21,7 +21,7 @@ use Symfony\Component\Config\Definition\ScalarNode;
class ScalarNodeDefinition extends VariableNodeDefinition class ScalarNodeDefinition extends VariableNodeDefinition
{ {
/** /**
* Instantiate a Node * Instantiate a Node.
* *
* @return ScalarNode The node * @return ScalarNode The node
*/ */

View File

@ -22,7 +22,7 @@ class ValidationBuilder
public $rules; public $rules;
/** /**
* Constructor * Constructor.
* *
* @param NodeDefinition $node The related node * @param NodeDefinition $node The related node
*/ */

View File

@ -21,7 +21,7 @@ use Symfony\Component\Config\Definition\VariableNode;
class VariableNodeDefinition extends NodeDefinition class VariableNodeDefinition extends NodeDefinition
{ {
/** /**
* Instantiate a Node * Instantiate a Node.
* *
* @return VariableNode The node * @return VariableNode The node
*/ */

View File

@ -12,7 +12,7 @@
namespace Symfony\Component\Config\Definition; namespace Symfony\Component\Config\Definition;
/** /**
* Configuration interface * Configuration interface.
* *
* @author Victor Berchet <victor@suumit.com> * @author Victor Berchet <victor@suumit.com>
*/ */

View File

@ -12,7 +12,7 @@
namespace Symfony\Component\Config\Definition\Exception; namespace Symfony\Component\Config\Definition\Exception;
/** /**
* Base exception for all configuration exceptions * Base exception for all configuration exceptions.
* *
* @author Johannes M. Schmitt <schmittjoh@gmail.com> * @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/ */

View File

@ -52,7 +52,8 @@ interface NodeInterface
/** /**
* Returns the default value of the node. * Returns the default value of the node.
* *
* @return mixed The default value * @return mixed The default value
*
* @throws \RuntimeException if the node has no default value * @throws \RuntimeException if the node has no default value
*/ */
public function getDefaultValue(); public function getDefaultValue();

View File

@ -14,7 +14,7 @@ namespace Symfony\Component\Config\Definition;
use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException; use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
/** /**
* This node represents a numeric value in the config tree * This node represents a numeric value in the config tree.
* *
* @author David Jeanmonod <david.jeanmonod@gmail.com> * @author David Jeanmonod <david.jeanmonod@gmail.com>
*/ */

View File

@ -169,7 +169,7 @@ class PrototypedArrayNode extends ArrayNode
} }
/** /**
* Retrieves the prototype * Retrieves the prototype.
* *
* @return PrototypeNodeInterface The prototype * @return PrototypeNodeInterface The prototype
*/ */

View File

@ -155,7 +155,7 @@ class ReferenceDumper
} }
/** /**
* Outputs a single config reference line * Outputs a single config reference line.
* *
* @param string $text * @param string $text
* @param int $indent * @param int $indent

View File

@ -50,7 +50,7 @@ class DirectoryResource implements ResourceInterface, \Serializable
} }
/** /**
* Returns the pattern to restrict monitored files * Returns the pattern to restrict monitored files.
* *
* @return string|null * @return string|null
*/ */

View File

@ -202,12 +202,11 @@ class ExprBuilderTest extends \PHPUnit_Framework_TestCase
} }
/** /**
* Assert that the given test builder, will return the given value * Assert that the given test builder, will return the given value.
* *
* @param mixed $value The value to test * @param mixed $value The value to test
* @param TreeBuilder $treeBuilder The tree builder to finalize * @param TreeBuilder $treeBuilder The tree builder to finalize
* * @param mixed $config The config values that new to be finalized
* @param mixed $config The config values that new to be finalized
*/ */
protected function assertFinalizedValueIs($value, $treeBuilder, $config = null) protected function assertFinalizedValueIs($value, $treeBuilder, $config = null)
{ {

View File

@ -54,7 +54,7 @@ class PrototypedArrayNodeTest extends \PHPUnit_Framework_TestCase
} }
/** /**
* Tests that when a key attribute is mapped, that key is removed from the array: * Tests that when a key attribute is mapped, that key is removed from the array.
* *
* <things> * <things>
* <option id="option1" value="foo"> * <option id="option1" value="foo">

View File

@ -22,7 +22,7 @@ namespace Symfony\Component\Config\Util;
class XmlUtils class XmlUtils
{ {
/** /**
* This class should not be instantiated * This class should not be instantiated.
*/ */
private function __construct() private function __construct()
{ {

View File

@ -219,7 +219,7 @@ class Application
} }
/** /**
* Set an input definition set to be used with this application * Set an input definition set to be used with this application.
* *
* @param InputDefinition $definition The input definition * @param InputDefinition $definition The input definition
* *
@ -782,7 +782,7 @@ class Application
} }
/** /**
* Tries to figure out the terminal width in which this application runs * Tries to figure out the terminal width in which this application runs.
* *
* @return int|null * @return int|null
*/ */
@ -794,7 +794,7 @@ class Application
} }
/** /**
* Tries to figure out the terminal height in which this application runs * Tries to figure out the terminal height in which this application runs.
* *
* @return int|null * @return int|null
*/ */
@ -806,7 +806,7 @@ class Application
} }
/** /**
* Tries to figure out the terminal dimensions based on the current environment * Tries to figure out the terminal dimensions based on the current environment.
* *
* @return array Array containing width and height * @return array Array containing width and height
*/ */
@ -972,7 +972,7 @@ class Application
} }
/** /**
* Runs and parses stty -a if it's available, suppressing any error output * Runs and parses stty -a if it's available, suppressing any error output.
* *
* @return string * @return string
*/ */
@ -995,7 +995,7 @@ class Application
} }
/** /**
* Runs and parses mode CON if it's available, suppressing any error output * Runs and parses mode CON if it's available, suppressing any error output.
* *
* @return string <width>x<height> or null if it could not be parsed * @return string <width>x<height> or null if it could not be parsed
*/ */
@ -1050,7 +1050,7 @@ class Application
} }
/** /**
* Finds alternative commands of $name * Finds alternative commands of $name.
* *
* @param string $name The full name of the command * @param string $name The full name of the command
* @param array $abbrevs The abbreviations * @param array $abbrevs The abbreviations
@ -1067,7 +1067,7 @@ class Application
} }
/** /**
* Finds alternative namespace of $name * Finds alternative namespace of $name.
* *
* @param string $name The full name of the namespace * @param string $name The full name of the namespace
* @param array $abbrevs The abbreviations * @param array $abbrevs The abbreviations
@ -1081,7 +1081,7 @@ class Application
/** /**
* Finds alternative of $name among $collection, * Finds alternative of $name among $collection,
* if nothing is found in $collection, try in $abbrevs * if nothing is found in $collection, try in $abbrevs.
* *
* @param string $name The string * @param string $name The string
* @param array|\Traversable $collection The collection * @param array|\Traversable $collection The collection

View File

@ -131,7 +131,7 @@ class Command
} }
/** /**
* Checks whether the command is enabled or not in the current environment * Checks whether the command is enabled or not in the current environment.
* *
* Override this to check for x or y and return false if the command can not * Override this to check for x or y and return false if the command can not
* run properly under the current conditions. * run properly under the current conditions.
@ -164,6 +164,7 @@ class Command
* @return null|int null or 0 if everything went fine, or an error code * @return null|int null or 0 if everything went fine, or an error code
* *
* @throws \LogicException When this abstract method is not implemented * @throws \LogicException When this abstract method is not implemented
*
* @see setCode() * @see setCode()
*/ */
protected function execute(InputInterface $input, OutputInterface $output) protected function execute(InputInterface $input, OutputInterface $output)

View File

@ -58,7 +58,7 @@ EOF
} }
/** /**
* Sets the command * Sets the command.
* *
* @param Command $command The command to set * @param Command $command The command to set
*/ */

View File

@ -160,7 +160,6 @@ class OutputFormatterStyle implements OutputFormatterStyleInterface
* @param string $option The option name * @param string $option The option name
* *
* @throws \InvalidArgumentException When the option name isn't defined * @throws \InvalidArgumentException When the option name isn't defined
*
*/ */
public function unsetOption($option) public function unsetOption($option)
{ {

View File

@ -36,10 +36,10 @@ class DescriptorHelper extends Helper
public function __construct() public function __construct()
{ {
$this $this
->register('txt', new TextDescriptor()) ->register('txt', new TextDescriptor())
->register('xml', new XmlDescriptor()) ->register('xml', new XmlDescriptor())
->register('json', new JsonDescriptor()) ->register('json', new JsonDescriptor())
->register('md', new MarkdownDescriptor()) ->register('md', new MarkdownDescriptor())
; ;
} }

View File

@ -243,7 +243,7 @@ class DialogHelper extends Helper
} }
/** /**
* Asks a question to the user, the response is hidden * Asks a question to the user, the response is hidden.
* *
* @param OutputInterface $output An Output instance * @param OutputInterface $output An Output instance
* @param string|array $question The question * @param string|array $question The question
@ -358,7 +358,6 @@ class DialogHelper extends Helper
* *
* @throws \Exception When any of the validators return an error * @throws \Exception When any of the validators return an error
* @throws \RuntimeException In case the fallback is deactivated and the response can not be hidden * @throws \RuntimeException In case the fallback is deactivated and the response can not be hidden
*
*/ */
public function askHiddenResponseAndValidate(OutputInterface $output, $question, $validator, $attempts = false, $fallback = true) public function askHiddenResponseAndValidate(OutputInterface $output, $question, $validator, $attempts = false, $fallback = true)
{ {
@ -384,7 +383,7 @@ class DialogHelper extends Helper
} }
/** /**
* Returns the helper's input stream * Returns the helper's input stream.
* *
* @return string * @return string
*/ */
@ -402,7 +401,7 @@ class DialogHelper extends Helper
} }
/** /**
* Return a valid Unix shell * Return a valid Unix shell.
* *
* @return string|bool The valid shell name, false in case no valid shell is found * @return string|bool The valid shell name, false in case no valid shell is found
*/ */
@ -440,7 +439,7 @@ class DialogHelper extends Helper
} }
/** /**
* Validate an attempt * Validate an attempt.
* *
* @param callable $interviewer A callable that will ask for a question and return the result * @param callable $interviewer A callable that will ask for a question and return the result
* @param OutputInterface $output An Output instance * @param OutputInterface $output An Output instance

View File

@ -45,28 +45,28 @@ class ProgressHelper extends Helper
private $output; private $output;
/** /**
* Current step * Current step.
* *
* @var int * @var int
*/ */
private $current; private $current;
/** /**
* Maximum number of steps * Maximum number of steps.
* *
* @var int * @var int
*/ */
private $max; private $max;
/** /**
* Start time of the progress bar * Start time of the progress bar.
* *
* @var int * @var int
*/ */
private $startTime; private $startTime;
/** /**
* List of formatting variables * List of formatting variables.
* *
* @var array * @var array
*/ */
@ -79,14 +79,14 @@ class ProgressHelper extends Helper
); );
/** /**
* Available formatting variables * Available formatting variables.
* *
* @var array * @var array
*/ */
private $formatVars; private $formatVars;
/** /**
* Stored format part widths (used for padding) * Stored format part widths (used for padding).
* *
* @var array * @var array
*/ */
@ -98,7 +98,7 @@ class ProgressHelper extends Helper
); );
/** /**
* Various time formats * Various time formats.
* *
* @var array * @var array
*/ */

View File

@ -327,7 +327,7 @@ class ArgvInput extends Input
} }
/** /**
* Returns a stringified representation of the args passed to the command * Returns a stringified representation of the args passed to the command.
* *
* @return string * @return string
*/ */

View File

@ -111,7 +111,7 @@ class ArrayInput extends Input
} }
/** /**
* Returns a stringified representation of the args passed to the command * Returns a stringified representation of the args passed to the command.
* *
* @return string * @return string
*/ */

View File

@ -212,7 +212,7 @@ abstract class Input implements InputInterface
} }
/** /**
* Escapes a token through escapeshellarg if it contains unsafe chars * Escapes a token through escapeshellarg if it contains unsafe chars.
* *
* @param string $token * @param string $token
* *

View File

@ -34,7 +34,7 @@ interface TranslatorInterface
public function cssToXPath($cssExpr, $prefix = 'descendant-or-self::'); public function cssToXPath($cssExpr, $prefix = 'descendant-or-self::');
/** /**
* Translates a parsed selector node to an XPath expression * Translates a parsed selector node to an XPath expression.
* *
* @param SelectorNode $selector * @param SelectorNode $selector
* @param string $prefix * @param string $prefix

View File

@ -15,7 +15,7 @@ use Symfony\Component\Debug\ErrorHandler;
use Symfony\Component\Debug\Exception\DummyException; use Symfony\Component\Debug\Exception\DummyException;
/** /**
* ErrorHandlerTest * ErrorHandlerTest.
* *
* @author Robert Schönthal <seroscho@googlemail.com> * @author Robert Schönthal <seroscho@googlemail.com>
*/ */

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