(NFC) CRM_Utils_Cache::create - Update docblock for 'name' param
authorTim Otten <totten@civicrm.org>
Fri, 10 Aug 2018 19:43:02 +0000 (12:43 -0700)
committerTim Otten <totten@civicrm.org>
Fri, 10 Aug 2018 19:43:02 +0000 (12:43 -0700)
CRM/Utils/Cache.php

index af2bb835753b6793d5e1a394f15652f4e147f4c7..0ce1128c83ba2019c878996d45845742c7923f81 100644 (file)
@@ -160,6 +160,9 @@ class CRM_Utils_Cache {
    * @param array $params
    *   Array with keys:
    *   - name: string, unique symbolic name.
+   *     For a naming convention, use `snake_case` or `CamelCase` to maximize
+   *     portability/cleanliness. Any other punctuation or whitespace
+   *     should function correctly, but it can be harder to inspect/debug.
    *   - type: array|string, list of acceptable cache types, in order of preference.
    *   - prefetch: bool, whether to prefetch all data in cache (if possible).
    * @return CRM_Utils_Cache_Interface