Mention WANObjectCache::TTL_INDEFINITE in set() method
authorAaron Schulz <aschulz@wikimedia.org>
Thu, 15 Oct 2015 15:09:48 +0000 (08:09 -0700)
committerAaron Schulz <aschulz@wikimedia.org>
Thu, 15 Oct 2015 15:09:48 +0000 (08:09 -0700)
Change-Id: I6e5cb2e7ba34ceaf4ca128e4b32da99d08917156

includes/libs/objectcache/WANObjectCache.php

index 3b9c832..1a0e9bb 100644 (file)
@@ -289,7 +289,8 @@ class WANObjectCache {
         *
         * @param string $key Cache key
         * @param mixed $value
-        * @param integer $ttl Seconds to live [0=forever]
+        * @param integer $ttl Seconds to live. Special values are:
+        *   - WANObjectCache::TTL_INDEFINITE: Cache forever
         * @param array $opts Options map:
         *   - lag     : Seconds of slave lag. Typically, this is either the slave lag
         *               before the data was read or, if applicable, the slave lag before