Class CWinCache
CWinCache implements a cache application component based on WinCache.
To use this application component, the WinCache PHP extension must be
loaded.
See CCache manual for common cache operations that are supported by
CWinCache.
-
CComponent
-
CApplicationComponent
implements
IApplicationComponent
-
CCache
implements
ICache,
ArrayAccess
-
CWinCache
Methods summary
public
|
#
init( )
Initializes this application component. This method is required by the IApplicationComponent interface. It checks the availability of WinCache
extension and WinCache user cache.
Initializes this application component. This method is required by the IApplicationComponent interface. It checks the availability of WinCache
extension and WinCache user cache.
Throws
CExceptionif WinCache extension is not loaded or user cache is disabled
Overrides
|
protected
string|boolean
|
#
getValue( string $key )
Retrieves a value from cache with a specified key. This is the implementation
of the method declared in the parent class.
Retrieves a value from cache with a specified key. This is the implementation
of the method declared in the parent class.
Parameters
- $key
string
$key a unique key identifying the cached value Returns
string|boolean
the value stored in cache, false if the value is not in the cache or expired.
Throws
CExceptionif this method is not overridden by child classes
Overrides
|
protected
array
|
#
getValues( array $keys )
Retrieves multiple values from cache with the specified keys.
Retrieves multiple values from cache with the specified keys.
Parameters
- $keys
array
$keys a list of keys identifying the cached values Returns
array
a list of cached values indexed by the keys
Overrides
|
protected
boolean
|
#
setValue( string $key, string $value, integer $expire )
Stores a value identified by a key in cache. This is the implementation of
the method declared in the parent class.
Stores a value identified by a key in cache. This is the implementation of
the method declared in the parent class.
Parameters
- $key
string
$key the key identifying the value to be cached- $value
string
$value the value to be cached- $expire
integer
$expire the number of seconds in which the cached value will expire. 0 means
never expire. Returns
boolean
true if the value is successfully stored into cache, false otherwise
Throws
CExceptionif this method is not overridden by child classes
Overrides
|
protected
boolean
|
#
addValue( string $key, string $value, integer $expire )
Stores a value identified by a key into cache if the cache does not contain
this key. This is the implementation of the method declared in the parent
class.
Stores a value identified by a key into cache if the cache does not contain
this key. This is the implementation of the method declared in the parent
class.
Parameters
- $key
string
$key the key identifying the value to be cached- $value
string
$value the value to be cached- $expire
integer
$expire the number of seconds in which the cached value will expire. 0 means
never expire. Returns
boolean
true if the value is successfully stored into cache, false otherwise
Throws
CExceptionif this method is not overridden by child classes
Overrides
|
protected
boolean
|
#
deleteValue( string $key )
Deletes a value with the specified key from cache This is the implementation
of the method declared in the parent class.
Deletes a value with the specified key from cache This is the implementation
of the method declared in the parent class.
Parameters
- $key
string
$key the key of the value to be deleted Returns
boolean
if no error happens during deletion
Throws
CExceptionif this method is not overridden by child classes
Overrides
|
protected
boolean
|
#
flushValues( )
Deletes all values from cache. This is the implementation of the method
declared in the parent class.
Deletes all values from cache. This is the implementation of the method
declared in the parent class.
Returns
boolean
whether the flush operation was successful.
Throws
CExceptionif this method is not overridden by child classes
Since
1.1.5
Overrides
|
Methods inherited from CCache
add(),
delete(),
flush(),
generateUniqueKey(),
get(),
mget(),
offsetExists(),
offsetGet(),
offsetSet(),
offsetUnset(),
set()
|
Methods inherited from CComponent
__call(),
__get(),
__isset(),
__set(),
__unset(),
asa(),
attachBehavior(),
attachBehaviors(),
attachEventHandler(),
canGetProperty(),
canSetProperty(),
detachBehavior(),
detachBehaviors(),
detachEventHandler(),
disableBehavior(),
disableBehaviors(),
enableBehavior(),
enableBehaviors(),
evaluateExpression(),
getEventHandlers(),
hasEvent(),
hasEventHandler(),
hasProperty(),
raiseEvent()
|