From: Aaron Schulz <aschulz@wikimedia.org>
Date: Thu, 12 May 2016 03:25:14 +0000 (-0700)
Subject: Document WAN cache FLD_* constants
X-Git-Tag: 1.31.0-rc.0~7000^2
X-Git-Url: https://git.heureux-cyclage.org/?p=lhc%2Fweb%2Fwiklou.git;a=commitdiff_plain;h=9c93a53af1547acf2216b4d88ba6672bf277d562

Document WAN cache FLD_* constants

Change-Id: Ie6a19ae2c5ab6f60a3c6818eb1c9016402bc86c9
---

diff --git a/includes/libs/objectcache/WANObjectCache.php b/includes/libs/objectcache/WANObjectCache.php
index 18cc10e43c..bc3687b304 100644
--- a/includes/libs/objectcache/WANObjectCache.php
+++ b/includes/libs/objectcache/WANObjectCache.php
@@ -110,12 +110,12 @@ class WANObjectCache implements IExpiringStore, LoggerAwareInterface {
 	/** Cache format version number */
 	const VERSION = 1;
 
-	const FLD_VERSION = 0;
-	const FLD_VALUE = 1;
-	const FLD_TTL = 2;
-	const FLD_TIME = 3;
-	const FLD_FLAGS = 4;
-	const FLD_HOLDOFF = 5;
+	const FLD_VERSION = 0; // key to cache version number
+	const FLD_VALUE = 1; // key to the cached value
+	const FLD_TTL = 2; // key to the original TTL
+	const FLD_TIME = 3; // key to the cache time
+	const FLD_FLAGS = 4; // key to the flags bitfield
+	const FLD_HOLDOFF = 5; // key to any hold-off TTL
 
 	/** @var integer Treat this value as expired-on-arrival */
 	const FLG_STALE = 1;