fwolf / fwlib

class/cache/cache.php

<?php
require_once(dirname(__FILE__) . '/../fwolflib.php');
require_once(dirname(__FILE__) . '/../../func/array.php');
require_once(dirname(__FILE__) . '/../../func/string.php');


/**
 * Parent class for Key - value cache system
 *
 * Data store in various way, define in sub class, call use Create().
 * As factory This class is also subclass creator, so not abstract.
 *
 * Main method:
 * -	Key(), hash or use original key.
 * -	Set(), write cache data
 * -	Get(), read cache data
 * -	Del(), delete cache data
 *
 * @deprecated  Use Fwlib\Cache\Cache
 * @package		fwolflib
 * @subpackage	class.cache
 * @copyright	Copyright 2012, Fwolf
 * @author		Fwolf <fwolf.aide+fwolflib.class.cache@gmail.com>
 * @since		2012-09-14
 */
class Cache extends Fwolflib {

The type Cache has been defined more than once; this definition is ignored, only the first definition in class/cache.php (L35-376) is considered.

The class Fwolflib has been deprecated with message: Use classes in Fwlib namespace, see PSR-0/1/2

	/**
	 * Cache data for cache type ''
	 *
	 * @var	array
	 */
	protected $aCache = array();

	/**
	 * Log for Get op's key and success flag
	 *
	 * array(
	 * 	array(
	 * 		key: string,
	 * 		success: boolean,
	 * 	)
	 * )
	 *
	 * @var	array
	 */
	public static $aLogGet = array();


	/**
	 * Constructor
	 *
	 * @param	array	$ar_cfg
	 */
	public function __construct ($ar_cfg = array()) {
		parent::__construct($ar_cfg);

		// Unset for auto new
	} // end of func __construct


	/**
	 * Factory create method
	 *
	 * @param	string	$type			Cache type
	 * @param	array	$ar_cfg
	 * @return	object
	 */
	public static function Create ($type = '', $ar_cfg = array()) {
		// Supported cache type
		if (!in_array($type, array('',
			'file',
			'memcached',
			))) {
			// $this is not allowed in static func
			//$this->Log('Cache type ' . $type . ' not supported.', 4);
			error_log('Cache type ' . $type . ' not supported.');
			return NULL;
		}


		// Include file, new obj
		$s_filename = 'cache'
			. (empty($type) ? '' : '-') . $type;
		$s_classname = StrUnderline2Ucfirst($s_filename, true);

The function StrUnderline2Ucfirst() has been deprecated with message: Use Fwlib\Util\StringUtil::toStudlyCaps()

		$s_filename .= '.php';

		require_once(dirname(__FILE__) . '/' . $s_filename);
		return (new $s_classname($ar_cfg));
	} // end of func Create


	/**
	 * Del cache data
	 *
	 * @param	string	$key
	 * @return	$this
	 */
	public function Del ($key) {
		unset($this->aCache[$key]);
		return $this;
	} // end of func Del


	/**
	 * Is cache data expire ?
	 *
	 * @param	string	$key
	 * @return	boolean
	 */
	public function Expire ($key) {
		// Inner var never expire,
		// Also, there is no good method to keep var set time.
		return false;
	} // end of func Expire


	/**
	 * Compute expiration time
	 *
	 * @param	int		$lifetime
	 * @param	int		$t_base			Base start time, 0 use time().
	 * @return	int						In unix time.
	 */
	public function ExpireTime ($lifetime = NULL, $t_base = 0) {
		// If not set, use config
		if (is_null($lifetime))
			$lifetime = $this->aCfg['cache-lifetime'];

		// 0 means never expire
		if (0 == $lifetime)
			return 0;

		if (0 == $t_base)
			$t_base = time();

		// If smaller than 30days
		if (2592000 >= $lifetime) {
			return $t_base + $lifetime;
		}

		// Larger than 30days, it's unix timestamp, ignore $t_base
		return $lifetime;
	} // end of func ExpireTime


	/**
	 * Load cache data
	 *
	 * @param	string	$key
	 * @param	int		$lifetime		Cache lifetime
	 * @return	mixed
	 */
	public function Get ($key, $lifetime = NULL) {
		$key = $this->Key($key);

It seems like you code against a specific sub-type and not the parent class Cache as the method Key() does only exist in the following sub-classes of Cache: CacheMemcached. Maybe you want to instanceof check for one of these explicitly?

		// Ignored lifetime
		$val = $this->ValDecode(

The method ValDecode() does not seem to exist on object<Cache>.

			ArrayRead($this->aCache, $key, NULL)

The property aCache does not exist on object<Cache>. Since you implemented __get, maybe consider adding a @property annotation.

The function ArrayRead() has been deprecated with message: Use Fwlib\Util\ArrayUtil::getIdx(), getEdx()

			, 0);

		self::$aLogGet[] = array(
			'key'	=> $key,
			'success'	=> !is_null($val),
		);
		return $val;
	} // end of func Get


