Add more ProcessCacheLRU comments
authorAaron Schulz <aschulz@wikimedia.org>
Sun, 24 Sep 2017 11:17:11 +0000 (13:17 +0200)
committerAaron Schulz <aschulz@wikimedia.org>
Sun, 24 Sep 2017 20:37:28 +0000 (20:37 +0000)
Change-Id: I5b59dd065dc387a6c7f9cae42ea5244247448650

includes/libs/ProcessCacheLRU.php

index 03e23ed..b374259 100644 (file)
 use Wikimedia\Assert\Assert;
 
 /**
- * Handles per process caching of items
+ * Class for process caching individual properties of expiring items
+ *
+ * When the key for an entire item is deleted, all properties for it are deleted
+ *
  * @ingroup Cache
  */
 class ProcessCacheLRU {
-       /** @var Array */
+       /** @var array */
        protected $cache = []; // (key => prop => value)
 
-       /** @var Array */
+       /** @var array */
        protected $cacheTimes = []; // (key => prop => UNIX timestamp)
 
        protected $maxCacheKeys; // integer; max entries