minor #28719 Correct PHPDoc type for float ttl (Soullivaneuh)

fabpot · fabpot · commit 63d287b70c27 · 2018-10-06T18:30:02.000+02:00
This PR was merged into the 3.4 branch. Discussion ---------- Correct PHPDoc type for float ttl | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | N/A | License | MIT | Doc PR | N/A It can be null as the Lock instance accepts it. It will fix that kind of PHPStan issue: ``` src/AppBundle/Command/AbstractCommand.php:45:Parameter #2 $ttl of method Symfony\Component\Lock\Factory::createLock() expects float, null given. ``` Commits ------- b662e7e Correct PHPDoc type for float ttl
diff --git a/src/Symfony/Component/Lock/Factory.php b/src/Symfony/Component/Lock/Factory.php
@@ -36,9 +36,9 @@ public function __construct(StoreInterface $store)
     /**
      * Creates a lock for the given resource.
      *
-     * @param string $resource    The resource to lock
-     * @param float  $ttl         Maximum expected lock duration in seconds
-     * @param bool   $autoRelease Whether to automatically release the lock or not when the lock instance is destroyed
+     * @param string     $resource    The resource to lock
+     * @param float|null $ttl         Maximum expected lock duration in seconds
+     * @param bool       $autoRelease Whether to automatically release the lock or not when the lock instance is destroyed
      *
      * @return Lock
      */

Original file line number	Diff line number	Diff line change
`@@ -36,9 +36,9 @@ public function __construct(StoreInterface $store)`
`36`	`36`	`/**`
`37`	`37`	`* Creates a lock for the given resource.`
`38`	`38`	`*`
`39`		`- * @param string $resource The resource to lock`
`40`		`- * @param float $ttl Maximum expected lock duration in seconds`
`41`		`- * @param bool $autoRelease Whether to automatically release the lock or not when the lock instance is destroyed`
	`39`	`+ * @param string $resource The resource to lock`
	`40`	`+ * @param float\|null $ttl Maximum expected lock duration in seconds`
	`41`	`+ * @param bool $autoRelease Whether to automatically release the lock or not when the lock instance is destroyed`
`42`	`42`	`*`
`43`	`43`	`* @return Lock`
`44`	`44`	`*/`