[CS] Enforces null type hint on last position in phpDocs

carusogabriel · carusogabriel · commit 24fb2411c910 · 2018-10-02T00:12:00.000-03:00
diff --git a/Button.php b/Button.php
@@ -368,7 +368,7 @@ public function handleRequest($request = null)
     /**
      * Submits data to the button.
      *
-     * @param null|string $submittedData The data
+     * @param string|null $submittedData The data
      * @param bool        $clearMissing  Not used
      *
      * @return $this
diff --git a/ChoiceList/Factory/ChoiceListFactoryInterface.php b/ChoiceList/Factory/ChoiceListFactoryInterface.php
@@ -32,7 +32,7 @@ interface ChoiceListFactoryInterface
      * argument.
      *
      * @param iterable      $choices The choices
-     * @param null|callable $value   The callable generating the choice
+     * @param callable|null $value   The callable generating the choice
      *                               values
      *
      * @return ChoiceListInterface The choice list
@@ -51,7 +51,7 @@ public function createListFromChoices($choices, $value = null);
      * argument.
      *
      * @param array|\Traversable $choices The choices
-     * @param null|callable      $value   The callable generating the choice
+     * @param callable|null      $value   The callable generating the choice
      *                                    values
      *
      * @return ChoiceListInterface The choice list
@@ -69,7 +69,7 @@ public function createListFromFlippedChoices($choices, $value = null);
      * argument.
      *
      * @param ChoiceLoaderInterface $loader The choice loader
-     * @param null|callable         $value  The callable generating the choice
+     * @param callable|null         $value  The callable generating the choice
      *                                      values
      *
      * @return ChoiceListInterface The choice list
@@ -103,14 +103,14 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, $value = nul
      * attributes that should be added to the respective choice.
      *
      * @param ChoiceListInterface $list             The choice list
-     * @param null|array|callable $preferredChoices The preferred choices
-     * @param null|callable       $label            The callable generating the
+     * @param array|callable|null $preferredChoices The preferred choices
+     * @param callable|null       $label            The callable generating the
      *                                              choice labels
-     * @param null|callable       $index            The callable generating the
+     * @param callable|null       $index            The callable generating the
      *                                              view indices
-     * @param null|callable       $groupBy          The callable generating the
+     * @param callable|null       $groupBy          The callable generating the
      *                                              group names
-     * @param null|array|callable $attr             The callable generating the
+     * @param array|callable|null $attr             The callable generating the
      *                                              HTML attributes
      *
      * @return ChoiceListView The choice list view
diff --git a/ChoiceList/Factory/PropertyAccessDecorator.php b/ChoiceList/Factory/PropertyAccessDecorator.php
@@ -60,7 +60,7 @@ public function getDecoratedFactory()
      * {@inheritdoc}
      *
      * @param iterable                          $choices The choices
-     * @param null|callable|string|PropertyPath $value   The callable or path for
+     * @param callable|string|PropertyPath|null $value   The callable or path for
      *                                                   generating the choice values
      *
      * @return ChoiceListInterface The choice list
@@ -91,7 +91,7 @@ public function createListFromChoices($choices, $value = null)
      * {@inheritdoc}
      *
      * @param array|\Traversable                $choices The choices
-     * @param null|callable|string|PropertyPath $value   The callable or path for
+     * @param callable|string|PropertyPath|null $value   The callable or path for
      *                                                   generating the choice values
      *
      * @return ChoiceListInterface The choice list
@@ -110,7 +110,7 @@ public function createListFromFlippedChoices($choices, $value = null, $triggerDe
      * {@inheritdoc}
      *
      * @param ChoiceLoaderInterface             $loader The choice loader
-     * @param null|callable|string|PropertyPath $value  The callable or path for
+     * @param callable|string|PropertyPath|null $value  The callable or path for
      *                                                  generating the choice values
      *
      * @return ChoiceListInterface The choice list
@@ -141,11 +141,11 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, $value = nul
      * {@inheritdoc}
      *
      * @param ChoiceListInterface                     $list             The choice list
-     * @param null|array|callable|string|PropertyPath $preferredChoices The preferred choices
-     * @param null|callable|string|PropertyPath       $label            The callable or path generating the choice labels
-     * @param null|callable|string|PropertyPath       $index            The callable or path generating the view indices
-     * @param null|callable|string|PropertyPath       $groupBy          The callable or path generating the group names
-     * @param null|array|callable|string|PropertyPath $attr             The callable or path generating the HTML attributes
+     * @param array|callable|string|PropertyPath|null $preferredChoices The preferred choices
+     * @param callable|string|PropertyPath|null       $label            The callable or path generating the choice labels
+     * @param callable|string|PropertyPath|null       $index            The callable or path generating the view indices
+     * @param callable|string|PropertyPath|null       $groupBy          The callable or path generating the group names
+     * @param array|callable|string|PropertyPath|null $attr             The callable or path generating the HTML attributes
      *
      * @return ChoiceListView The choice list view
      */
