MDL-36466 cache: implemented functionality to disable the bulk of the cache API
[moodle.git] / cache / README.md
index 8d250cb..ef8c82a 100644 (file)
@@ -68,7 +68,14 @@ While the cache API must still be functional in order for calls to it to work it
     // If you disabled it using the above means you can re-enable it with:
     cache_factory::reset();
 
-
+Disabling the cache entirely.
+Like above there are times when you want the cache to avoid initialising anything it doesn't absolutely need. Things such as installation and upgrade require this functionality.
+When the cache API is disabled it is still functional however special "disabled" classes will be used instead of the regular classes that make the Cache API tick.
+These disabled classes do the least work possible and through this means we avoid all manner of intialisation and configuration.
+Once disabled its not recommened to reneable the Cache API. Instead if you need it, redirect.
+
+    // To disable the cache entirely call the following:
+    cache_factory::disable();
 
 Cache API parts
 ---------------