minor #24857 [2.7] More docblock fixes (nicolas-grekas)
This PR was merged into the 2.7 branch.
Discussion
----------
[2.7] More docblock fixes
| Q | A
| ------------- | ---
| Branch? | 2.7
| Bug fix? | no
| New feature? | no
| BC breaks? | no
| Deprecations? | no
| Tests pass? | yes
| Fixed tickets | -
| License | MIT
| Doc PR | -
Commits
-------
ac671ac
[2.7] More docblock fixes
This commit is contained in:
commit
1e0f2267bb
@ -80,10 +80,6 @@ class Cookie
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Returns the HTTP representation of the Cookie.
|
* Returns the HTTP representation of the Cookie.
|
||||||
*
|
|
||||||
* @return string The HTTP representation of the Cookie
|
|
||||||
*
|
|
||||||
* @throws \UnexpectedValueException
|
|
||||||
*/
|
*/
|
||||||
public function __toString()
|
public function __toString()
|
||||||
{
|
{
|
||||||
|
@ -419,8 +419,6 @@ class Table
|
|||||||
/**
|
/**
|
||||||
* fill cells for a row that contains colspan > 1.
|
* fill cells for a row that contains colspan > 1.
|
||||||
*
|
*
|
||||||
* @param array|\Traversable $row
|
|
||||||
*
|
|
||||||
* @return array
|
* @return array
|
||||||
*/
|
*/
|
||||||
private function fillCells($row)
|
private function fillCells($row)
|
||||||
|
@ -54,8 +54,6 @@ class GraphvizDumper extends Dumper
|
|||||||
* * node.definition: The default options for services that are defined via service definition instances
|
* * node.definition: The default options for services that are defined via service definition instances
|
||||||
* * node.missing: The default options for missing services
|
* * node.missing: The default options for missing services
|
||||||
*
|
*
|
||||||
* @param array $options An array of options
|
|
||||||
*
|
|
||||||
* @return string The dot representation of the service container
|
* @return string The dot representation of the service container
|
||||||
*/
|
*/
|
||||||
public function dump(array $options = array())
|
public function dump(array $options = array())
|
||||||
|
@ -62,7 +62,7 @@ class PhpDumper extends Dumper
|
|||||||
private $expressionLanguageProviders = array();
|
private $expressionLanguageProviders = array();
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @var \Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface
|
* @var ProxyDumper
|
||||||
*/
|
*/
|
||||||
private $proxyDumper;
|
private $proxyDumper;
|
||||||
|
|
||||||
|
@ -36,11 +36,6 @@ class Variable
|
|||||||
$this->name = $name;
|
$this->name = $name;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* Converts the object to a string.
|
|
||||||
*
|
|
||||||
* @return string
|
|
||||||
*/
|
|
||||||
public function __toString()
|
public function __toString()
|
||||||
{
|
{
|
||||||
return $this->name;
|
return $this->name;
|
||||||
|
@ -838,9 +838,6 @@ class FilesystemTest extends FilesystemTestCase
|
|||||||
$this->assertEquals($expectedPath, $path);
|
$this->assertEquals($expectedPath, $path);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
public function providePathsForMakePathRelative()
|
public function providePathsForMakePathRelative()
|
||||||
{
|
{
|
||||||
$paths = array(
|
$paths = array(
|
||||||
@ -1078,9 +1075,6 @@ class FilesystemTest extends FilesystemTestCase
|
|||||||
$this->assertEquals($expectedResult, $result);
|
$this->assertEquals($expectedResult, $result);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
public function providePathsForIsAbsolutePath()
|
public function providePathsForIsAbsolutePath()
|
||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
|
@ -444,10 +444,6 @@ class ChoiceType extends AbstractType
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Adds the sub fields for an expanded choice field.
|
* Adds the sub fields for an expanded choice field.
|
||||||
*
|
|
||||||
* @param FormBuilderInterface $builder The form builder
|
|
||||||
* @param array $choiceViews The choice view objects
|
|
||||||
* @param array $options The build options
|
|
||||||
*/
|
*/
|
||||||
private function addSubForms(FormBuilderInterface $builder, array $choiceViews, array $options)
|
private function addSubForms(FormBuilderInterface $builder, array $choiceViews, array $options)
|
||||||
{
|
{
|
||||||
@ -468,11 +464,6 @@ class ChoiceType extends AbstractType
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param FormBuilderInterface $builder
|
|
||||||
* @param $name
|
|
||||||
* @param $choiceView
|
|
||||||
* @param array $options
|
|
||||||
*
|
|
||||||
* @return mixed
|
* @return mixed
|
||||||
*/
|
*/
|
||||||
private function addSubForm(FormBuilderInterface $builder, $name, ChoiceView $choiceView, array $options)
|
private function addSubForm(FormBuilderInterface $builder, $name, ChoiceView $choiceView, array $options)
|
||||||
|
@ -21,12 +21,6 @@ class FormEvent extends Event
|
|||||||
private $form;
|
private $form;
|
||||||
protected $data;
|
protected $data;
|
||||||
|
|
||||||
/**
|
|
||||||
* Constructs an event.
|
|
||||||
*
|
|
||||||
* @param FormInterface $form The associated form
|
|
||||||
* @param mixed $data The data
|
|
||||||
*/
|
|
||||||
public function __construct(FormInterface $form, $data)
|
public function __construct(FormInterface $form, $data)
|
||||||
{
|
{
|
||||||
$this->form = $form;
|
$this->form = $form;
|
||||||
|
@ -41,8 +41,6 @@ class PropertyPathMapperTest extends TestCase
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param $path
|
|
||||||
*
|
|
||||||
* @return \PHPUnit_Framework_MockObject_MockObject
|
* @return \PHPUnit_Framework_MockObject_MockObject
|
||||||
*/
|
*/
|
||||||
private function getPropertyPath($path)
|
private function getPropertyPath($path)
|
||||||
|
@ -19,8 +19,6 @@ use Symfony\Component\HttpKernel\Event\FilterControllerEvent;
|
|||||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* RequestDataCollector.
|
|
||||||
*
|
|
||||||
* @author Fabien Potencier <fabien@symfony.com>
|
* @author Fabien Potencier <fabien@symfony.com>
|
||||||
*/
|
*/
|
||||||
class RequestDataCollector extends DataCollector implements EventSubscriberInterface
|
class RequestDataCollector extends DataCollector implements EventSubscriberInterface
|
||||||
|
@ -27,9 +27,6 @@ use Symfony\Component\HttpFoundation\Request;
|
|||||||
*/
|
*/
|
||||||
class FilterControllerEvent extends KernelEvent
|
class FilterControllerEvent extends KernelEvent
|
||||||
{
|
{
|
||||||
/**
|
|
||||||
* The current controller.
|
|
||||||
*/
|
|
||||||
private $controller;
|
private $controller;
|
||||||
|
|
||||||
public function __construct(HttpKernelInterface $kernel, $controller, Request $request, $requestType)
|
public function __construct(HttpKernelInterface $kernel, $controller, Request $request, $requestType)
|
||||||
|
@ -67,11 +67,6 @@ class HttpCache implements HttpKernelInterface, TerminableInterface
|
|||||||
* the cache can serve a stale response when an error is encountered (default: 60).
|
* 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
|
* This setting is overridden by the stale-if-error HTTP Cache-Control extension
|
||||||
* (see RFC 5861).
|
* (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())
|
public function __construct(HttpKernelInterface $kernel, StoreInterface $store, SurrogateInterface $surrogate = null, array $options = array())
|
||||||
{
|
{
|
||||||
|
@ -96,8 +96,8 @@ class ExceptionListenerTest extends TestCase
|
|||||||
|
|
||||||
$request = new Request();
|
$request = new Request();
|
||||||
$exception = new \Exception('foo');
|
$exception = new \Exception('foo');
|
||||||
$event = new GetResponseForExceptionEvent(new TestKernel(), $request, 'foo', $exception);
|
$event = new GetResponseForExceptionEvent(new TestKernel(), $request, HttpKernelInterface::MASTER_REQUEST, $exception);
|
||||||
$event2 = new GetResponseForExceptionEvent(new TestKernelThatThrowsException(), $request, 'foo', $exception);
|
$event2 = new GetResponseForExceptionEvent(new TestKernelThatThrowsException(), $request, HttpKernelInterface::MASTER_REQUEST, $exception);
|
||||||
|
|
||||||
return array(
|
return array(
|
||||||
array($event, $event2),
|
array($event, $event2),
|
||||||
@ -116,7 +116,7 @@ class ExceptionListenerTest extends TestCase
|
|||||||
$request = Request::create('/');
|
$request = Request::create('/');
|
||||||
$request->setRequestFormat('xml');
|
$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);
|
$listener->onKernelException($event);
|
||||||
|
|
||||||
$response = $event->getResponse();
|
$response = $event->getResponse();
|
||||||
|
@ -18,7 +18,7 @@ class CompiledRouteTest extends TestCase
|
|||||||
{
|
{
|
||||||
public function testAccessors()
|
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('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('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');
|
$this->assertEquals(array('tokens'), $compiled->getTokens(), '__construct() takes an array of tokens as its fourth argument');
|
||||||
|
@ -41,12 +41,6 @@ class DefaultAuthenticationFailureHandler implements AuthenticationFailureHandle
|
|||||||
'failure_path_parameter' => '_failure_path',
|
'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)
|
public function __construct(HttpKernelInterface $httpKernel, HttpUtils $httpUtils, array $options = array(), LoggerInterface $logger = null)
|
||||||
{
|
{
|
||||||
$this->httpKernel = $httpKernel;
|
$this->httpKernel = $httpKernel;
|
||||||
|
@ -19,8 +19,6 @@ namespace Symfony\Component\Serializer\Mapping;
|
|||||||
class ClassMetadata implements ClassMetadataInterface
|
class ClassMetadata implements ClassMetadataInterface
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @var string
|
|
||||||
*
|
|
||||||
* @internal This property is public in order to reduce the size of the
|
* @internal This property is public in order to reduce the size of the
|
||||||
* class' serialized representation. Do not access it. Use
|
* class' serialized representation. Do not access it. Use
|
||||||
* {@link getName()} instead.
|
* {@link getName()} instead.
|
||||||
|
@ -162,8 +162,6 @@ class GetSetMethodNormalizer extends AbstractNormalizer
|
|||||||
/**
|
/**
|
||||||
* Checks if a method's name is get.* or is.*, and can be called without parameters.
|
* 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
|
* @return bool whether the method is a getter or boolean getter
|
||||||
*/
|
*/
|
||||||
private function isGetMethod(\ReflectionMethod $method)
|
private function isGetMethod(\ReflectionMethod $method)
|
||||||
|
@ -25,7 +25,7 @@ class FilesystemLoader extends Loader
|
|||||||
protected $templatePathPatterns;
|
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)
|
public function __construct($templatePathPatterns)
|
||||||
{
|
{
|
||||||
|
@ -27,7 +27,7 @@ class TranslationWriterTest extends TestCase
|
|||||||
|
|
||||||
$writer = new TranslationWriter();
|
$writer = new TranslationWriter();
|
||||||
$writer->addDumper('test', $dumper);
|
$writer->addDumper('test', $dumper);
|
||||||
$writer->writeTranslations(new MessageCatalogue(array()), 'test');
|
$writer->writeTranslations(new MessageCatalogue('en'), 'test');
|
||||||
}
|
}
|
||||||
|
|
||||||
public function testDisableBackup()
|
public function testDisableBackup()
|
||||||
|
@ -18,9 +18,6 @@ use Symfony\Component\Validator\Exception\ConstraintDefinitionException;
|
|||||||
class FileTest extends TestCase
|
class FileTest extends TestCase
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* @param mixed $maxSize
|
|
||||||
* @param int $bytes
|
|
||||||
* @param bool $binaryFormat
|
|
||||||
* @dataProvider provideValidSizes
|
* @dataProvider provideValidSizes
|
||||||
*/
|
*/
|
||||||
public function testMaxSize($maxSize, $bytes, $binaryFormat)
|
public function testMaxSize($maxSize, $bytes, $binaryFormat)
|
||||||
@ -33,10 +30,6 @@ class FileTest extends TestCase
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @dataProvider provideValidSizes
|
* @dataProvider provideValidSizes
|
||||||
*
|
|
||||||
* @param int|string $maxSize
|
|
||||||
* @param int $bytes
|
|
||||||
* @param string $binaryFormat
|
|
||||||
*/
|
*/
|
||||||
public function testMaxSizeCanBeSetAfterInitialization($maxSize, $bytes, $binaryFormat)
|
public function testMaxSizeCanBeSetAfterInitialization($maxSize, $bytes, $binaryFormat)
|
||||||
{
|
{
|
||||||
@ -50,8 +43,6 @@ class FileTest extends TestCase
|
|||||||
/**
|
/**
|
||||||
* @dataProvider provideInvalidSizes
|
* @dataProvider provideInvalidSizes
|
||||||
* @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
|
* @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
|
||||||
*
|
|
||||||
* @param int|string $maxSize
|
|
||||||
*/
|
*/
|
||||||
public function testInvalidValueForMaxSizeThrowsExceptionAfterInitialization($maxSize)
|
public function testInvalidValueForMaxSizeThrowsExceptionAfterInitialization($maxSize)
|
||||||
{
|
{
|
||||||
@ -61,8 +52,6 @@ class FileTest extends TestCase
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* @dataProvider provideInvalidSizes
|
* @dataProvider provideInvalidSizes
|
||||||
*
|
|
||||||
* @param int|string $maxSize
|
|
||||||
*/
|
*/
|
||||||
public function testMaxSizeCannotBeSetToInvalidValueAfterInitialization($maxSize)
|
public function testMaxSizeCannotBeSetToInvalidValueAfterInitialization($maxSize)
|
||||||
{
|
{
|
||||||
@ -77,7 +66,6 @@ class FileTest extends TestCase
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param mixed $maxSize
|
|
||||||
* @dataProvider provideInValidSizes
|
* @dataProvider provideInValidSizes
|
||||||
* @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
|
* @expectedException \Symfony\Component\Validator\Exception\ConstraintDefinitionException
|
||||||
*/
|
*/
|
||||||
@ -86,9 +74,6 @@ class FileTest extends TestCase
|
|||||||
$file = new File(array('maxSize' => $maxSize));
|
$file = new File(array('maxSize' => $maxSize));
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
public function provideValidSizes()
|
public function provideValidSizes()
|
||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
@ -105,9 +90,6 @@ class FileTest extends TestCase
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
public function provideInvalidSizes()
|
public function provideInvalidSizes()
|
||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
@ -121,9 +103,6 @@ class FileTest extends TestCase
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @param mixed $maxSize
|
|
||||||
* @param bool $guessedFormat
|
|
||||||
* @param bool $binaryFormat
|
|
||||||
* @dataProvider provideFormats
|
* @dataProvider provideFormats
|
||||||
*/
|
*/
|
||||||
public function testBinaryFormat($maxSize, $guessedFormat, $binaryFormat)
|
public function testBinaryFormat($maxSize, $guessedFormat, $binaryFormat)
|
||||||
@ -133,9 +112,6 @@ class FileTest extends TestCase
|
|||||||
$this->assertSame($binaryFormat, $file->binaryFormat);
|
$this->assertSame($binaryFormat, $file->binaryFormat);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
|
||||||
* @return array
|
|
||||||
*/
|
|
||||||
public function provideFormats()
|
public function provideFormats()
|
||||||
{
|
{
|
||||||
return array(
|
return array(
|
||||||
|
@ -22,7 +22,7 @@ class Data
|
|||||||
private $useRefHandles = -1;
|
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)
|
public function __construct(array $data)
|
||||||
{
|
{
|
||||||
|
Reference in New Issue
Block a user