diff options
author | Jennifer Hodgdon <yahgrp@poplarware.com> | 2012-09-25 11:22:30 -0700 |
---|---|---|
committer | Jennifer Hodgdon <yahgrp@poplarware.com> | 2012-09-25 11:22:30 -0700 |
commit | b1536cf0318de9a542ce8a928fe8ac449572a7e6 (patch) | |
tree | 7f5b2cd66bb0626df2abe9df28688445add67036 /includes/common.inc | |
parent | 64470af1fc9b64e3dbacae899a5675bcb20d21bf (diff) | |
download | brdo-b1536cf0318de9a542ce8a928fe8ac449572a7e6.tar.gz brdo-b1536cf0318de9a542ce8a928fe8ac449572a7e6.tar.bz2 |
Issue #863428 by Albert Volkman: Clean-up of cache constant documentation
Diffstat (limited to 'includes/common.inc')
-rw-r--r-- | includes/common.inc | 20 |
1 files changed, 12 insertions, 8 deletions
diff --git a/includes/common.inc b/includes/common.inc index 91a40cba4..0d390c0e3 100644 --- a/includes/common.inc +++ b/includes/common.inc @@ -96,11 +96,16 @@ define('HTTP_REQUEST_TIMEOUT', -1); * @{ * Constants that define each block's caching state. * - * Modules specify the caching patterns for their blocks using binary - * combinations of these constants in their hook_block_info(). - * DRUPAL_CACHE_PER_ROLE is used as a default when no caching pattern is - * specified. Use DRUPAL_CACHE_CUSTOM to disable standard block cache and - * implement + * Modules specify how their blocks can be cached in their hook_block_info() + * implementations. Caching can be turned off (DRUPAL_NO_CACHE), managed by the + * module declaring the block (DRUPAL_CACHE_CUSTOM), or managed by the core + * Block module. If the Block module is managing the cache, you can specify that + * the block is the same for every page and user (DRUPAL_CACHE_GLOBAL), or that + * it can change depending on the page (DRUPAL_CACHE_PER_PAGE) or by user + * (DRUPAL_CACHE_PER_ROLE or DRUPAL_CACHE_PER_USER). Page and user settings can + * be combined with a bitwise-binary or operator; for example, + * DRUPAL_CACHE_PER_ROLE | DRUPAL_CACHE_PER_PAGE means that the block can change + * depending on the user role or page it is on. * * The block cache is cleared in cache_clear_all(), and uses the same clearing * policy than page cache (node, comment, user, taxonomy added or updated...). @@ -124,9 +129,8 @@ define('DRUPAL_NO_CACHE', -1); /** * The block is handling its own caching in its hook_block_view(). * - * From the perspective of the block cache system, this is equivalent to - * DRUPAL_NO_CACHE. Useful when time based expiration is needed or a site uses - * a node access which invalidates standard block cache. + * This setting is useful when time based expiration is needed or a site uses a + * node access which invalidates standard block cache. */ define('DRUPAL_CACHE_CUSTOM', -2); |