Class: WindXCache

Source Location: /cache/strategy/WindXCache.php

Class WindXCache

Class Overview

WindXCache封装了xCache实现缓存策略

提供对方访问接口如下:

set($key, $value, $expire): 继承自AbstractWindCache::set().
get($key): 继承自AbstractWindCache::get().
delete($key): 继承自AbstractWindCache::delete().
batchGet($keys): 继承自AbstractWindCache::batchGet().
batchDelete($keys): 继承自AbstractWindCache::batchDelete().
setConfig($config): 重写了父类的AbstractWindCache::setConfig().

它接收如下配置:

array(
'user' => '', //拥有清空xcache数据的权限用户
'pwd' => '', //拥有清空xcache数据的权限用户的密码
'security-code' => '', //继承自AbstractWindCache,安全码配置
'key-prefix' => '', //继承自AbstractWindCache,缓存key前缀
'expires' => '0', //继承自AbstractWindCache,缓存过期时间配置
)

xcache缓存的使用:
1、像使用普通类库一样使用该组件:

Wind::import('WIND:cache.strategy.WindXCache');
$cache = new WindxCache();
$cache->set('name', 'windDbTest');

2、采用组件配置的方式，通过组件机制调用在应用配置的components组件配置块中,配置xCache(该名字将决定调用的时候使用的组件名字):

'xCache' => array(
'path' => 'WIND:cache.strategy.WindXCache',
'scope' => 'singleton',
'config' => array(
'user' => '',
'pwd' => '',
'security-code' => '',
'key-prefix' => '',
'expires' => '0',
),
),

在应用中可以通过如下方式获得xCache对象:

$cache = Wind::getApp()->getComponent('xCache'); //xCache的名字来自于组件配置中的名字
$cache->set('name', 'test');

<note>注意:该组件需要安装扩展xcache.</note>

the last known user to change this file in the repository <LastChangedBy: xiaoxiao >

Located in /cache/strategy/WindXCache.php [line 62]

WindModule
   |
   --AbstractWindCache
      |
      --WindXCache

Author(s):

xiaoxiao <xiaoxia.xuxx@aliyun-inc.com>

Information Tags:

Version:	$Id: WindXCache.php 2973 2011-10-15 19:22:48Z yishuo $
Copyright:	©2003-2103 phpwind.com
License:	http://www.windframework.com

Methods

[ Top ]

Inherited Properties, Constants, and Methods

Inherited Properties

Inherited Methods

Inherited Constants

Inherited From WindModule

WindModule::$_config

WindModule::$_proxy

WindModule::$_typeValidation

Inherited From AbstractWindCache

AbstractWindCache::add()

增加一个条目到缓存服务器

AbstractWindCache::addValue()

执行添加操作

AbstractWindCache::batchDelete()

通过key批量删除缓存数据

AbstractWindCache::batchGet()

通过key批量获取缓存数据

AbstractWindCache::buildData()

构造保存的数据

AbstractWindCache::buildSecurityKey()

将数据key计算生成安全的key

AbstractWindCache::clear()

清楚缓存，过期及所有缓存

AbstractWindCache::decrement()

将元素的值减小value

AbstractWindCache::delete()

删除缓存数据

AbstractWindCache::deleteValue()

需要实现的删除操作

AbstractWindCache::formatData()

格式化输出

AbstractWindCache::get()

根据缓存key获取指定缓存

AbstractWindCache::getExpire()

返回过期时间设置

AbstractWindCache::getKeyPrefix()

返回缓存Key值前缀

AbstractWindCache::getSecurityCode()

获得缓存key计算中加入的安全码

AbstractWindCache::getValue()

执行获取操作

AbstractWindCache::hasChanged()

判断数据是否已经被更新

AbstractWindCache::increment()

将指定元素的值增加value

AbstractWindCache::set()

设置缓存如果key不存在，添加缓存；否则，将会替换已有key的缓存。

AbstractWindCache::setConfig()

设置配置信息

AbstractWindCache::setExpire()

设置缓存过期时间

AbstractWindCache::setKeyPrefix()

设置key前缀

AbstractWindCache::setSecurityCode()

设置缓存key计算中加入的安全码

AbstractWindCache::setValue()

执行设置操作

Inherited From WindModule

WindModule::getConfig()

根据配置名取得相应的配置

WindModule::getRequest()

返回当前应用的WindHttpRequest对象

WindModule::getResponse()

返回当前应用的WindHttpResponse对象

WindModule::getSystemFactory()

返回当前应用的WindFactory对象

WindModule::setConfig()

设置类配置

WindModule::setDelayAttributes()

设置延迟加载类属性相关组件配置信息

WindModule::toArray()

返回该对象的数组类型

WindModule::writeTableCloneProperty()

类对象clone白名单

WindModule::__call()

重载了魔术方法__call

WindModule::__clone()

重载魔术方法__clone

WindModule::__get()

重载了魔术方法__get

WindModule::__set()

重载了魔术方法__set

Inherited From AbstractWindCache

AbstractWindCache::DATA

AbstractWindCache::DEPENDENCY

AbstractWindCache::DEPENDENCYCLASS

AbstractWindCache::EXPIRE

AbstractWindCache::STORETIME

[ Top ]

Method Summary

WindXCache	__construct()	构造函数
void	addValue()
void	clear()
void	deleteValue()
void	getValue()
void	setConfig()
void	setValue()

[ Top ]

Properties

Methods

Constructor __construct [line 87]

WindXCache __construct(
)

构造函数

如果没有安装xcache扩展则抛出异常

API Tags:

Access:

public

Information Tags:

Throws:

WindCacheException 如果没有安装xcache扩展

[ Top ]

addValue [line 103]

void addValue(

$key, 
$value, [
$expire = 0] 
)

Parameters:

	$key:
	$value:
	$expire:

API Tags:

Access:

protected

Redefinition of:

AbstractWindCache::addValue(): 执行添加操作

[ Top ]

clear [line 124]

void clear(
)

API Tags:

Access:

public

Redefinition of:

AbstractWindCache::clear(): 清楚缓存，过期及所有缓存

[ Top ]

deleteValue [line 117]

void deleteValue(

$key 
)

Parameters:

$key:

API Tags:

Access:

protected

Redefinition of:

AbstractWindCache::deleteValue(): 需要实现的删除操作

[ Top ]

getValue [line 110]

void getValue(

$key 
)

Parameters:

$key:

API Tags:

Access:

protected

Redefinition of:

AbstractWindCache::getValue(): 执行获取操作

[ Top ]

setConfig [line 144]

void setConfig(
[
$config = array()] 
)

Parameters:

$config:

API Tags:

Access:

public

Redefinition of:

AbstractWindCache::setConfig(): 设置配置信息

[ Top ]

setValue [line 96]

void setValue(

$key, 
$value, [
$expire = 0] 
)

Parameters:

	$key:
	$value:
	$expire:

API Tags:

Access:

protected

Redefinition of:

AbstractWindCache::setValue(): 执行设置操作

[ Top ]

Documentation generated on Fri, 30 Mar 2012 11:43:44 +0800 by phpDocumentor 1.4.4

	strategy

[ class tree: strategy ] [ index: strategy ] [ all elements ]