	/**
	 * Gen cache key
	 *
	 * In some cache system, key may need hash or computed.
	 *
	 * @param	string	$str
	 * @return	string
	 */
	public function Key ($str) {
		return $str;
	} // end of func Key


	/**
	 * Write data to cache
	 *
	 * @param	string	$key
	 * @param	mixed	$val
	 * @param	int		$lifetime
	 * @return	$this
	 */
	public function Set ($key, $val, $lifetime = NULL) {
		// Lifetime is useless.
		$this->aCache[$this->Key($key)] = $this->ValEncode($val, 0);

The property aCache does not exist on object<Cache>. Since you implemented __get, maybe consider adding a @property annotation.

It seems like you code against a specific sub-type and not the parent class Cache as the method Key() does only exist in the following sub-classes of Cache: CacheMemcached. Maybe you want to instanceof check for one of these explicitly?

The method ValEncode() does not seem to exist on object<Cache>.

		return $this;
	} // end of func Set


	/**
	 * Set default config
	 *
	 * @return	this
	 */
	protected function SetCfgDefault () {

This method seems to be duplicated in your project.

		parent::SetCfgDefault();

		// Cache type: file, memcached
		// Empty means parent cache class.
		$this->aCfg['cache-type'] = '';

		// Cache store method
		// 0: Raw string or other value.
		//	User should determine the value DO suite cache type.
		// 1: Json, decode to array.
		// 2: Json, decode to object.
		$this->aCfg['cache-store-method'] = 1;

		// Default cache lifetime, in second
		// Can be overwrite by param when get/set.
		// Default/Max 30days:
		//   60sec * 60min = 3600s * 24h = 86400s * 30 = 2592000s
		// Larger than 30days, must assign unix time like memcached,
		//   which is number of seconds since 1970-1-1 as an integer.
		// 0 means forever.
		$this->aCfg['cache-lifetime'] = 2592000;

		return $this;
	} // end of func SetCfgDefault


	/**
	 * Decode val stored in cache
	 *
	 * Lifetime get/set various by cache type, assign in subclass
	 *
	 * @param	string	$str			Str read from cache
	 * @return	mixed
	 */
	public function ValDecode ($str) {
		if (1 == $this->aCfg['cache-store-method']) {
			// Json to array
			return json_decode($str, true);
		}
		elseif (2 == $this->aCfg['cache-store-method']) {
			// Json to object
			return json_decode($str, false);
		}
		else {
			// Cache store method = 0 or other, return raw.
			return $str;
		}
	} // end of func ValDecode


	/**
	 * Encode val to store in cache
	 *
	 * Lifetime get/set various by cache type, assign in subclass
	 *
	 * @param	mixed	$val
	 * @return	string
	 */
	public function ValEncode ($val) {
		if (1 == $this->aCfg['cache-store-method']
			|| 2 == $this->aCfg['cache-store-method']) {
			return JsonEncodeUnicode($val);

The function JsonEncodeUnicode() has been deprecated with message: Use Fwlib\Util\Json::encodeUnicode()

		}
		else {
			// Raw
			return $val;
		}
	} // end of func ValEncode


	/**
	 * Get or increase version number
	 *
	 * Mostly used in memcached for batch delete items
	 *
	 * @param	string	$key
	 * @param	int		$i_increment
	 * @param	int		$i_max
	 * @return	int
	 */
	public function Ver ($key, $i_increment = 0, $i_max = 65535) {
		$i = $this->Get($key);

It seems like you code against a specific sub-type and not the parent class Cache as the method Get() does only exist in the following sub-classes of Cache: CacheFile, CacheMemcached. Maybe you want to instanceof check for one of these explicitly?

		if (empty($i)) {
			$i = 1;
			$this->Set($key, $i, 0);

It seems like you code against a specific sub-type and not the parent class Cache as the method Set() does only exist in the following sub-classes of Cache: CacheFile, CacheMemcached. Maybe you want to instanceof check for one of these explicitly?

		}

		if (0 != $i_increment) {
			$i += $i_increment;
			if ($i_max < $i)
				$i = 1;
			$this->Set($key, $i, 0);

It seems like you code against a specific sub-type and not the parent class Cache as the method Set() does only exist in the following sub-classes of Cache: CacheFile, CacheMemcached. Maybe you want to instanceof check for one of these explicitly?

		}

		return $i;
	} // end of func Ver


} // end of class Cache
?>

It is not recommended to use PHP's closing tag ?> in files other than templates.