Overview

Packages

  • application
    • commands
    • components
      • actions
      • filters
      • leftWidget
      • permissions
      • sortableWidget
      • util
      • webupdater
      • x2flow
        • actions
        • triggers
      • X2GridView
      • X2Settings
    • controllers
    • models
      • embedded
    • modules
      • accounts
        • controllers
        • models
      • actions
        • controllers
        • models
      • calendar
        • controllers
        • models
      • charts
        • models
      • contacts
        • controllers
        • models
      • docs
        • components
        • controllers
        • models
      • groups
        • controllers
        • models
      • marketing
        • components
        • controllers
        • models
      • media
        • controllers
        • models
      • mobile
        • components
      • opportunities
        • controllers
        • models
      • products
        • controllers
        • models
      • quotes
        • controllers
        • models
      • services
        • controllers
        • models
      • template
        • models
      • users
        • controllers
        • models
      • workflow
        • controllers
        • models
      • x2Leads
        • controllers
        • models
  • Net
  • None
  • PHP
  • system
    • base
    • caching
      • dependencies
    • collections
    • console
    • db
      • ar
      • schema
        • cubrid
        • mssql
        • mysql
        • oci
        • pgsql
        • sqlite
    • i18n
      • gettext
    • logging
    • test
    • utils
    • validators
    • web
      • actions
      • auth
      • filters
      • form
      • helpers
      • renderers
      • services
      • widgets
        • captcha
        • pagers
  • Text
    • Highlighter
  • zii
    • behaviors
    • widgets
      • grid
      • jui

Classes

  • CApcCache
  • CCache
  • CDbCache
  • CDummyCache
  • CEAcceleratorCache
  • CFileCache
  • CMemCache
  • CMemCacheServerConfiguration
  • CRedisCache
  • CWinCache
  • CXCache
  • CZendDataCache
  • X2FileCache

Interfaces

  • ICache
  • ICacheDependency
  • Overview
  • Package
  • Class
  • Tree

Class CZendDataCache

CZendDataCache implements a cache application module based on the Zend Data Cache delivered with ZendServer.

To use this application component, the Zend Data Cache PHP extension must be loaded.

See CCache manual for common cache operations that are supported by CZendDataCache.

CComponent
Extended by CApplicationComponent implements IApplicationComponent
Extended by CCache implements ICache, ArrayAccess
Extended by CZendDataCache
Package: system\caching
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Steffen Dietz <steffo.dietz[at]googlemail[dot]com>
Located at x2engine/framework/caching/CZendDataCache.php
Methods summary
public
# init( )

Initializes this application component. This method is required by the IApplicationComponent interface. It checks the availability of Zend Data Cache.

Initializes this application component. This method is required by the IApplicationComponent interface. It checks the availability of Zend Data Cache.

Throws

CException
if Zend Data Cache extension is not loaded.

Overrides

CCache::init()
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

CException
if this method is not overridden by child classes

Overrides

CCache::getValue()
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

CException
if this method is not overridden by child classes

Overrides

CCache::setValue()
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

CException
if this method is not overridden by child classes

Overrides

CCache::addValue()
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

CException
if this method is not overridden by child classes

Overrides

CCache::deleteValue()
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

CException
if this method is not overridden by child classes

Since

1.1.5

Overrides

CCache::flushValues()
Methods inherited from CCache
add(), delete(), flush(), generateUniqueKey(), get(), getValues(), mget(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), set()
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 inherited from CCache
$hashKey, $keyPrefix, $serializer
Properties inherited from CApplicationComponent
$behaviors
Magic properties inherited from CApplicationComponent
$isInitialized
API documentation generated by ApiGen 2.8.0