Class CDummyCache

CDummyCache is a placeholder cache component.

CDummyCache does not cache anything. It is provided so that one can always configure a 'cache' application component and he does not need to check if Yii::app()->cache is null or not. By replacing CDummyCache with some other cache component, one can quickly switch from non-caching mode to caching mode.

CComponent

CApplicationComponent implements IApplicationComponent

CDummyCache implements ICache, ArrayAccess

Package: system\caching
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/caching/CDummyCache.php

Methods summary
`public`	# `init( )` Initializes the application component. This method overrides the parent implementation by setting default cache key prefix. Initializes the application component. This method overrides the parent implementation by setting default cache key prefix. Overrides `CApplicationComponent::init()`
`public mixed`	# `get( string $id )` Retrieves a value from cache with a specified key. Retrieves a value from cache with a specified key. Parameters `$id` `string` $id a key identifying the cached value Returns `mixed` the value stored in cache, false if the value is not in the cache, expired or the dependency has changed. Implementation of `ICache::get()`
`public array`	# `mget( array $ids )` Retrieves multiple values from cache with the specified keys. Some caches (such as memcache, apc) allow retrieving multiple cached values at one time, which may improve the performance since it reduces the communication cost. In case a cache doesn't support this feature natively, it will be simulated by this method. Retrieves multiple values from cache with the specified keys. Some caches (such as memcache, apc) allow retrieving multiple cached values at one time, which may improve the performance since it reduces the communication cost. In case a cache doesn't support this feature natively, it will be simulated by this method. Parameters `$ids` `array` $ids list of keys identifying the cached values Returns `array` list of cached values corresponding to the specified keys. The array is returned in terms of (key,value) pairs. If a value is not cached or expired, the corresponding array value will be false. Implementation of `ICache::mget()`
`public boolean`	# `set( string $id, mixed $value, integer $expire = 0, ICacheDependency $dependency = null )` Stores a value identified by a key into cache. If the cache already contains such a key, the existing value and expiration time will be replaced with the new ones. Stores a value identified by a key into cache. If the cache already contains such a key, the existing value and expiration time will be replaced with the new ones. Parameters `$id` `string` $id the key identifying the value to be cached `$value` `mixed` $value the value to be cached `$expire` `integer` $expire the number of seconds in which the cached value will expire. 0 means never expire. `$dependency` `ICacheDependency` $dependency dependency of the cached item. If the dependency changes, the item is labeled invalid. Returns `boolean` true if the value is successfully stored into cache, false otherwise Implementation of `ICache::set()`
`public boolean`	# `add( string $id, mixed $value, integer $expire = 0, ICacheDependency $dependency = null )` Stores a value identified by a key into cache if the cache does not contain this key. Nothing will be done if the cache already contains the key. Stores a value identified by a key into cache if the cache does not contain this key. Nothing will be done if the cache already contains the key. Parameters `$id` `string` $id the key identifying the value to be cached `$value` `mixed` $value the value to be cached `$expire` `integer` $expire the number of seconds in which the cached value will expire. 0 means never expire. `$dependency` `ICacheDependency` $dependency dependency of the cached item. If the dependency changes, the item is labeled invalid. Returns `boolean` true if the value is successfully stored into cache, false otherwise Implementation of `ICache::add()`
`public boolean`	# `delete( string $id )` Deletes a value with the specified key from cache Deletes a value with the specified key from cache Parameters `$id` `string` $id the key of the value to be deleted Returns `boolean` if no error happens during deletion Implementation of `ICache::delete()`
`public boolean`	# `flush( )` Deletes all values from cache. Be careful of performing this operation if the cache is shared by multiple applications. Deletes all values from cache. Be careful of performing this operation if the cache is shared by multiple applications. Returns `boolean` whether the flush operation was successful. Throws `CException` if this method is not overridden by child classes Implementation of `ICache::flush()`
`public boolean`	# `offsetExists( string $id )` Returns whether there is a cache entry with a specified key. This method is required by the interface ArrayAccess. Returns whether there is a cache entry with a specified key. This method is required by the interface ArrayAccess. Parameters `$id` `string` $id a key identifying the cached value Returns `boolean` Implementation of `ArrayAccess::offsetExists()`
`public mixed`	# `offsetGet( string $id )` Retrieves the value from cache with a specified key. This method is required by the interface ArrayAccess. Retrieves the value from cache with a specified key. This method is required by the interface ArrayAccess. Parameters `$id` `string` $id a key identifying the cached value Returns `mixed` the value stored in cache, false if the value is not in the cache or expired. Implementation of `ArrayAccess::offsetGet()`
`public`	# `offsetSet( string $id, mixed $value )` Stores the value identified by a key into cache. If the cache already contains such a key, the existing value will be replaced with the new ones. To add expiration and dependencies, use the set() method. This method is required by the interface ArrayAccess. Stores the value identified by a key into cache. If the cache already contains such a key, the existing value will be replaced with the new ones. To add expiration and dependencies, use the set() method. This method is required by the interface ArrayAccess. Parameters `$id` `string` $id the key identifying the value to be cached `$value` `mixed` $value the value to be cached Implementation of `ArrayAccess::offsetSet()`
`public boolean`	# `offsetUnset( string $id )` Deletes the value with the specified key from cache This method is required by the interface ArrayAccess. Deletes the value with the specified key from cache This method is required by the interface ArrayAccess. Parameters `$id` `string` $id the key of the value to be deleted Returns `boolean` if no error happens during deletion Implementation of `ArrayAccess::offsetUnset()`

Methods inherited from CApplicationComponent
`getIsInitialized()`

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()`

Properties summary
`public string`	`$keyPrefix`		# a string prefixed to every cache key so that it is unique. Defaults to CApplication::getId() application ID. a string prefixed to every cache key so that it is unique. Defaults to CApplication::getId() application ID.

Properties inherited from CApplicationComponent
`$behaviors`

Magic properties inherited from CApplicationComponent
`$isInitialized`

Packages

Classes

Interfaces

Class CDummyCache

Overrides

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Returns

Throws

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Implementation of

Parameters

Returns

Implementation of