From 55b4d2f6209889de4643a78d915ad6395759bbe2 Mon Sep 17 00:00:00 2001 From: Aaron Schulz Date: Fri, 9 Sep 2016 00:57:57 -0700 Subject: [PATCH] Cleanup and re-indent some WANObjectCache docs Change-Id: Ibf7092297ce53fd21e478a6f87a16f9b4373ad85 --- includes/libs/objectcache/WANObjectCache.php | 32 ++++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/includes/libs/objectcache/WANObjectCache.php b/includes/libs/objectcache/WANObjectCache.php index 08f20959e9..adb2899e58 100644 --- a/includes/libs/objectcache/WANObjectCache.php +++ b/includes/libs/objectcache/WANObjectCache.php @@ -387,22 +387,23 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface { * @param integer $ttl Seconds to live. Special values are: * - WANObjectCache::TTL_INDEFINITE: Cache forever * @param array $opts Options map: - * - lag : Seconds of replica DB lag. Typically, this is either the replica DB lag - * before the data was read or, if applicable, the replica DB lag before - * the snapshot-isolated transaction the data was read from started. - * Default: 0 seconds - * - since : UNIX timestamp of the data in $value. Typically, this is either - * the current time the data was read or (if applicable) the time when - * the snapshot-isolated transaction the data was read from started. - * Default: 0 seconds + * - lag : Seconds of replica DB lag. Typically, this is either the replica DB lag + * before the data was read or, if applicable, the replica DB lag before + * the snapshot-isolated transaction the data was read from started. + * Use false to indicate that replication is not running. + * Default: 0 seconds + * - since : UNIX timestamp of the data in $value. Typically, this is either + * the current time the data was read or (if applicable) the time when + * the snapshot-isolated transaction the data was read from started. + * Default: 0 seconds * - pending : Whether this data is possibly from an uncommitted write transaction. - * Generally, other threads should not see values from the future and - * they certainly should not see ones that ended up getting rolled back. - * Default: false + * Generally, other threads should not see values from the future and + * they certainly should not see ones that ended up getting rolled back. + * Default: false * - lockTSE : if excessive replication/snapshot lag is detected, then store the value - * with this TTL and flag it as stale. This is only useful if the reads for - * this key use getWithSetCallback() with "lockTSE" set. - * Default: WANObjectCache::TSE_NONE + * with this TTL and flag it as stale. This is only useful if the reads for + * this key use getWithSetCallback() with "lockTSE" set. + * Default: WANObjectCache::TSE_NONE * @return bool Success */ final public function set( $key, $value, $ttl = 0, array $opts = [] ) { @@ -899,8 +900,7 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface { * @param string $key * @param integer $ttl * @param callback $callback - * @param array $opts Options map for getWithSetCallback() which also includes: - * - minTime: Treat values older than this UNIX timestamp as not existing. Default: null. + * @param array $opts Options map for getWithSetCallback() * @param float &$asOf Cache generation timestamp of returned value [returned] * @return mixed * @note Callable type hints are not used to avoid class-autoloading -- 2.20.1