Package base :: Package includes :: Module cache
[hide private]

Module cache

source code

Cache functions
See Also:
Drupy Homepage, Drupal Homepage
Notes:

Author: Brendon Crawford

Copyright: 2008 Brendon Crawford

Contact: message144 at users dot sourceforge dot net

Version: 0.1

Functions [hide private]
 
get(cid, table='cache')
Return data from the persistent cache.
source code
 
set(cid, data, table='cache', expire=None, headers=None)
Store data in the persistent cache.
source code
 
clear_all(cid=None, table=None, wildcard=False)
Expire data from the cache.
source code
Variables [hide private]
  __version__ = '$Revision: 1 $'
Function Details [hide private]

get(cid, table='cache')

source code 
Return data from the persistent cache. Data may be stored as either plain text or as serialized data. cache_get will automatically return unserialized objects and arrays.
Parameters:
  • cid - The cache ID of the data to retrieve.
  • table - The table table to store the data in. Valid core values are 'cache_filter', 'cache_menu', 'cache_page', or 'cache' for the default cache.
Returns:
The cache or FALSE on failure.

set(cid, data, table='cache', expire=None, headers=None)

source code 
Store data in the persistent cache. The persistent cache is split up into four database tables. Contributed plugins can add additional tables. 'cache_page': This table stores generated pages for anonymous users. This is the only table affected by the page cache setting on the administrator panel. 'cache_menu': Stores the cachable part of the users' menus. 'cache_filter': Stores filtered pieces of content. This table is periodically cleared of stale entries by cron. 'cache': Generic cache storage table. The reasons for having several tables are as follows: - smaller tables allow for faster selects and inserts - we try to put fast changing cache items and rather static ones into different tables. The effect is that only the fast changing tables will need a lot of writes to disk. The more static tables will also be better cachable with MySQL's query cache
Parameters:
  • cid - The cache ID of the data to store.
  • data - The data to store in the cache. Complex data types will be automatically serialized before insertion. Strings will be stored as plain text and not serialized.
  • table - The table table to store the data in. Valid core values are 'cache_filter', 'cache_menu', 'cache_page', or 'cache'.
  • expire - One of the following values: - CACHE_PERMANENT: Indicates that the item should never be removed unless explicitly told to using cache_clear_all() with a cache ID. - CACHE_TEMPORARY: Indicates that the item should be removed at the next general cache wipe. - A Unix timestamp: Indicates that the item should be kept at least until the given time, after which it behaves like CACHE_TEMPORARY.
  • headers - A string containing HTTP php.header information for cached pages.

clear_all(cid=None, table=None, wildcard=False)

source code 
Expire data from the cache. If called without arguments, expirable entries will be cleared from the cache_page and cache_block tables.
Parameters:
  • cid - If set, the cache ID to delete. Otherwise, all cache entries that can expire are deleted.
  • table - If set, the table table to delete from. Mandatory argument if cid is set.
  • wildcard - If set to TRUE, the cid is treated as a substring to match rather than a complete ID. The match is a right hand match. If '*' is given as cid, the table table will be emptied.