diff --git a/ChoiceList/LazyChoiceList.php b/ChoiceList/LazyChoiceList.php
@@ -34,7 +34,7 @@ class LazyChoiceList implements ChoiceListInterface
      *
      * If null, choices are simply cast to strings.
      *
-     * @var null|callable
+     * @var callable|null
      */
     private $value;
 
@@ -51,7 +51,7 @@ class LazyChoiceList implements ChoiceListInterface
      * argument.
      *
      * @param ChoiceLoaderInterface $loader The choice loader
-     * @param null|callable         $value  The callable generating the choice values
+     * @param callable|null         $value  The callable generating the choice values
      */
     public function __construct(ChoiceLoaderInterface $loader, $value = null)
     {
diff --git a/ChoiceList/Loader/ChoiceLoaderInterface.php b/ChoiceList/Loader/ChoiceLoaderInterface.php
@@ -31,7 +31,7 @@ interface ChoiceLoaderInterface
      * The callable receives the choice as first and the array key as the second
      * argument.
      *
-     * @param null|callable $value The callable which generates the values
+     * @param callable|null $value The callable which generates the values
      *                             from choices
      *
      * @return ChoiceListInterface The loaded choice list
@@ -50,7 +50,7 @@ public function loadChoiceList($value = null);
      *
      * @param string[]      $values An array of choice values. Non-existing
      *                              values in this array are ignored
-     * @param null|callable $value  The callable generating the choice values
+     * @param callable|null $value  The callable generating the choice values
      *
      * @return array An array of choices
      */
@@ -68,7 +68,7 @@ public function loadChoicesForValues(array $values, $value = null);
      *
      * @param array         $choices An array of choices. Non-existing choices in
      *                               this array are ignored
-     * @param null|callable $value   The callable generating the choice values
+     * @param callable|null $value   The callable generating the choice values
      *
      * @return string[] An array of choice values
      */
diff --git a/Extension/Csrf/CsrfExtension.php b/Extension/Csrf/CsrfExtension.php
@@ -32,7 +32,7 @@ class CsrfExtension extends AbstractExtension
     /**
      * @param CsrfTokenManagerInterface $tokenManager      The CSRF token manager
      * @param TranslatorInterface       $translator        The translator for translating error messages
-     * @param null|string               $translationDomain The translation domain for translating
+     * @param string|null               $translationDomain The translation domain for translating
      */
     public function __construct($tokenManager, TranslatorInterface $translator = null, $translationDomain = null)
     {
diff --git a/Extension/Csrf/EventListener/CsrfValidationListener.php b/Extension/Csrf/EventListener/CsrfValidationListener.php
@@ -51,7 +51,7 @@ public static function getSubscribedEvents()
      *                                                     same session and with the same tokenId
      * @param string                    $errorMessage      The message displayed in case of an error
      * @param TranslatorInterface       $translator
-     * @param null|string               $translationDomain
+     * @param string|null               $translationDomain
      * @param ServerParams              $serverParams
      */
     public function __construct($fieldName, $tokenManager, $tokenId, $errorMessage, TranslatorInterface $translator = null, $translationDomain = null, ServerParams $serverParams = null)
diff --git a/Extension/Csrf/Type/FormTypeCsrfExtension.php b/Extension/Csrf/Type/FormTypeCsrfExtension.php
@@ -47,7 +47,7 @@ class FormTypeCsrfExtension extends AbstractTypeExtension
      * @param bool                                            $defaultEnabled
      * @param string                                          $defaultFieldName
      * @param TranslatorInterface                             $translator
-     * @param null|string                                     $translationDomain
+     * @param string|null                                     $translationDomain
      * @param ServerParams                                    $serverParams
      */
     public function __construct($defaultTokenManager, $defaultEnabled = true, $defaultFieldName = '_token', TranslatorInterface $translator = null, $translationDomain = null, ServerParams $serverParams = null)
diff --git a/Extension/Validator/Type/UploadValidatorExtension.php b/Extension/Validator/Type/UploadValidatorExtension.php
@@ -27,7 +27,7 @@ class UploadValidatorExtension extends AbstractTypeExtension
 
     /**
      * @param TranslatorInterface $translator        The translator for translating error messages
-     * @param null|string         $translationDomain The translation domain for translating
+     * @param string|null         $translationDomain The translation domain for translating
      */
     public function __construct(TranslatorInterface $translator, $translationDomain = null)
     {
diff --git a/Extension/Validator/ViolationMapper/MappingRule.php b/Extension/Validator/ViolationMapper/MappingRule.php
@@ -51,7 +51,7 @@ public function getOrigin()
      *
      * @param string $propertyPath The property path to match against the rule
      *
-     * @return null|FormInterface The mapped form or null
+     * @return FormInterface|null The mapped form or null
      */
     public function match($propertyPath)
     {
diff --git a/Extension/Validator/ViolationMapper/ViolationMapper.php b/Extension/Validator/ViolationMapper/ViolationMapper.php
@@ -144,7 +144,7 @@ public function mapViolation(ConstraintViolation $violation, FormInterface $form
      * @param FormInterface                 $form The form to search
      * @param PropertyPathIteratorInterface $it   The iterator at its current position
      *
-     * @return null|FormInterface The found match or null
+     * @return FormInterface|null The found match or null
      */
     private function matchChild(FormInterface $form, PropertyPathIteratorInterface $it)
     {
diff --git a/FormConfigBuilderInterface.php b/FormConfigBuilderInterface.php
@@ -146,7 +146,7 @@ public function setRequired($required);
     /**
      * Sets the property path that the form should be mapped to.
      *
-     * @param null|string|PropertyPathInterface $propertyPath The property path or null if the path should be set
+     * @param string|PropertyPathInterface|null $propertyPath The property path or null if the path should be set
      *                                                        automatically based on the form's name
      *
      * @return $this The configuration object
diff --git a/FormConfigInterface.php b/FormConfigInterface.php
@@ -38,7 +38,7 @@ public function getName();
     /**
      * Returns the property path that the form should be mapped to.
      *
-     * @return null|PropertyPathInterface The property path
+     * @return PropertyPathInterface|null The property path
      */
     public function getPropertyPath();
 
@@ -167,7 +167,7 @@ public function getData();
     /**
      * Returns the class of the form data or null if the data is scalar or an array.
      *
-     * @return null|string The data class or null
+     * @return string|null The data class or null
      */
     public function getDataClass();
 
diff --git a/FormTypeInterface.php b/FormTypeInterface.php
@@ -90,7 +90,7 @@ public function setDefaultOptions(OptionsResolverInterface $resolver);
      * Symfony 2.8 and will be unsupported as of Symfony 3.0. Return the
      * fully-qualified class name of the parent type instead.
      *
-     * @return string|null|FormTypeInterface The name of the parent type if any, null otherwise
+     * @return string|FormTypeInterface|null The name of the parent type if any, null otherwise
      */
     public function getParent();
 
diff --git a/SubmitButton.php b/SubmitButton.php
@@ -34,7 +34,7 @@ public function isClicked()
     /**
      * Submits data to the button.
      *
-     * @param null|string $submittedData The data
+     * @param string|null $submittedData The data
      * @param bool        $clearMissing  Not used
      *
      * @return $this
diff --git a/Util/ServerParams.php b/Util/ServerParams.php
@@ -41,7 +41,7 @@ public function hasPostMaxSizeBeenExceeded()
     /**
      * Returns maximum post size in bytes.
      *
-     * @return null|int The maximum post size in bytes
+     * @return int|null The maximum post size in bytes
      */
     public function getPostMaxSize()
     {

Original file line number	Diff line number	Diff line change
`@@ -368,7 +368,7 @@ public function handleRequest($request = null)`
`368`	`368`	`/**`
`369`	`369`	`* Submits data to the button.`
`370`	`370`	`*`
`371`		`- * @param null\|string $submittedData The data`
	`371`	`+ * @param string\|null $submittedData The data`
`372`	`372`	`* @param bool $clearMissing Not used`
`373`	`373`	`*`
`374`	`374`	`* @return $this`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ interface ChoiceListFactoryInterface`
`32`	`32`	`* argument.`
`33`	`33`	`*`
`34`	`34`	`* @param iterable $choices The choices`
`35`		`- * @param null\|callable $value The callable generating the choice`
	`35`	`+ * @param callable\|null $value The callable generating the choice`
`36`	`36`	`* values`
`37`	`37`	`*`
`38`	`38`	`* @return ChoiceListInterface The choice list`
`@@ -51,7 +51,7 @@ public function createListFromChoices($choices, $value = null);`
`51`	`51`	`* argument.`
`52`	`52`	`*`
`53`	`53`	`* @param array\|\Traversable $choices The choices`
`54`		`- * @param null\|callable $value The callable generating the choice`
	`54`	`+ * @param callable\|null $value The callable generating the choice`
`55`	`55`	`* values`
`56`	`56`	`*`
`57`	`57`	`* @return ChoiceListInterface The choice list`
`@@ -69,7 +69,7 @@ public function createListFromFlippedChoices($choices, $value = null);`
`69`	`69`	`* argument.`
`70`	`70`	`*`
`71`	`71`	`* @param ChoiceLoaderInterface $loader The choice loader`
`72`		`- * @param null\|callable $value The callable generating the choice`
	`72`	`+ * @param callable\|null $value The callable generating the choice`
`73`	`73`	`* values`
`74`	`74`	`*`
`75`	`75`	`* @return ChoiceListInterface The choice list`
`@@ -103,14 +103,14 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, $value = nul`
`103`	`103`	`* attributes that should be added to the respective choice.`
`104`	`104`	`*`
`105`	`105`	`* @param ChoiceListInterface $list The choice list`
`106`		`- * @param null\|array\|callable $preferredChoices The preferred choices`
`107`		`- * @param null\|callable $label The callable generating the`
	`106`	`+ * @param array\|callable\|null $preferredChoices The preferred choices`
	`107`	`+ * @param callable\|null $label The callable generating the`
`108`	`108`	`* choice labels`
`109`		`- * @param null\|callable $index The callable generating the`
	`109`	`+ * @param callable\|null $index The callable generating the`
`110`	`110`	`* view indices`
`111`		`- * @param null\|callable $groupBy The callable generating the`
	`111`	`+ * @param callable\|null $groupBy The callable generating the`
`112`	`112`	`* group names`
`113`		`- * @param null\|array\|callable $attr The callable generating the`
	`113`	`+ * @param array\|callable\|null $attr The callable generating the`
`114`	`114`	`* HTML attributes`
`115`	`115`	`*`
`116`	`116`	`* @return ChoiceListView The choice list view`
Original file line number	Diff line number	Diff line change
`@@ -60,7 +60,7 @@ public function getDecoratedFactory()`
`60`	`60`	`* {@inheritdoc}`
`61`	`61`	`*`
`62`	`62`	`* @param iterable $choices The choices`
`63`		`- * @param null\|callable\|string\|PropertyPath $value The callable or path for`
	`63`	`+ * @param callable\|string\|PropertyPath\|null $value The callable or path for`
`64`	`64`	`* generating the choice values`
`65`	`65`	`*`
`66`	`66`	`* @return ChoiceListInterface The choice list`
`@@ -91,7 +91,7 @@ public function createListFromChoices($choices, $value = null)`
`91`	`91`	`* {@inheritdoc}`
`92`	`92`	`*`
`93`	`93`	`* @param array\|\Traversable $choices The choices`
`94`		`- * @param null\|callable\|string\|PropertyPath $value The callable or path for`
	`94`	`+ * @param callable\|string\|PropertyPath\|null $value The callable or path for`
`95`	`95`	`* generating the choice values`
`96`	`96`	`*`
`97`	`97`	`* @return ChoiceListInterface The choice list`
`@@ -110,7 +110,7 @@ public function createListFromFlippedChoices($choices, $value = null, $triggerDe`
`110`	`110`	`* {@inheritdoc}`
`111`	`111`	`*`
`112`	`112`	`* @param ChoiceLoaderInterface $loader The choice loader`
`113`		`- * @param null\|callable\|string\|PropertyPath $value The callable or path for`
	`113`	`+ * @param callable\|string\|PropertyPath\|null $value The callable or path for`
`114`	`114`	`* generating the choice values`
`115`	`115`	`*`
`116`	`116`	`* @return ChoiceListInterface The choice list`
`@@ -141,11 +141,11 @@ public function createListFromLoader(ChoiceLoaderInterface $loader, $value = nul`
`141`	`141`	`* {@inheritdoc}`
`142`	`142`	`*`
`143`	`143`	`* @param ChoiceListInterface $list The choice list`
`144`		`- * @param null\|array\|callable\|string\|PropertyPath $preferredChoices The preferred choices`
`145`		`- * @param null\|callable\|string\|PropertyPath $label The callable or path generating the choice labels`
`146`		`- * @param null\|callable\|string\|PropertyPath $index The callable or path generating the view indices`
`147`		`- * @param null\|callable\|string\|PropertyPath $groupBy The callable or path generating the group names`
`148`		`- * @param null\|array\|callable\|string\|PropertyPath $attr The callable or path generating the HTML attributes`
	`144`	`+ * @param array\|callable\|string\|PropertyPath\|null $preferredChoices The preferred choices`
	`145`	`+ * @param callable\|string\|PropertyPath\|null $label The callable or path generating the choice labels`
	`146`	`+ * @param callable\|string\|PropertyPath\|null $index The callable or path generating the view indices`
	`147`	`+ * @param callable\|string\|PropertyPath\|null $groupBy The callable or path generating the group names`
	`148`	`+ * @param array\|callable\|string\|PropertyPath\|null $attr The callable or path generating the HTML attributes`
`149`	`149`	`*`
`150`	`150`	`* @return ChoiceListView The choice list view`
`151`	`151`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ class LazyChoiceList implements ChoiceListInterface`
`34`	`34`	`*`
`35`	`35`	`* If null, choices are simply cast to strings.`
`36`	`36`	`*`
`37`		`- * @var null\|callable`
	`37`	`+ * @var callable\|null`
`38`	`38`	`*/`
`39`	`39`	`private $value;`
`40`	`40`
`@@ -51,7 +51,7 @@ class LazyChoiceList implements ChoiceListInterface`
`51`	`51`	`* argument.`
`52`	`52`	`*`
`53`	`53`	`* @param ChoiceLoaderInterface $loader The choice loader`
`54`		`- * @param null\|callable $value The callable generating the choice values`
	`54`	`+ * @param callable\|null $value The callable generating the choice values`
`55`	`55`	`*/`
`56`	`56`	`public function __construct(ChoiceLoaderInterface $loader, $value = null)`
`57`	`57`	`{`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ interface ChoiceLoaderInterface`
`31`	`31`	`* The callable receives the choice as first and the array key as the second`
`32`	`32`	`* argument.`
`33`	`33`	`*`
`34`		`- * @param null\|callable $value The callable which generates the values`
	`34`	`+ * @param callable\|null $value The callable which generates the values`
`35`	`35`	`* from choices`
`36`	`36`	`*`
`37`	`37`	`* @return ChoiceListInterface The loaded choice list`
`@@ -50,7 +50,7 @@ public function loadChoiceList($value = null);`
`50`	`50`	`*`
`51`	`51`	`* @param string[] $values An array of choice values. Non-existing`
`52`	`52`	`* values in this array are ignored`
`53`		`- * @param null\|callable $value The callable generating the choice values`
	`53`	`+ * @param callable\|null $value The callable generating the choice values`
`54`	`54`	`*`
`55`	`55`	`* @return array An array of choices`
`56`	`56`	`*/`
`@@ -68,7 +68,7 @@ public function loadChoicesForValues(array $values, $value = null);`
`68`	`68`	`*`
`69`	`69`	`* @param array $choices An array of choices. Non-existing choices in`
`70`	`70`	`* this array are ignored`
`71`		`- * @param null\|callable $value The callable generating the choice values`
	`71`	`+ * @param callable\|null $value The callable generating the choice values`
`72`	`72`	`*`
`73`	`73`	`* @return string[] An array of choice values`
`74`	`74`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ class CsrfExtension extends AbstractExtension`
`32`	`32`	`/**`
`33`	`33`	`* @param CsrfTokenManagerInterface $tokenManager The CSRF token manager`
`34`	`34`	`* @param TranslatorInterface $translator The translator for translating error messages`
`35`		`- * @param null\|string $translationDomain The translation domain for translating`
	`35`	`+ * @param string\|null $translationDomain The translation domain for translating`
`36`	`36`	`*/`
`37`	`37`	`public function __construct($tokenManager, TranslatorInterface $translator = null, $translationDomain = null)`
`38`	`38`	`{`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ class UploadValidatorExtension extends AbstractTypeExtension`
`27`	`27`
`28`	`28`	`/**`
`29`	`29`	`* @param TranslatorInterface $translator The translator for translating error messages`
`30`		`- * @param null\|string $translationDomain The translation domain for translating`
	`30`	`+ * @param string\|null $translationDomain The translation domain for translating`
`31`	`31`	`*/`
`32`	`32`	`public function __construct(TranslatorInterface $translator, $translationDomain = null)`
`33`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -51,7 +51,7 @@ public function getOrigin()`
`51`	`51`	`*`
`52`	`52`	`* @param string $propertyPath The property path to match against the rule`
`53`	`53`	`*`
`54`		`- * @return null\|FormInterface The mapped form or null`
	`54`	`+ * @return FormInterface\|null The mapped form or null`
`55`	`55`	`*/`
`56`	`56`	`public function match($propertyPath)`
`57`	`57`	`{`
Original file line number	Diff line number	Diff line change
`@@ -144,7 +144,7 @@ public function mapViolation(ConstraintViolation $violation, FormInterface $form`
`144`	`144`	`* @param FormInterface $form The form to search`
`145`	`145`	`* @param PropertyPathIteratorInterface $it The iterator at its current position`
`146`	`146`	`*`
`147`		`- * @return null\|FormInterface The found match or null`
	`147`	`+ * @return FormInterface\|null The found match or null`
`148`	`148`	`*/`
`149`	`149`	`private function matchChild(FormInterface $form, PropertyPathIteratorInterface $it)`
`150`	`150`	`{`
Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,7 @@ public function setRequired($required);`
`146`	`146`	`/**`
`147`	`147`	`* Sets the property path that the form should be mapped to.`
`148`	`148`	`*`
`149`		`- * @param null\|string\|PropertyPathInterface $propertyPath The property path or null if the path should be set`
	`149`	`+ * @param string\|PropertyPathInterface\|null $propertyPath The property path or null if the path should be set`
`150`	`150`	`* automatically based on the form's name`
`151`	`151`	`*`
`152`	`152`	`* @return $this The configuration object`