phpDocumentor Cotonti
[ class tree: Cotonti ] [ index: Cotonti ] [ all elements ]

Class: Cache_driver

Source Location: /cache.php

Class Cache_driver

Class Overview

Abstract class containing code common for all cache drivers

Located in /cache.php [line 50]



		
				Author(s):
		
  • trustmaster
API Tags:
Abstract:  

Information Tags:

Methods

[ Top ]
Method Summary
bool   clear()   Clears all cache entries served by current driver
bool   exists()   Checks if an object is stored in cache
mixed   get()   Returns value of cached image
bool   remove()   Removes object image from cache

[ Top ]
Methods
clear  [line 57]

  bool clear( [string $realm = COT_DEFAULT_REALM]  )

Clears all cache entries served by current driver

Parameters:
string   $realm:  Cache realm name, to clear specific realm only

API Tags:
Abstract:  
Access:  public


[ Top ]
exists  [line 65]

  bool exists( string $id, [string $realm = COT_DEFAULT_REALM]  )

Checks if an object is stored in cache

Parameters:
string   $id:  Object identifier
string   $realm:  Cache realm

API Tags:
Abstract:  
Access:  public


[ Top ]
get  [line 73]

  mixed get( string $id, [string $realm = COT_DEFAULT_REALM]  )

Returns value of cached image

Parameters:
string   $id:  Object identifier
string   $realm:  Realm name

API Tags:
Return:  Cached item value or NULL if the item was not found in cache
Abstract:  
Access:  public


[ Top ]
remove  [line 81]

  bool remove( string $id, [string $realm = COT_DEFAULT_REALM]  )

Removes object image from cache

Parameters:
string   $id:  Object identifier
string   $realm:  Realm name

API Tags:
Abstract:  
Access:  public


[ Top ]

Documentation generated on Fri, 19 Mar 2010 17:45:21 +0000 by phpDocumentor 1.4.3