X-Git-Url: https://vcs.fsf.org/?a=blobdiff_plain;f=Civi.php;h=ee6138c9845683ced0629b8b0e357f1d8a0c3dd1;hb=d1249113599d135186c1951aedb10e70cf41123a;hp=90aebee174d2ead75b84dafce2047acfe23ef110;hpb=da1ad7aad9f3b6496444899dabcaa03e223224e3;p=civicrm-core.git

diff --git a/Civi.php b/Civi.php
index 90aebee174..ee6138c984 100644
--- a/Civi.php
+++ b/Civi.php
@@ -32,6 +32,15 @@ class Civi {
    *   The name of the cache. The 'default' cache is biased toward
    *   high-performance caches (eg memcache/redis/apc) when
    *   available and falls back to single-request (static) caching.
+   *   Ex: 'short' or 'default' is useful for high-speed, short-lived cache data.
+   *       This is appropriate if you believe that latency (millisecond-level
+   *       read time) is the main factor. For example: caching data from
+   *       a couple SQL queries.
+   *   Ex: 'long' can be useful for longer-lived cache data. It's appropriate if
+   *       you believe that longevity (e.g. surviving for several hours or a day)
+   *       is more important than  millisecond-level access time. For example:
+   *       caching the result of a simple metadata-query.
+   *
    * @return CRM_Utils_Cache_Interface
    *   NOTE: Beginning in CiviCRM v5.4, the cache instance complies with
    *   PSR-16 (\Psr\SimpleCache\CacheInterface).