Merge branch '3.3' into 3.4
* 3.3: [3.3] More docblock fixes [2.7] More docblock fixes
This commit is contained in:
commit
629895c3ef
@ -13,9 +13,6 @@ namespace Symfony\Bridge\Doctrine\Tests\Fixtures\Type;
|
||||
|
||||
class StringWrapper
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $string;
|
||||
|
||||
/**
|
||||
|
@ -340,7 +340,7 @@ class SymfonyTestsListenerTrait
|
||||
}
|
||||
|
||||
/**
|
||||
* @param Test $test
|
||||
* @param TestCase $test
|
||||
*
|
||||
* @return bool
|
||||
*/
|
||||
|
@ -409,8 +409,6 @@ class XmlDescriptor extends Descriptor
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $arguments
|
||||
*
|
||||
* @return \DOMNode[]
|
||||
*/
|
||||
private function getArgumentNodes(array $arguments, \DOMDocument $dom)
|
||||
@ -521,10 +519,6 @@ class XmlDescriptor extends Descriptor
|
||||
return $dom;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param \DOMElement $element
|
||||
* @param array $eventListeners
|
||||
*/
|
||||
private function appendEventListenerDocument(EventDispatcherInterface $eventDispatcher, $event, \DOMElement $element, array $eventListeners)
|
||||
{
|
||||
foreach ($eventListeners as $listener) {
|
||||
|
@ -80,10 +80,6 @@ class Cookie
|
||||
|
||||
/**
|
||||
* Returns the HTTP representation of the Cookie.
|
||||
*
|
||||
* @return string The HTTP representation of the Cookie
|
||||
*
|
||||
* @throws \UnexpectedValueException
|
||||
*/
|
||||
public function __toString()
|
||||
{
|
||||
|
@ -227,10 +227,6 @@ class PhpArrayAdapter implements AdapterInterface, PruneableInterface, Resettabl
|
||||
}
|
||||
|
||||
/**
|
||||
* Generator for items.
|
||||
*
|
||||
* @param array $keys
|
||||
*
|
||||
* @return \Generator
|
||||
*/
|
||||
private function generateItems(array $keys)
|
||||
|
@ -19,9 +19,6 @@ namespace Symfony\Component\Config;
|
||||
*/
|
||||
class ResourceCheckerConfigCacheFactory implements ConfigCacheFactoryInterface
|
||||
{
|
||||
/**
|
||||
* @var iterable|ResourceCheckerInterface[]
|
||||
*/
|
||||
private $resourceCheckers = array();
|
||||
|
||||
/**
|
||||
|
@ -253,11 +253,9 @@ class TextDescriptor extends Descriptor
|
||||
/**
|
||||
* Formats command aliases to show them in the command description.
|
||||
*
|
||||
* @param Command $command
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
private function getCommandAliasesText($command)
|
||||
private function getCommandAliasesText(Command $command)
|
||||
{
|
||||
$text = '';
|
||||
$aliases = $command->getAliases();
|
||||
|
@ -504,8 +504,6 @@ class Table
|
||||
/**
|
||||
* fill cells for a row that contains colspan > 1.
|
||||
*
|
||||
* @param array|\Traversable $row
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
private function fillCells($row)
|
||||
@ -578,10 +576,8 @@ class Table
|
||||
|
||||
/**
|
||||
* Calculates columns widths.
|
||||
*
|
||||
* @param array $rows
|
||||
*/
|
||||
private function calculateColumnsWidth($rows)
|
||||
private function calculateColumnsWidth(array $rows)
|
||||
{
|
||||
for ($column = 0; $column < $this->numberOfColumns; ++$column) {
|
||||
$lengths = array();
|
||||
|
@ -53,8 +53,6 @@ class GraphvizDumper extends Dumper
|
||||
* * node.definition: The default options for services that are defined via service definition instances
|
||||
* * node.missing: The default options for missing services
|
||||
*
|
||||
* @param array $options An array of options
|
||||
*
|
||||
* @return string The dot representation of the service container
|
||||
*/
|
||||
public function dump(array $options = array())
|
||||
|
@ -65,7 +65,7 @@ class PhpDumper extends Dumper
|
||||
private $asFiles;
|
||||
|
||||
/**
|
||||
* @var \Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface
|
||||
* @var ProxyDumper
|
||||
*/
|
||||
private $proxyDumper;
|
||||
|
||||
|
@ -36,11 +36,6 @@ class Variable
|
||||
$this->name = $name;
|
||||
}
|
||||
|
||||
/**
|
||||
* Converts the object to a string.
|
||||
*
|
||||
* @return string
|
||||
*/
|
||||
public function __toString()
|
||||
{
|
||||
return $this->name;
|
||||
|
@ -1093,9 +1093,6 @@ class FilesystemTest extends FilesystemTestCase
|
||||
$this->assertEquals($expectedPath, $path);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providePathsForMakePathRelative()
|
||||
{
|
||||
$paths = array(
|
||||
@ -1350,9 +1347,6 @@ class FilesystemTest extends FilesystemTestCase
|
||||
$this->assertEquals($expectedResult, $result);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function providePathsForIsAbsolutePath()
|
||||
{
|
||||
return array(
|
||||
|
@ -364,10 +364,6 @@ class ChoiceType extends AbstractType
|
||||
|
||||
/**
|
||||
* Adds the sub fields for an expanded choice field.
|
||||
*
|
||||
* @param FormBuilderInterface $builder The form builder
|
||||
* @param array $choiceViews The choice view objects
|
||||
* @param array $options The build options
|
||||
*/
|
||||
private function addSubForms(FormBuilderInterface $builder, array $choiceViews, array $options)
|
||||
{
|
||||
@ -388,11 +384,6 @@ class ChoiceType extends AbstractType
|
||||
}
|
||||
|
||||
/**
|
||||
* @param FormBuilderInterface $builder
|
||||
* @param $name
|
||||
* @param $choiceView
|
||||
* @param array $options
|
||||
*
|
||||
* @return mixed
|
||||
*/
|
||||
private function addSubForm(FormBuilderInterface $builder, $name, ChoiceView $choiceView, array $options)
|
||||
|
@ -21,12 +21,6 @@ class FormEvent extends Event
|
||||
private $form;
|
||||
protected $data;
|
||||
|
||||
/**
|
||||
* Constructs an event.
|
||||
*
|
||||
* @param FormInterface $form The associated form
|
||||
* @param mixed $data The data
|
||||
*/
|
||||
public function __construct(FormInterface $form, $data)
|
||||
{
|
||||
$this->form = $form;
|
||||
|
@ -41,8 +41,6 @@ class PropertyPathMapperTest extends TestCase
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $path
|
||||
*
|
||||
* @return \PHPUnit_Framework_MockObject_MockObject
|
||||
*/
|
||||
private function getPropertyPath($path)
|
||||
|
@ -20,13 +20,10 @@ use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
|
||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||
|
||||
/**
|
||||
* RequestDataCollector.
|
||||
*
|
||||
* @author Fabien Potencier <fabien@symfony.com>
|
||||
*/
|
||||
class RequestDataCollector extends DataCollector implements EventSubscriberInterface, LateDataCollectorInterface
|
||||
{
|
||||
/** @var \SplObjectStorage */
|
||||
protected $controllers;
|
||||
|
||||
public function __construct()
|
||||
|
@ -45,9 +45,6 @@ class FilterControllerArgumentsEvent extends FilterControllerEvent
|
||||
return $this->arguments;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $arguments
|
||||
*/
|
||||
public function setArguments(array $arguments)
|
||||
{
|
||||
$this->arguments = $arguments;
|
||||
|
@ -27,9 +27,6 @@ use Symfony\Component\HttpFoundation\Request;
|
||||
*/
|
||||
class FilterControllerEvent extends KernelEvent
|
||||
{
|
||||
/**
|
||||
* The current controller.
|
||||
*/
|
||||
private $controller;
|
||||
|
||||
public function __construct(HttpKernelInterface $kernel, callable $controller, Request $request, $requestType)
|
||||
@ -49,11 +46,6 @@ class FilterControllerEvent extends KernelEvent
|
||||
return $this->controller;
|
||||
}
|
||||
|
||||
/**
|
||||
* Sets a new controller.
|
||||
*
|
||||
* @param callable $controller
|
||||
*/
|
||||
public function setController(callable $controller)
|
||||
{
|
||||
$this->controller = $controller;
|
||||
|
@ -50,8 +50,6 @@ abstract class AbstractTestSessionListener implements EventSubscriberInterface
|
||||
/**
|
||||
* Checks if session was initialized and saves if current request is master
|
||||
* Runs on 'kernel.response' in test environment.
|
||||
*
|
||||
* @param FilterResponseEvent $event
|
||||
*/
|
||||
public function onKernelResponse(FilterResponseEvent $event)
|
||||
{
|
||||
|
@ -113,8 +113,6 @@ abstract class AbstractSurrogate implements SurrogateInterface
|
||||
|
||||
/**
|
||||
* Remove the Surrogate from the Surrogate-Control header.
|
||||
*
|
||||
* @param Response $response
|
||||
*/
|
||||
protected function removeFromControl(Response $response)
|
||||
{
|
||||
|
@ -67,11 +67,6 @@ class HttpCache implements HttpKernelInterface, TerminableInterface
|
||||
* the cache can serve a stale response when an error is encountered (default: 60).
|
||||
* This setting is overridden by the stale-if-error HTTP Cache-Control extension
|
||||
* (see RFC 5861).
|
||||
*
|
||||
* @param HttpKernelInterface $kernel An HttpKernelInterface instance
|
||||
* @param StoreInterface $store A Store instance
|
||||
* @param SurrogateInterface $surrogate A SurrogateInterface instance
|
||||
* @param array $options An array of options
|
||||
*/
|
||||
public function __construct(HttpKernelInterface $kernel, StoreInterface $store, SurrogateInterface $surrogate = null, array $options = array())
|
||||
{
|
||||
|
@ -543,8 +543,6 @@ abstract class Kernel implements KernelInterface, RebootableInterface, Terminabl
|
||||
* The extension point similar to the Bundle::build() method.
|
||||
*
|
||||
* Use this method to register compiler passes and manipulate the container during the building process.
|
||||
*
|
||||
* @param ContainerBuilder $container
|
||||
*/
|
||||
protected function build(ContainerBuilder $container)
|
||||
{
|
||||
|
@ -96,8 +96,8 @@ class ExceptionListenerTest extends TestCase
|
||||
|
||||
$request = new Request();
|
||||
$exception = new \Exception('foo');
|
||||
$event = new GetResponseForExceptionEvent(new TestKernel(), $request, 'foo', $exception);
|
||||
$event2 = new GetResponseForExceptionEvent(new TestKernelThatThrowsException(), $request, 'foo', $exception);
|
||||
$event = new GetResponseForExceptionEvent(new TestKernel(), $request, HttpKernelInterface::MASTER_REQUEST, $exception);
|
||||
$event2 = new GetResponseForExceptionEvent(new TestKernelThatThrowsException(), $request, HttpKernelInterface::MASTER_REQUEST, $exception);
|
||||
|
||||
return array(
|
||||
array($event, $event2),
|
||||
@ -116,7 +116,7 @@ class ExceptionListenerTest extends TestCase
|
||||
$request = Request::create('/');
|
||||
$request->setRequestFormat('xml');
|
||||
|
||||
$event = new GetResponseForExceptionEvent($kernel, $request, 'foo', new \Exception('foo'));
|
||||
$event = new GetResponseForExceptionEvent($kernel, $request, HttpKernelInterface::MASTER_REQUEST, new \Exception('foo'));
|
||||
$listener->onKernelException($event);
|
||||
|
||||
$response = $event->getResponse();
|
||||
|
@ -233,9 +233,6 @@ class RouteCompiler implements RouteCompilerInterface
|
||||
/**
|
||||
* Determines the longest static prefix possible for a route.
|
||||
*
|
||||
* @param Route $route
|
||||
* @param array $tokens
|
||||
*
|
||||
* @return string The leading static part of a route's path
|
||||
*/
|
||||
private static function determineStaticPrefix(Route $route, array $tokens)
|
||||
|
@ -18,7 +18,7 @@ class CompiledRouteTest extends TestCase
|
||||
{
|
||||
public function testAccessors()
|
||||
{
|
||||
$compiled = new CompiledRoute('prefix', 'regex', array('tokens'), array(), array(), array(), array(), array('variables'));
|
||||
$compiled = new CompiledRoute('prefix', 'regex', array('tokens'), array(), null, array(), array(), array('variables'));
|
||||
$this->assertEquals('prefix', $compiled->getStaticPrefix(), '__construct() takes a static prefix as its second argument');
|
||||
$this->assertEquals('regex', $compiled->getRegex(), '__construct() takes a regexp as its third argument');
|
||||
$this->assertEquals(array('tokens'), $compiled->getTokens(), '__construct() takes an array of tokens as its fourth argument');
|
||||
|
@ -39,9 +39,6 @@ abstract class AbstractFormLoginAuthenticator extends AbstractGuardAuthenticator
|
||||
/**
|
||||
* Override to change what happens after a bad username/password is submitted.
|
||||
*
|
||||
* @param Request $request
|
||||
* @param AuthenticationException $exception
|
||||
*
|
||||
* @return RedirectResponse
|
||||
*/
|
||||
public function onAuthenticationFailure(Request $request, AuthenticationException $exception)
|
||||
@ -96,9 +93,6 @@ abstract class AbstractFormLoginAuthenticator extends AbstractGuardAuthenticator
|
||||
* Override to control what happens when the user hits a secure page
|
||||
* but isn't logged in yet.
|
||||
*
|
||||
* @param Request $request
|
||||
* @param AuthenticationException|null $authException
|
||||
*
|
||||
* @return RedirectResponse
|
||||
*/
|
||||
public function start(Request $request, AuthenticationException $authException = null)
|
||||
|
@ -63,8 +63,6 @@ class GuardAuthenticationListener implements ListenerInterface
|
||||
|
||||
/**
|
||||
* Iterates over each authenticator to see if each wants to authenticate the request.
|
||||
*
|
||||
* @param GetResponseEvent $event
|
||||
*/
|
||||
public function handle(GetResponseEvent $event)
|
||||
{
|
||||
@ -186,8 +184,6 @@ class GuardAuthenticationListener implements ListenerInterface
|
||||
|
||||
/**
|
||||
* Should be called if this listener will support remember me.
|
||||
*
|
||||
* @param RememberMeServicesInterface $rememberMeServices
|
||||
*/
|
||||
public function setRememberMeServices(RememberMeServicesInterface $rememberMeServices)
|
||||
{
|
||||
@ -197,11 +193,6 @@ class GuardAuthenticationListener implements ListenerInterface
|
||||
/**
|
||||
* Checks to see if remember me is supported in the authenticator and
|
||||
* on the firewall. If it is, the RememberMeServicesInterface is notified.
|
||||
*
|
||||
* @param AuthenticatorInterface $guardAuthenticator
|
||||
* @param Request $request
|
||||
* @param TokenInterface $token
|
||||
* @param Response $response
|
||||
*/
|
||||
private function triggerRememberMe(GuardAuthenticatorInterface $guardAuthenticator, Request $request, TokenInterface $token, Response $response = null)
|
||||
{
|
||||
|
@ -42,12 +42,6 @@ class DefaultAuthenticationFailureHandler implements AuthenticationFailureHandle
|
||||
'failure_path_parameter' => '_failure_path',
|
||||
);
|
||||
|
||||
/**
|
||||
* @param HttpKernelInterface $httpKernel
|
||||
* @param HttpUtils $httpUtils
|
||||
* @param array $options Options for processing a failed authentication attempt
|
||||
* @param LoggerInterface $logger Optional logger
|
||||
*/
|
||||
public function __construct(HttpKernelInterface $httpKernel, HttpUtils $httpUtils, array $options = array(), LoggerInterface $logger = null)
|
||||
{
|
||||
$this->httpKernel = $httpKernel;
|
||||
|
@ -19,8 +19,6 @@ namespace Symfony\Component\Serializer\Mapping;
|
||||
class ClassMetadata implements ClassMetadataInterface
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
*
|
||||
* @internal This property is public in order to reduce the size of the
|
||||
* class' serialized representation. Do not access it. Use
|
||||
* {@link getName()} instead.
|
||||
|
@ -25,9 +25,6 @@ class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface
|
||||
const FORMAT_KEY = 'datetime_format';
|
||||
const TIMEZONE_KEY = 'datetime_timezone';
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $format;
|
||||
private $timezone;
|
||||
|
||||
@ -127,8 +124,6 @@ class DateTimeNormalizer implements NormalizerInterface, DenormalizerInterface
|
||||
/**
|
||||
* Formats datetime errors.
|
||||
*
|
||||
* @param array $errors
|
||||
*
|
||||
* @return string[]
|
||||
*/
|
||||
private function formatDateTimeErrors(array $errors)
|
||||
|
@ -76,8 +76,6 @@ class GetSetMethodNormalizer extends AbstractObjectNormalizer
|
||||
/**
|
||||
* Checks if a method's name is get.* or is.*, and can be called without parameters.
|
||||
*
|
||||
* @param \ReflectionMethod $method the method to check
|
||||
*
|
||||
* @return bool whether the method is a getter or boolean getter
|
||||
*/
|
||||
private function isGetMethod(\ReflectionMethod $method)
|
||||
|
@ -25,7 +25,7 @@ class FilesystemLoader extends Loader
|
||||
protected $templatePathPatterns;
|
||||
|
||||
/**
|
||||
* @param array $templatePathPatterns An array of path patterns to look for templates
|
||||
* @param string|string[] $templatePathPatterns An array of path patterns to look for templates
|
||||
*/
|
||||
public function __construct($templatePathPatterns)
|
||||
{
|
||||
|
@ -31,7 +31,7 @@ class TranslationWriterTest extends TestCase
|
||||
|
||||
$writer = new TranslationWriter();
|
||||
$writer->addDumper('test', $dumper);
|
||||
$writer->writeTranslations(new MessageCatalogue(array()), 'test');
|
||||
$writer->writeTranslations(new MessageCatalogue('en'), 'test');
|
||||
}
|
||||
|
||||
public function testWrite()
|
||||
|
@ -21,9 +21,6 @@ use Symfony\Component\Validator\Mapping\ClassMetadata;
|
||||
*/
|
||||
class Psr6Cache implements CacheInterface
|
||||
{
|
||||
/**
|
||||
* @var CacheItemPoolInterface
|
||||
*/
|
||||
private $cacheItemPool;
|
||||
|
||||
public function __construct(CacheItemPoolInterface $cacheItemPool)
|
||||
|
@ -18,9 +18,6 @@ use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
|
||||
class FileTest extends TestCase
|
||||
{
|
||||
/**
|
||||
* @param mixed $maxSize
|
||||
* @param int $bytes
|
||||
* @param bool $binaryFormat
|
||||
* @dataProvider provideValidSizes
|
||||
*/
|
||||
public function testMaxSize($maxSize, $bytes, $binaryFormat)
|
||||
@ -33,10 +30,6 @@ class FileTest extends TestCase
|
||||
|
||||
/**
|
||||
* @dataProvider provideValidSizes
|
||||
*
|
||||
* @param int|string $maxSize
|
||||
* @param int $bytes
|
||||
* @param string $binaryFormat
|
||||
*/
|
||||
public function testMaxSizeCanBeSetAfterInitialization($maxSize, $bytes, $binaryFormat)
|
||||
{
|
||||
@ -50,8 +43,6 @@ class FileTest extends TestCase
|
||||
/**
|
||||
* @dataProvider provideInvalidSizes
|
||||
* @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
|
||||
*
|
||||
* @param int|string $maxSize
|
||||
*/
|
||||
public function testInvalidValueForMaxSizeThrowsExceptionAfterInitialization($maxSize)
|
||||
{
|
||||
@ -61,8 +52,6 @@ class FileTest extends TestCase
|
||||
|
||||
/**
|
||||
* @dataProvider provideInvalidSizes
|
||||
*
|
||||
* @param int|string $maxSize
|
||||
*/
|
||||
public function testMaxSizeCannotBeSetToInvalidValueAfterInitialization($maxSize)
|
||||
{
|
||||
@ -77,7 +66,6 @@ class FileTest extends TestCase
|
||||
}
|
||||
|
||||
/**
|
||||
* @param mixed $maxSize
|
||||
* @dataProvider provideInValidSizes
|
||||
* @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
|
||||
*/
|
||||
@ -86,9 +74,6 @@ class FileTest extends TestCase
|
||||
new File(array('maxSize' => $maxSize));
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function provideValidSizes()
|
||||
{
|
||||
return array(
|
||||
@ -105,9 +90,6 @@ class FileTest extends TestCase
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function provideInvalidSizes()
|
||||
{
|
||||
return array(
|
||||
@ -121,9 +103,6 @@ class FileTest extends TestCase
|
||||
}
|
||||
|
||||
/**
|
||||
* @param mixed $maxSize
|
||||
* @param bool $guessedFormat
|
||||
* @param bool $binaryFormat
|
||||
* @dataProvider provideFormats
|
||||
*/
|
||||
public function testBinaryFormat($maxSize, $guessedFormat, $binaryFormat)
|
||||
@ -133,9 +112,6 @@ class FileTest extends TestCase
|
||||
$this->assertSame($binaryFormat, $file->binaryFormat);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return array
|
||||
*/
|
||||
public function provideFormats()
|
||||
{
|
||||
return array(
|
||||
|
@ -26,7 +26,7 @@ class Data implements \ArrayAccess, \Countable, \IteratorAggregate
|
||||
private $useRefHandles = -1;
|
||||
|
||||
/**
|
||||
* @param array $data A array as returned by ClonerInterface::cloneVar()
|
||||
* @param array $data An array as returned by ClonerInterface::cloneVar()
|
||||
*/
|
||||
public function __construct(array $data)
|
||||
{
|
||||
@ -34,7 +34,7 @@ class Data implements \ArrayAccess, \Countable, \IteratorAggregate
|
||||
}
|
||||
|
||||
/**
|
||||
* @return string the type of the value
|
||||
* @return string The type of the value
|
||||
*/
|
||||
public function getType()
|
||||
{
|
||||
@ -61,9 +61,9 @@ class Data implements \ArrayAccess, \Countable, \IteratorAggregate
|
||||
}
|
||||
|
||||
/**
|
||||
* @param bool $recursive whether values should be resolved recursively or not
|
||||
* @param bool $recursive Whether values should be resolved recursively or not
|
||||
*
|
||||
* @return scalar|array|null|Data[] a native representation of the original value
|
||||
* @return scalar|array|null|Data[] A native representation of the original value
|
||||
*/
|
||||
public function getValue($recursive = false)
|
||||
{
|
||||
|
Reference in New Issue
Block a user