minor #23505 [Cache] add constructor docblocks for clarity (xabbuh)

fabpot · fabpot · commit 80efd8f950e9 · 2017-07-17T14:07:22.000+02:00
This PR was merged into the 3.3 branch. Discussion ---------- [Cache] add constructor docblocks for clarity | Q | A | ------------- | --- | Branch? | 3.3 | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #23503 | License | MIT | Doc PR | Commits ------- d1ce532 [Cache] add constructor docblocks for clarity
diff --git a/src/Symfony/Component/Cache/Simple/AbstractCache.php b/src/Symfony/Component/Cache/Simple/AbstractCache.php
@@ -30,6 +30,10 @@ abstract class AbstractCache implements CacheInterface, LoggerAwareInterface
 
     private $defaultLifetime;
 
+    /**
+     * @param string $namespace
+     * @param int    $defaultLifetime
+     */
     protected function __construct($namespace = '', $defaultLifetime = 0)
     {
         $this->defaultLifetime = max(0, (int) $defaultLifetime);
diff --git a/src/Symfony/Component/Cache/Simple/ApcuCache.php b/src/Symfony/Component/Cache/Simple/ApcuCache.php
@@ -17,6 +17,11 @@ class ApcuCache extends AbstractCache
 {
     use ApcuTrait;
 
+    /**
+     * @param string      $namespace
+     * @param int         $defaultLifetime
+     * @param string|null $version
+     */
     public function __construct($namespace = '', $defaultLifetime = 0, $version = null)
     {
         $this->init($namespace, $defaultLifetime, $version);
diff --git a/src/Symfony/Component/Cache/Simple/DoctrineCache.php b/src/Symfony/Component/Cache/Simple/DoctrineCache.php
@@ -18,6 +18,11 @@ class DoctrineCache extends AbstractCache
 {
     use DoctrineTrait;
 
+    /**
+     * @param CacheProvider $provider
+     * @param string        $namespace
+     * @param int           $defaultLifetime
+     */
     public function __construct(CacheProvider $provider, $namespace = '', $defaultLifetime = 0)
     {
         parent::__construct('', $defaultLifetime);
diff --git a/src/Symfony/Component/Cache/Simple/FilesystemCache.php b/src/Symfony/Component/Cache/Simple/FilesystemCache.php
@@ -17,6 +17,11 @@ class FilesystemCache extends AbstractCache
 {
     use FilesystemTrait;
 
+    /**
+     * @param string      $namespace
+     * @param int         $defaultLifetime
+     * @param string|null $directory
+     */
     public function __construct($namespace = '', $defaultLifetime = 0, $directory = null)
     {
         parent::__construct('', $defaultLifetime);
diff --git a/src/Symfony/Component/Cache/Simple/MemcachedCache.php b/src/Symfony/Component/Cache/Simple/MemcachedCache.php
@@ -19,6 +19,11 @@ class MemcachedCache extends AbstractCache
 
     protected $maxIdLength = 250;
 
+    /**
+     * @param \Memcached $client
+     * @param string     $namespace
+     * @param int        $defaultLifetime
+     */
     public function __construct(\Memcached $client, $namespace = '', $defaultLifetime = 0)
     {
         $this->init($client, $namespace, $defaultLifetime);
diff --git a/src/Symfony/Component/Cache/Simple/PhpFilesCache.php b/src/Symfony/Component/Cache/Simple/PhpFilesCache.php
@@ -18,6 +18,13 @@ class PhpFilesCache extends AbstractCache
 {
     use PhpFilesTrait;
 
+    /**
+     * @param string      $namespace
+     * @param int         $defaultLifetime
+     * @param string|null $directory
+     *
+     * @throws CacheException if OPcache is not enabled
+     */
     public function __construct($namespace = '', $defaultLifetime = 0, $directory = null)
     {
         if (!static::isSupported()) {
diff --git a/src/Symfony/Component/Cache/Simple/RedisCache.php b/src/Symfony/Component/Cache/Simple/RedisCache.php
@@ -19,6 +19,8 @@ class RedisCache extends AbstractCache
 
     /**
      * @param \Redis|\RedisArray|\RedisCluster|\Predis\Client $redisClient
+     * @param string                                          $namespace
+     * @param int                                             $defaultLifetime
      */
     public function __construct($redisClient, $namespace = '', $defaultLifetime = 0)
     {

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,10 @@ abstract class AbstractCache implements CacheInterface, LoggerAwareInterface`
`30`	`30`
`31`	`31`	`private $defaultLifetime;`
`32`	`32`
	`33`	`+ /**`
	`34`	`+ * @param string $namespace`
	`35`	`+ * @param int $defaultLifetime`
	`36`	`+ */`
`33`	`37`	`protected function __construct($namespace = '', $defaultLifetime = 0)`
`34`	`38`	`{`
`35`	`39`	`$this->defaultLifetime = max(0, (int) $defaultLifetime);`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,11 @@ class ApcuCache extends AbstractCache`
`17`	`17`	`{`
`18`	`18`	`use ApcuTrait;`
`19`	`19`
	`20`	`+ /**`
	`21`	`+ * @param string $namespace`
	`22`	`+ * @param int $defaultLifetime`
	`23`	`+ * @param string\|null $version`
	`24`	`+ */`
`20`	`25`	`public function __construct($namespace = '', $defaultLifetime = 0, $version = null)`
`21`	`26`	`{`
`22`	`27`	`$this->init($namespace, $defaultLifetime, $version);`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,11 @@ class DoctrineCache extends AbstractCache`
`18`	`18`	`{`
`19`	`19`	`use DoctrineTrait;`
`20`	`20`
	`21`	`+ /**`
	`22`	`+ * @param CacheProvider $provider`
	`23`	`+ * @param string $namespace`
	`24`	`+ * @param int $defaultLifetime`
	`25`	`+ */`
`21`	`26`	`public function __construct(CacheProvider $provider, $namespace = '', $defaultLifetime = 0)`
`22`	`27`	`{`
`23`	`28`	`parent::__construct('', $defaultLifetime);`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,11 @@ class FilesystemCache extends AbstractCache`
`17`	`17`	`{`
`18`	`18`	`use FilesystemTrait;`
`19`	`19`
	`20`	`+ /**`
	`21`	`+ * @param string $namespace`
	`22`	`+ * @param int $defaultLifetime`
	`23`	`+ * @param string\|null $directory`
	`24`	`+ */`
`20`	`25`	`public function __construct($namespace = '', $defaultLifetime = 0, $directory = null)`
`21`	`26`	`{`
`22`	`27`	`parent::__construct('', $defaultLifetime);`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,13 @@ class PhpFilesCache extends AbstractCache`
`18`	`18`	`{`
`19`	`19`	`use PhpFilesTrait;`
`20`	`20`
	`21`	`+ /**`
	`22`	`+ * @param string $namespace`
	`23`	`+ * @param int $defaultLifetime`
	`24`	`+ * @param string\|null $directory`
	`25`	`+ *`
	`26`	`+ * @throws CacheException if OPcache is not enabled`
	`27`	`+ */`
`21`	`28`	`public function __construct($namespace = '', $defaultLifetime = 0, $directory = null)`
`22`	`29`	`{`
`23`	`30`	`if (!static::isSupported()) {`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@ class RedisCache extends AbstractCache`
`19`	`19`
`20`	`20`	`/**`
`21`	`21`	`* @param \Redis\|\RedisArray\|\RedisCluster\|\Predis\Client $redisClient`
	`22`	`+ * @param string $namespace`
	`23`	`+ * @param int $defaultLifetime`
`22`	`24`	`*/`
`23`	`25`	`public function __construct($redisClient, $namespace = '', $defaultLifetime = 0)`
`24`	`26`	`{`