minor #13134 [2.3] Fixes various phpdoc and coding standards. (hhamon)

This PR was merged into the 2.3 branch.

Discussion
----------

[2.3] Fixes various phpdoc and coding standards.

| Q             | A
| ------------- | ---
| Bug fix?      | no
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | ~
| License       | MIT
| Doc PR        | ~

Commits
-------

b83da8f Fixes various phpdoc and coding standards.
This commit is contained in:
Fabien Potencier 2015-01-02 10:13:41 +01:00
commit e09b4f9a5a
60 changed files with 168 additions and 164 deletions

View File

@ -129,11 +129,11 @@ abstract class AbstractDoctrineExtension extends Extension
*/
protected function setMappingDriverConfig(array $mappingConfig, $mappingName)
{
if (is_dir($mappingConfig['dir'])) {
$this->drivers[$mappingConfig['type']][$mappingConfig['prefix']] = realpath($mappingConfig['dir']);
} else {
if (!is_dir($mappingConfig['dir'])) {
throw new \InvalidArgumentException(sprintf('Invalid Doctrine mapping path given. Cannot load Doctrine mapping/bundle named "%s".', $mappingName));
}
$this->drivers[$mappingConfig['type']][$mappingConfig['prefix']] = realpath($mappingConfig['dir']);
}
/**

View File

@ -16,6 +16,7 @@ use Symfony\Component\Form\Exception\StringCastException;
use Symfony\Component\Form\Extension\Core\ChoiceList\ObjectChoiceList;
use Doctrine\Common\Persistence\ObjectManager;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
use Doctrine\Common\Persistence\Mapping\ClassMetadata;
/**
* A choice list presenting a list of Doctrine entities as choices.
@ -35,7 +36,7 @@ class EntityChoiceList extends ObjectChoiceList
private $class;
/**
* @var \Doctrine\Common\Persistence\Mapping\ClassMetadata
* @var ClassMetadata
*/
private $classMetadata;
@ -132,7 +133,7 @@ class EntityChoiceList extends ObjectChoiceList
*
* @return array
*
* @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
* @see ChoiceListInterface
*/
public function getChoices()
{
@ -148,7 +149,7 @@ class EntityChoiceList extends ObjectChoiceList
*
* @return array
*
* @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
* @see ChoiceListInterface
*/
public function getValues()
{
@ -165,7 +166,7 @@ class EntityChoiceList extends ObjectChoiceList
*
* @return array
*
* @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
* @see ChoiceListInterface
*/
public function getPreferredViews()
{
@ -182,7 +183,7 @@ class EntityChoiceList extends ObjectChoiceList
*
* @return array
*
* @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
* @see ChoiceListInterface
*/
public function getRemainingViews()
{
@ -200,7 +201,7 @@ class EntityChoiceList extends ObjectChoiceList
*
* @return array
*
* @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
* @see ChoiceListInterface
*/
public function getChoicesForValues(array $values)
{
@ -253,7 +254,7 @@ class EntityChoiceList extends ObjectChoiceList
*
* @return array
*
* @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
* @see ChoiceListInterface
*/
public function getValuesForChoices(array $entities)
{
@ -293,7 +294,7 @@ class EntityChoiceList extends ObjectChoiceList
*
* @return array
*
* @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
* @see ChoiceListInterface
*/
public function getIndicesForChoices(array $entities)
{
@ -333,7 +334,7 @@ class EntityChoiceList extends ObjectChoiceList
*
* @return array
*
* @see Symfony\Component\Form\Extension\Core\ChoiceList\ChoiceListInterface
* @see ChoiceListInterface
*/
public function getIndicesForValues(array $values)
{
@ -416,6 +417,8 @@ class EntityChoiceList extends ObjectChoiceList
/**
* Loads the list with entities.
*
* @throws StringCastException
*/
private function load()
{

View File

@ -12,6 +12,7 @@
namespace Symfony\Bridge\Doctrine\Form;
use Doctrine\Common\Persistence\ManagerRegistry;
use Symfony\Bridge\Doctrine\Form\Type\EntityType;
use Symfony\Component\Form\AbstractExtension;
use Symfony\Component\PropertyAccess\PropertyAccess;
@ -27,7 +28,7 @@ class DoctrineOrmExtension extends AbstractExtension
protected function loadTypes()
{
return array(
new Type\EntityType($this->registry, PropertyAccess::createPropertyAccessor()),
new EntityType($this->registry, PropertyAccess::createPropertyAccessor()),
);
}

View File

@ -23,7 +23,7 @@ use Symfony\Component\EventDispatcher\EventSubscriberInterface;
*
* @author Bernhard Schussek <bschussek@gmail.com>
*
* @see Doctrine\Common\Collections\Collection
* @see Collection
*/
class MergeDoctrineCollectionListener implements EventSubscriberInterface
{

View File

@ -41,14 +41,14 @@ class DoctrineTokenProvider implements TokenProviderInterface
* Doctrine DBAL database connection
* F.ex. service id: doctrine.dbal.default_connection.
*
* @var \Doctrine\DBAL\Connection
* @var Connection
*/
private $conn;
/**
* new DoctrineTokenProvider for the RemembeMe authentication service.
*
* @param \Doctrine\DBAL\Connection $conn
* @param Connection $conn
*/
public function __construct(Connection $conn)
{
@ -65,14 +65,10 @@ class DoctrineTokenProvider implements TokenProviderInterface
$paramValues = array('series' => $series);
$paramTypes = array('series' => \PDO::PARAM_STR);
$stmt = $this->conn->executeQuery($sql, $paramValues, $paramTypes);
$row = $stmt->fetch(\PDO::FETCH_ASSOC);
$row = $stmt->fetch(\PDO::FETCH_ASSOC);
if ($row) {
return new PersistentToken($row['class'],
$row['username'],
$series,
$row['value'],
new \DateTime($row['lastUsed'])
);
return new PersistentToken($row['class'], $row['username'], $series, $row['value'], new \DateTime($row['lastUsed']));
}
throw new TokenNotFoundException('No token found.');

View File

@ -29,9 +29,6 @@ class UniqueEntityValidator extends ConstraintValidator
*/
private $registry;
/**
* @param ManagerRegistry $registry
*/
public function __construct(ManagerRegistry $registry)
{
$this->registry = $registry;

View File

@ -55,7 +55,7 @@ class Logger extends BaseLogger implements LoggerInterface, DebugLoggerInterface
}
/**
* @see Symfony\Component\HttpKernel\Log\DebugLoggerInterface
* {@inheritdoc}
*/
public function getLogs()
{
@ -67,7 +67,7 @@ class Logger extends BaseLogger implements LoggerInterface, DebugLoggerInterface
}
/**
* @see Symfony\Component\HttpKernel\Log\DebugLoggerInterface
* {@inheritdoc}
*/
public function countErrors()
{

View File

@ -11,11 +11,11 @@
namespace Symfony\Bridge\Propel1\Form\ChoiceList;
use ModelCriteria;
use BaseObject;
use Persistent;
use Symfony\Bridge\Propel1\Form\Type\ModelType;
use Symfony\Component\Form\Exception\StringCastException;
use Symfony\Component\Form\Extension\Core\ChoiceList\ObjectChoiceList;
use Symfony\Component\Form\Extension\Core\DataTransformer\ChoiceToValueTransformer;
use Symfony\Component\Form\Extension\Core\DataTransformer\ChoicesToValuesTransformer;
use Symfony\Component\OptionsResolver\Exception\InvalidOptionsException;
use Symfony\Component\OptionsResolver\Exception\MissingOptionsException;
use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
@ -40,14 +40,14 @@ class ModelChoiceList extends ObjectChoiceList
/**
* The query to retrieve the choices of this list.
*
* @var ModelCriteria
* @var \ModelCriteria
*/
protected $query;
/**
* The query to retrieve the preferred choices for this list.
*
* @var ModelCriteria
* @var \ModelCriteria
*/
protected $preferredQuery;
@ -68,16 +68,16 @@ class ModelChoiceList extends ObjectChoiceList
/**
* Constructor.
*
* @see \Symfony\Bridge\Propel1\Form\Type\ModelType How to use the preferred choices.
* @see ModelType How to use the preferred choices.
*
* @param string $class The FQCN of the model class to be loaded.
* @param string $labelPath A property path pointing to the property used for the choice labels.
* @param array $choices An optional array to use, rather than fetching the models.
* @param ModelCriteria $queryObject The query to use retrieving model data from database.
* @param \ModelCriteria $queryObject The query to use retrieving model data from database.
* @param string $groupPath A property path pointing to the property used to group the choices.
* @param array|ModelCriteria $preferred The preferred items of this choice.
* @param array|\ModelCriteria $preferred The preferred items of this choice.
* Either an array if $choices is given,
* or a ModelCriteria to be merged with the $queryObject.
* or a \ModelCriteria to be merged with the $queryObject.
* @param PropertyAccessorInterface $propertyAccessor The reflection graph for reading property paths.
*
* @throws MissingOptionsException when no model class is given
@ -101,7 +101,7 @@ class ModelChoiceList extends ObjectChoiceList
$this->identifier = $this->query->getTableMap()->getPrimaryKeys();
$this->loaded = is_array($choices) || $choices instanceof \Traversable;
if ($preferred instanceof ModelCriteria) {
if ($preferred instanceof \ModelCriteria) {
$this->preferredQuery = $preferred->mergeWith($this->query);
}
@ -184,8 +184,8 @@ class ModelChoiceList extends ObjectChoiceList
* * The choice option "expanded" is set to false.
* * The current request is the submission of the selected value.
*
* @see \Symfony\Component\Form\Extension\Core\DataTransformer\ChoicesToValuesTransformer::reverseTransform
* @see \Symfony\Component\Form\Extension\Core\DataTransformer\ChoiceToValueTransformer::reverseTransform
* @see ChoicesToValuesTransformer::reverseTransform()
* @see ChoiceToValueTransformer::reverseTransform()
*/
if (!$this->loaded) {
if (1 === count($this->identifier)) {
@ -239,8 +239,8 @@ class ModelChoiceList extends ObjectChoiceList
* It correlates with the performance optimization in {@link ModelChoiceList::getChoicesForValues()}
* as it won't load the actual entries from the database.
*
* @see \Symfony\Component\Form\Extension\Core\DataTransformer\ChoicesToValuesTransformer::transform
* @see \Symfony\Component\Form\Extension\Core\DataTransformer\ChoiceToValueTransformer::transform
* @see ChoicesToValuesTransformer::transform()
* @see ChoiceToValueTransformer::transform()
*/
if (1 === count($this->identifier)) {
$values = array();
@ -404,7 +404,7 @@ class ModelChoiceList extends ObjectChoiceList
$models = (array) $this->query->find();
$preferred = array();
if ($this->preferredQuery instanceof ModelCriteria) {
if ($this->preferredQuery instanceof \ModelCriteria) {
$preferred = (array) $this->preferredQuery->find();
}
@ -435,12 +435,12 @@ class ModelChoiceList extends ObjectChoiceList
return array();
}
if ($model instanceof Persistent) {
if ($model instanceof \Persistent) {
return array($model->getPrimaryKey());
}
// readonly="true" models do not implement Persistent.
if ($model instanceof BaseObject && method_exists($model, 'getPrimaryKey')) {
// readonly="true" models do not implement \Persistent.
if ($model instanceof \BaseObject && method_exists($model, 'getPrimaryKey')) {
return array($model->getPrimaryKey());
}

View File

@ -27,17 +27,13 @@ use Symfony\Component\DependencyInjection\LazyProxy\Instantiator\InstantiatorInt
class RuntimeInstantiator implements InstantiatorInterface
{
/**
* @var \ProxyManager\Factory\LazyLoadingValueHolderFactory
* @var LazyLoadingValueHolderFactory
*/
private $factory;
/**
* Constructor.
*/
public function __construct()
{
$config = new Configuration();
$config->setGeneratorStrategy(new EvaluatingGeneratorStrategy());
$this->factory = new LazyLoadingValueHolderFactory($config);

View File

@ -27,12 +27,12 @@ use Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface;
class ProxyDumper implements DumperInterface
{
/**
* @var \ProxyManager\ProxyGenerator\LazyLoadingValueHolderGenerator
* @var LazyLoadingValueHolderGenerator
*/
private $proxyGenerator;
/**
* @var \ProxyManager\GeneratorStrategy\BaseGeneratorStrategy
* @var BaseGeneratorStrategy
*/
private $classGenerator;

View File

@ -50,7 +50,7 @@ class HttpKernelExtension extends \Twig_Extension
*
* @return string The fragment content
*
* @see Symfony\Component\HttpKernel\Fragment\FragmentHandler::render()
* @see FragmentHandler::render()
*/
public function renderFragment($uri, $options = array())
{
@ -69,7 +69,7 @@ class HttpKernelExtension extends \Twig_Extension
*
* @return string The fragment content
*
* @see Symfony\Component\HttpKernel\Fragment\FragmentHandler::render()
* @see FragmentHandler::render()
*/
public function renderFragmentStrategy($strategy, $uri, $options = array())
{

View File

@ -55,7 +55,7 @@ class TemplateFinder implements TemplateFinderInterface
$templates = array();
foreach ($this->kernel->getBundles() as $name => $bundle) {
foreach ($this->kernel->getBundles() as $bundle) {
$templates = array_merge($templates, $this->findTemplatesInBundle($bundle));
}

View File

@ -72,7 +72,7 @@ EOF
$traces = $matcher->getTraces($input->getArgument('path_info'));
$matches = false;
foreach ($traces as $i => $trace) {
foreach ($traces as $trace) {
if (TraceableUrlMatcher::ROUTE_ALMOST_MATCHES == $trace['level']) {
$output->writeln(sprintf('<fg=yellow>Route "%s" almost matches but %s</>', $trace['name'], lcfirst($trace['log'])));
} elseif (TraceableUrlMatcher::ROUTE_MATCHES == $trace['level']) {

View File

@ -22,6 +22,7 @@ use Symfony\Component\Form\FormTypeInterface;
use Symfony\Component\Form\Form;
use Symfony\Component\Form\FormBuilder;
use Symfony\Component\Routing\Generator\UrlGeneratorInterface;
use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
use Doctrine\Bundle\DoctrineBundle\Registry;
/**
@ -209,7 +210,7 @@ class Controller extends ContainerAware
*
* @throws \LogicException If SecurityBundle is not available
*
* @see Symfony\Component\Security\Core\Authentication\Token\TokenInterface::getUser()
* @see TokenInterface::getUser()
*/
public function getUser()
{

View File

@ -42,7 +42,7 @@ class ActionsHelper extends Helper
*
* @return string The fragment content
*
* @see Symfony\Component\HttpKernel\Fragment\FragmentHandler::render()
* @see FragmentHandler::render()
*/
public function render($uri, array $options = array())
{

View File

@ -41,7 +41,7 @@ class RequestHelper extends Helper
*
* @return mixed
*
* @see Symfony\Component\HttpFoundation\Request::get()
* @see Request::get()
*/
public function getParameter($key, $default = null)
{

View File

@ -59,7 +59,7 @@ EOF
try {
$schema->addToSchema($connection->getSchemaManager()->createSchema());
} catch (SchemaException $e) {
$output->writeln("Aborting: ".$e->getMessage());
$output->writeln('Aborting: '.$e->getMessage());
return 1;
}

View File

@ -49,7 +49,7 @@ class MainConfiguration implements ConfigurationInterface
/**
* Generates the configuration tree builder.
*
* @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
* @return TreeBuilder The tree builder
*/
public function getConfigTreeBuilder()
{

View File

@ -490,7 +490,7 @@ class SecurityExtension extends Extension
}
// Parses a <provider> tag and returns the id for the related user provider service
private function createUserDaoProvider($name, $provider, ContainerBuilder $container, $master = true)
private function createUserDaoProvider($name, $provider, ContainerBuilder $container)
{
$name = $this->getUserProviderId(strtolower($name));

View File

@ -40,7 +40,7 @@ class UserLoginFormType extends AbstractType
}
/**
* @see Symfony\Component\Form\AbstractType::buildForm()
* {@inheritdoc}
*/
public function buildForm(FormBuilderInterface $builder, array $options)
{
@ -75,7 +75,7 @@ class UserLoginFormType extends AbstractType
}
/**
* @see Symfony\Component\Form\AbstractType::setDefaultOptions()
* {@inheritdoc}
*/
public function setDefaultOptions(OptionsResolverInterface $resolver)
{
@ -89,7 +89,7 @@ class UserLoginFormType extends AbstractType
}
/**
* @see Symfony\Component\Form\FormTypeInterface::getName()
* {@inheritdoc}
*/
public function getName()
{

View File

@ -22,18 +22,13 @@ class LogoutUrlExtension extends \Twig_Extension
{
private $helper;
/**
* Constructor.
*
* @param LogoutUrlHelper $helper
*/
public function __construct(LogoutUrlHelper $helper)
{
$this->helper = $helper;
}
/**
* @see Twig_Extension::getFunctions()
* {@inheritdoc}
*/
public function getFunctions()
{
@ -44,7 +39,7 @@ class LogoutUrlExtension extends \Twig_Extension
}
/**
* Generate the relative logout URL for the firewall.
* Generates the relative logout URL for the firewall.
*
* @param string $key The firewall key
*
@ -56,7 +51,7 @@ class LogoutUrlExtension extends \Twig_Extension
}
/**
* Generate the absolute logout URL for the firewall.
* Generates the absolute logout URL for the firewall.
*
* @param string $key The firewall key
*
@ -68,7 +63,7 @@ class LogoutUrlExtension extends \Twig_Extension
}
/**
* @see Twig_ExtensionInterface::getName()
* {@inheritdoc}
*/
public function getName()
{

View File

@ -77,7 +77,6 @@ EOF
throw new \RuntimeException(sprintf('File or directory "%s" is not readable', $filename));
}
$files = array();
if (is_file($filename)) {
$files = array($filename);
} elseif (is_dir($filename)) {

View File

@ -25,7 +25,7 @@ class Configuration implements ConfigurationInterface
/**
* Generates the configuration tree builder.
*
* @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
* @return TreeBuilder The tree builder
*/
public function getConfigTreeBuilder()
{

View File

@ -12,6 +12,7 @@
namespace Symfony\Bundle\TwigBundle\Extension;
use Symfony\Bundle\TwigBundle\TokenParser\RenderTokenParser;
use Symfony\Bundle\FrameworkBundle\Templating\Helper\ActionsHelper;
use Symfony\Component\DependencyInjection\ContainerInterface;
/**
@ -41,7 +42,7 @@ class ActionsExtension extends \Twig_Extension
* @param string $uri A URI
* @param array $options An array of options
*
* @see Symfony\Bundle\FrameworkBundle\Controller\ControllerResolver::render()
* @see ActionsHelper::render()
*/
public function renderUri($uri, array $options = array())
{
@ -51,7 +52,7 @@ class ActionsExtension extends \Twig_Extension
/**
* Returns the token parser instance to add to the existing list.
*
* @return array An array of Twig_TokenParser instances
* @return array An array of \Twig_TokenParser instances
*/
public function getTokenParsers()
{

View File

@ -36,11 +36,7 @@ class RouterController
$this->profiler = $profiler;
$this->twig = $twig;
$this->matcher = $matcher;
$this->routes = $routes;
if (null === $this->routes && $this->matcher instanceof RouterInterface) {
$this->routes = $matcher->getRouteCollection();
}
$this->routes = (null === $routes && $matcher instanceof RouterInterface) ? $matcher->getRouteCollection() : $routes;
}
/**

View File

@ -27,7 +27,7 @@ class Configuration implements ConfigurationInterface
/**
* Generates the configuration tree builder.
*
* @return \Symfony\Component\Config\Definition\Builder\TreeBuilder The tree builder
* @return TreeBuilder The tree builder
*/
public function getConfigTreeBuilder()
{

View File

@ -25,7 +25,7 @@ use Symfony\Bundle\WebProfilerBundle\EventListener\WebDebugToolbarListener;
* <webprofiler:config
* toolbar="true"
* intercept-redirects="true"
* />
* />
*
* @author Fabien Potencier <fabien@symfony.com>
*/

View File

@ -205,7 +205,7 @@ abstract class Client
*
* @return object|null A response instance
*
* @see doRequest
* @see doRequest()
*
* @api
*/
@ -234,7 +234,7 @@ abstract class Client
*
* @return object|null A Request instance
*
* @see doRequest
* @see doRequest()
*
* @api
*/

View File

@ -165,7 +165,7 @@ class Command
*
* @throws \LogicException When this abstract method is not implemented
*
* @see setCode()
* @see setCode()
*/
protected function execute(InputInterface $input, OutputInterface $output)
{

View File

@ -33,8 +33,8 @@ namespace Symfony\Component\Console\Input;
*
* @author Fabien Potencier <fabien@symfony.com>
*
* @see http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html
* @see http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html#tag_12_02
* @see http://www.gnu.org/software/libc/manual/html_node/Argument-Syntax.html
* @see http://www.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap12.html#tag_12_02
*
* @api
*/

View File

@ -61,8 +61,8 @@ class ExceptionHandler
*
* @param \Exception $exception An \Exception instance
*
* @see sendPhpResponse
* @see createResponse
* @see sendPhpResponse()
* @see createResponse()
*/
public function handle(\Exception $exception)
{

View File

@ -103,7 +103,7 @@ class ContainerAwareEventDispatcher extends EventDispatcher
}
/**
* @see EventDispatcherInterface::hasListeners
* @see EventDispatcherInterface::hasListeners()
*/
public function hasListeners($eventName = null)
{
@ -119,7 +119,7 @@ class ContainerAwareEventDispatcher extends EventDispatcher
}
/**
* @see EventDispatcherInterface::getListeners
* @see EventDispatcherInterface::getListeners()
*/
public function getListeners($eventName = null)
{

View File

@ -47,7 +47,7 @@ class Event
/**
* Returns whether further event listeners should be triggered.
*
* @see Event::stopPropagation
* @see Event::stopPropagation()
*
* @return bool Whether propagation was already stopped for this event.
*

View File

@ -33,7 +33,7 @@ class EventDispatcher implements EventDispatcherInterface
private $sorted = array();
/**
* @see EventDispatcherInterface::dispatch
* @see EventDispatcherInterface::dispatch()
*
* @api
*/
@ -56,7 +56,7 @@ class EventDispatcher implements EventDispatcherInterface
}
/**
* @see EventDispatcherInterface::getListeners
* @see EventDispatcherInterface::getListeners()
*/
public function getListeners($eventName = null)
{
@ -78,7 +78,7 @@ class EventDispatcher implements EventDispatcherInterface
}
/**
* @see EventDispatcherInterface::hasListeners
* @see EventDispatcherInterface::hasListeners()
*/
public function hasListeners($eventName = null)
{
@ -86,7 +86,7 @@ class EventDispatcher implements EventDispatcherInterface
}
/**
* @see EventDispatcherInterface::addListener
* @see EventDispatcherInterface::addListener()
*
* @api
*/
@ -97,7 +97,7 @@ class EventDispatcher implements EventDispatcherInterface
}
/**
* @see EventDispatcherInterface::removeListener
* @see EventDispatcherInterface::removeListener()
*/
public function removeListener($eventName, $listener)
{
@ -113,7 +113,7 @@ class EventDispatcher implements EventDispatcherInterface
}
/**
* @see EventDispatcherInterface::addSubscriber
* @see EventDispatcherInterface::addSubscriber()
*
* @api
*/
@ -133,7 +133,7 @@ class EventDispatcher implements EventDispatcherInterface
}
/**
* @see EventDispatcherInterface::removeSubscriber
* @see EventDispatcherInterface::removeSubscriber()
*/
public function removeSubscriber(EventSubscriberInterface $subscriber)
{

View File

@ -228,7 +228,7 @@ abstract class AbstractAdapter implements AdapterInterface
* isSupported in the adapters as the generic implementation provides a cache
* layer.
*
* @see isSupported
* @see isSupported()
*
* @return bool Whether the adapter is supported
*/

View File

@ -30,7 +30,7 @@ namespace Symfony\Component\Finder\Comparator;
* @copyright 2004-2005 Fabien Potencier <fabien@symfony.com>
* @copyright 2002 Richard Clamp <richardc@unixbeard.net>
*
* @see http://physics.nist.gov/cuu/Units/binary.html
* @see http://physics.nist.gov/cuu/Units/binary.html
*/
class NumberComparator extends Comparator
{

View File

@ -15,7 +15,17 @@ use Symfony\Component\Finder\Adapter\AdapterInterface;
use Symfony\Component\Finder\Adapter\GnuFindAdapter;
use Symfony\Component\Finder\Adapter\BsdFindAdapter;
use Symfony\Component\Finder\Adapter\PhpAdapter;
use Symfony\Component\Finder\Comparator\DateComparator;
use Symfony\Component\Finder\Comparator\NumberComparator;
use Symfony\Component\Finder\Exception\ExceptionInterface;
use Symfony\Component\Finder\Iterator\CustomFilterIterator;
use Symfony\Component\Finder\Iterator\DateRangeFilterIterator;
use Symfony\Component\Finder\Iterator\DepthRangeFilterIterator;
use Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator;
use Symfony\Component\Finder\Iterator\FilecontentFilterIterator;
use Symfony\Component\Finder\Iterator\FilenameFilterIterator;
use Symfony\Component\Finder\Iterator\SizeRangeFilterIterator;
use Symfony\Component\Finder\Iterator\SortableIterator;
/**
* Finder allows to build rules to find files and directories.
@ -202,8 +212,8 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\DepthRangeFilterIterator
* @see Symfony\Component\Finder\Comparator\NumberComparator
* @see DepthRangeFilterIterator
* @see NumberComparator
*
* @api
*/
@ -229,8 +239,8 @@ class Finder implements \IteratorAggregate, \Countable
* @return Finder The current Finder instance
*
* @see strtotime
* @see Symfony\Component\Finder\Iterator\DateRangeFilterIterator
* @see Symfony\Component\Finder\Comparator\DateComparator
* @see DateRangeFilterIterator
* @see DateComparator
*
* @api
*/
@ -254,7 +264,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\FilenameFilterIterator
* @see FilenameFilterIterator
*
* @api
*/
@ -272,7 +282,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\FilenameFilterIterator
* @see FilenameFilterIterator
*
* @api
*/
@ -295,7 +305,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\FilecontentFilterIterator
* @see FilecontentFilterIterator
*/
public function contains($pattern)
{
@ -316,7 +326,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\FilecontentFilterIterator
* @see FilecontentFilterIterator
*/
public function notContains($pattern)
{
@ -339,7 +349,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\FilenameFilterIterator
* @see FilenameFilterIterator
*/
public function path($pattern)
{
@ -362,7 +372,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\FilenameFilterIterator
* @see FilenameFilterIterator
*/
public function notPath($pattern)
{
@ -382,8 +392,8 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\SizeRangeFilterIterator
* @see Symfony\Component\Finder\Comparator\NumberComparator
* @see SizeRangeFilterIterator
* @see NumberComparator
*
* @api
*/
@ -401,7 +411,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator
* @see ExcludeDirectoryFilterIterator
*
* @api
*/
@ -419,7 +429,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator
* @see ExcludeDirectoryFilterIterator
*
* @api
*/
@ -441,7 +451,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\ExcludeDirectoryFilterIterator
* @see ExcludeDirectoryFilterIterator
*
* @api
*/
@ -459,7 +469,7 @@ class Finder implements \IteratorAggregate, \Countable
/**
* Adds VCS patterns.
*
* @see ignoreVCS
* @see ignoreVCS()
*
* @param string|string[] $pattern VCS patterns to ignore
*/
@ -483,7 +493,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\SortableIterator
* @see SortableIterator
*
* @api
*/
@ -501,7 +511,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\SortableIterator
* @see SortableIterator
*
* @api
*/
@ -519,7 +529,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\SortableIterator
* @see SortableIterator
*
* @api
*/
@ -539,7 +549,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\SortableIterator
* @see SortableIterator
*
* @api
*/
@ -561,7 +571,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\SortableIterator
* @see SortableIterator
*
* @api
*/
@ -581,7 +591,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\SortableIterator
* @see SortableIterator
*
* @api
*/
@ -602,7 +612,7 @@ class Finder implements \IteratorAggregate, \Countable
*
* @return Finder The current Finder instance
*
* @see Symfony\Component\Finder\Iterator\CustomFilterIterator
* @see CustomFilterIterator
*
* @api
*/

View File

@ -501,7 +501,7 @@ class ChoiceList implements ChoiceListInterface
*
* @return array The fixed choices.
*
* @see fixChoice
* @see fixChoice()
*/
protected function fixChoices(array $choices)
{

View File

@ -88,7 +88,7 @@ interface ChoiceListInterface
* choice indices as keys on the lowest levels and the choice
* group names in the keys of the higher levels
*
* @see getPreferredValues
* @see getPreferredValues()
*/
public function getRemainingViews();

View File

@ -16,9 +16,7 @@ use Symfony\Component\Form\FormBuilder;
class FormBuilderTest extends \PHPUnit_Framework_TestCase
{
private $dispatcher;
private $factory;
private $builder;
protected function setUp()
@ -43,7 +41,7 @@ class FormBuilderTest extends \PHPUnit_Framework_TestCase
* Changing the name is not allowed, otherwise the name and property path
* are not synchronized anymore.
*
* @see FormType::buildForm
* @see FormType::buildForm()
*/
public function testNoSetName()
{

View File

@ -139,7 +139,7 @@ class UploadedFile extends File
*
* @return string|null The mime type
*
* @see getMimeType
* @see getMimeType()
*
* @api
*/

View File

@ -1223,7 +1223,7 @@ class Request
*
* @api
*
* @see getRealMethod
* @see getRealMethod()
*/
public function getMethod()
{
@ -1247,7 +1247,7 @@ class Request
*
* @return string The request method
*
* @see getMethod
* @see getMethod()
*/
public function getRealMethod()
{

View File

@ -162,7 +162,7 @@ EOF;
* If the size of a file is greater than the allowed size (from php.ini) then
* an invalid UploadedFile is returned with an error set to UPLOAD_ERR_INI_SIZE.
*
* @see Symfony\Component\HttpFoundation\File\UploadedFile
* @see UploadedFile
*
* @param array $files An array of files
*

View File

@ -11,6 +11,8 @@
namespace Symfony\Component\HttpKernel\Controller;
use Symfony\Component\HttpKernel\Fragment\FragmentRendererInterface;
/**
* Acts as a marker and a data holder for a Controller.
*
@ -20,8 +22,7 @@ namespace Symfony\Component\HttpKernel\Controller;
*
* @author Fabien Potencier <fabien@symfony.com>
*
* @see Symfony\Component\HttpKernel\FragmentRenderer
* @see Symfony\Component\HttpKernel\Fragment\FragmentRendererInterface
* @see FragmentRendererInterface
*/
class ControllerReference
{

View File

@ -56,7 +56,7 @@ class EsiFragmentRenderer extends RoutableFragmentRenderer
* * alt: an alternative URI to render in case of an error
* * comment: a comment to add when returning an esi:include tag
*
* @see Symfony\Component\HttpKernel\HttpCache\ESI
* @see Esi
*/
public function render($uri, Request $request, array $options = array())
{

View File

@ -19,8 +19,6 @@ use Symfony\Component\HttpFoundation\Response;
* Interface implemented by all rendering strategies.
*
* @author Fabien Potencier <fabien@symfony.com>
*
* @see Symfony\Component\HttpKernel\FragmentRenderer
*/
interface FragmentRendererInterface
{

View File

@ -3,11 +3,12 @@
namespace Symfony\Component\HttpKernel\Tests\Fixtures\ExtensionPresentBundle\Command;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\HttpKernel\Bundle;
/**
* This command has a required parameter on the constructor and will be ignored by the default Bundle implementation.
*
* @see Symfony\Component\HttpKernel\Bundle\Bundle::registerCommands
* @see Bundle::registerCommands()
*/
class BarCommand extends Command
{

View File

@ -510,7 +510,7 @@ class NumberFormatter
*
* @return bool|string The parsed value of false on error
*
* @see http://www.php.net/manual/en/numberformatter.parse.php
* @see http://www.php.net/manual/en/numberformatter.parse.php
*/
public function parse($value, $type = self::TYPE_DOUBLE, &$position = 0)
{

View File

@ -9,13 +9,16 @@
* file that was distributed with this source code.
*/
use Symfony\Component\Intl\Collator\Collator as IntlCollator;
use Symfony\Component\Intl\Collator\StubCollator;
/**
* Stub implementation for the Collator class of the intl extension.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*
* @see \Symfony\Component\Intl\Collator\StubCollator
* @see StubCollator
*/
class Collator extends \Symfony\Component\Intl\Collator\Collator
class Collator extends IntlCollator
{
}

View File

@ -9,13 +9,15 @@
* file that was distributed with this source code.
*/
use Symfony\Component\Intl\DateFormatter\IntlDateFormatter as BaseIntlDateFormatter;
/**
* Stub implementation for the IntlDateFormatter class of the intl extension.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*
* @see \Symfony\Component\Intl\DateFormatter\IntlDateFormatter
* @see BaseIntlDateFormatter
*/
class IntlDateFormatter extends \Symfony\Component\Intl\DateFormatter\IntlDateFormatter
class IntlDateFormatter extends BaseIntlDateFormatter
{
}

View File

@ -9,13 +9,15 @@
* file that was distributed with this source code.
*/
use Symfony\Component\Intl\Locale\Locale as IntlLocale;
/**
* Stub implementation for the Locale class of the intl extension.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*
* @see \Symfony\Component\Intl\Locale\Locale
* @see IntlLocale
*/
class Locale extends \Symfony\Component\Intl\Locale\Locale
class Locale extends IntlLocale
{
}

View File

@ -9,13 +9,15 @@
* file that was distributed with this source code.
*/
use Symfony\Component\Intl\NumberFormatter\NumberFormatter as IntlNumberFormatter;
/**
* Stub implementation for the NumberFormatter class of the intl extension.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*
* @see \Symfony\Component\Intl\NumberFormatter\NumberFormatter
* @see IntlNumberFormatter
*/
class NumberFormatter extends \Symfony\Component\Intl\NumberFormatter\NumberFormatter
class NumberFormatter extends IntlNumberFormatter
{
}

View File

@ -22,7 +22,7 @@ if (!function_exists('intl_is_failure')) {
*
* @return bool Whether the error code indicates an error.
*
* @see \Symfony\Component\Intl\Globals\StubIntlGlobals::isFailure
* @see IntlGlobals::isFailure()
*/
function intl_is_failure($errorCode)
{
@ -38,7 +38,7 @@ if (!function_exists('intl_is_failure')) {
* @return bool The error code of the last intl function call or
* IntlGlobals::U_ZERO_ERROR if no error occurred.
*
* @see \Symfony\Component\Intl\Globals\StubIntlGlobals::getErrorCode
* @see IntlGlobals::getErrorCode()
*/
function intl_get_error_code()
{
@ -54,7 +54,7 @@ if (!function_exists('intl_is_failure')) {
* @return bool The error message of the last intl function call or
* "U_ZERO_ERROR" if no error occurred.
*
* @see \Symfony\Component\Intl\Globals\StubIntlGlobals::getErrorMessage
* @see IntlGlobals::getErrorMessage()
*/
function intl_get_error_message()
{
@ -69,7 +69,7 @@ if (!function_exists('intl_is_failure')) {
*
* @return string The name of the error code constant.
*
* @see \Symfony\Component\Intl\Globals\StubIntlGlobals::getErrorName
* @see IntlGlobals::getErrorName()
*/
function intl_error_name($errorCode)
{

View File

@ -11,11 +11,13 @@
namespace Symfony\Component\Security\Core\Util;
use Doctrine\Common\Util\ClassUtils as DoctrineClassUtils;
/**
* Class related functionality for objects that
* might or might not be proxy objects at the moment.
*
* @see Doctrine\Common\Util\ClassUtils
* @see DoctrineClassUtils
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Johannes Schmitt <schmittjoh@gmail.com>

View File

@ -58,7 +58,7 @@ class Stopwatch
*
* The id parameter is used to retrieve the events from this section.
*
* @see getSectionEvents
* @see getSectionEvents()
*
* @param string $id The identifier of the section
*

View File

@ -65,7 +65,7 @@ interface ConstraintViolationInterface
* @return array A possibly empty list of parameters indexed by the names
* that appear in the message template.
*
* @see getMessageTemplate
* @see getMessageTemplate()
*
* @api
*/

View File

@ -41,7 +41,7 @@ interface GlobalExecutionContextInterface
*
* @return mixed The root value.
*
* @see ExecutionContextInterface::getRoot
* @see ExecutionContextInterface::getRoot()
*/
public function getRoot();

View File

@ -18,8 +18,8 @@ namespace Symfony\Component\Validator\Mapping\Loader;
*
* @author Bulat Shakirzyanov <mallluhuct@gmail.com>
*
* @see Symfony\Component\Validator\Mapping\Loader\YamlFileLoader
* @see Symfony\Component\Validator\Mapping\Loader\XmlFileLoader
* @see YamlFileLoader
* @see XmlFileLoader
*/
abstract class FilesLoader extends LoaderChain
{

View File

@ -16,7 +16,7 @@ namespace Symfony\Component\Validator\Mapping\Loader;
*
* @author Bulat Shakirzyanov <mallluhuct@gmail.com>
*
* @see Symfony\Component\Validator\Mapping\Loader\FilesLoader
* @see FilesLoader
*/
class XmlFilesLoader extends FilesLoader
{

View File

@ -16,7 +16,7 @@ namespace Symfony\Component\Validator\Mapping\Loader;
*
* @author Bulat Shakirzyanov <mallluhuct@gmail.com>
*
* @see Symfony\Component\Validator\Mapping\Loader\FilesLoader
* @see FilesLoader
*/
class YamlFilesLoader extends FilesLoader
{