From 5a4c4bea887c9adf3993369d8282560db41c7c0c Mon Sep 17 00:00:00 2001
From: Richard Castera <richard.castera@gmail.com>
Date: Mon, 14 Nov 2011 12:14:09 -0500
Subject: [PATCH] Finished first iterations of wrapper functions and added
 documentation

---
 Class.ApcCache.php | 71 ++++++++++++++++++++++++++++++++++------------
 1 file changed, 53 insertions(+), 18 deletions(-)

diff --git a/Class.ApcCache.php b/Class.ApcCache.php
index 09cfd8b..810ef4f 100644
--- a/Class.ApcCache.php
+++ b/Class.ApcCache.php
@@ -1,37 +1,72 @@
 <?php
+/**
+ * @uses        Wrapper class to APC
+ * @author      Richard Castera
+ * @link        http://www.richardcastera.com/projects/code/php5-session-class
+ * @see         http://www.php.net/manual/en/book.apc.php
+ * @license     GNU LESSER GENERAL Public LICENSE
+ */
 
 class static ApcCache {
 	
-	public function __construct() {
-		
-	}
-
-	public function __destruct() {
-		
-	}
+	public function __construct() {}
+	public function __destruct() {}
 
+	/**
+   * @uses		Retrieves cached information from APC's data store.
+   * @param	  None.
+   * @return  Array.
+   */
 	public function cacheInfo() {
-		
+		return apc_cache_info();
 	}
 
-	public function cacheExists() {
-		
+	/**
+   * @uses		Checks if APC key exists.
+   * @param	  String $key - A string, or an array of strings, that contain keys.
+   * @return  Variant - Returns TRUE if the key exists, otherwise FALSE Or if an array was passed to keys, then an array is returned that contains all existing keys, or an empty array if none exist.
+   */
+	public function cacheExists($key) {
+		return apc_exists($key);
 	}
-	
-	public function cacheStore() {
-		
+
+	/**
+   * @uses		Cache a variable in the data store.
+   * @param	  String $key - Store the variable using this name. keys are cache-unique, so storing a second value with the same key will overwrite the original value.
+   * @param	  String $data - The variable to store.
+   * @param	  String $ttl - Time To Live; store var in the cache for ttl seconds. After the ttl has passed, the stored variable will be expunged 
+   *												from the cache (on the next request). If no ttl is supplied (or if the ttl is 0), the value will persist until it is removed from the cache manually, or otherwise fails to exist in the cache (clear, restart, etc.). 
+   * @return  Boolean - Returns TRUE on success or FALSE on failure.
+   */
+	public function cacheStore($key, $data, $ttl = 0) {
+		return apc_store($key, $data, $ttl);
 	}
 
-	public function cacheFetch() {
-		
+	/**
+   * @uses		Checks if APC key exists.
+   * @param	  String $key - The key used to store the value (with apc_store()). If an array is passed then each element is fetched and returned.
+   * @return  Boolean - The stored variable or array of variables on success; FALSE on failure.
+   */
+	public function cacheFetch($key) {
+		return apc_fetch($key);
 	}
 
-	public function cacheDelete() {
-		
+	/**
+   * @uses		Removes a stored variable from the cache.
+   * @param	  String $key - The key used to store the value (with apc_store()).
+   * @return  Boolean - Returns TRUE on success or FALSE on failure.
+   */
+	public function cacheDelete($key) {
+		return apc_delete($key);
 	}
 
+	/**
+   * @uses		Clears the APC cache.
+   * @param	  None.
+   * @return  Boolean - Returns TRUE on success or FALSE on failure.
+   */
 	public function cacheClear() {
-		
+		return apc_clear_cache();
 	}
 
 }
\ No newline at end of file