DbCache
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\DbCache » CDbCache (opens new window) » CCache (opens new window) » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
- ArrayAccess (opens new window),
IApplicationComponent,ICache - Since
- 2.0
DbCache implements a cache application component by storing cached data in a database.
DbCache stores cache data in a DB table named {@link cacheTableName}. If the table does not exist, it will be automatically created.
DbCache relies on PDO (opens new window) to access database. By default, it will use the database connection information stored in your craft/config/db.php file.
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $autoCreateCacheTable (opens new window) | boolean (opens new window) – Whether the cache DB table should be created automatically if it does not exist. |
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
| $cacheTableName (opens new window) | string (opens new window) – Name of the DB table to store cache content. |
| $connectionID (opens new window) | string (opens new window) – The ID of the {@link CDbConnection} application component. |
| $hashKey (opens new window) | boolean (opens new window) – Whether to md5-hash the cache key for normalization purposes. |
| $keyPrefix (opens new window) | string (opens new window) – A string prefixed to every cache key so that it is unique. |
| $serializer (opens new window) | array (opens new window), boolean (opens new window) – The functions used to serialize and unserialize cached data. |
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __get() (opens new window) | Returns a property value, an event handler list or a behavior based on its name. |
| __isset() (opens new window) | Checks if a property value is null. |
| __set() (opens new window) | Sets value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| add() (opens new window) | Stores a value identified by a key into cache if the cache does not contain this key. |
| asa() (opens new window) | Returns the named behavior object. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| attachEventHandler() (opens new window) | Attaches an event handler to an event. |
| canGetProperty() (opens new window) | Determines whether a property can be read. |
| canSetProperty() (opens new window) | Determines whether a property can be set. |
| delete() (opens new window) | Deletes a value with the specified key from cache |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| detachEventHandler() (opens new window) | Detaches an existing event handler. |
| disableBehavior() (opens new window) | Disables an attached behavior. |
| disableBehaviors() (opens new window) | Disables all behaviors attached to this component. |
| enableBehavior() (opens new window) | Enables an attached behavior. |
| enableBehaviors() (opens new window) | Enables all behaviors attached to this component. |
| evaluateExpression() (opens new window) | Evaluates a PHP expression or callback under the context of this component. |
| flush() (opens new window) | Deletes all values from cache. |
| get() (opens new window) | Retrieves a value from cache with a specified key. |
| getDbConnection() | |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getGCProbability() (opens new window) | |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| hasEvent() (opens new window) | Determines whether an event is defined. |
| hasEventHandler() (opens new window) | Checks whether the named event has attached handlers. |
| hasProperty() (opens new window) | Determines whether a property is defined. |
| init() (opens new window) | Initializes the application component. |
| mget() (opens new window) | Retrieves multiple values from cache with the specified keys. |
| offsetExists() (opens new window) | Returns whether there is a cache entry with a specified key. |
| offsetGet() (opens new window) | Retrieves the value from cache with a specified key. |
| offsetSet() (opens new window) | Stores the value identified by a key into cache. |
| offsetUnset() (opens new window) | Deletes the value with the specified key from cache This method is required by the interface ArrayAccess. |
| raiseEvent() (opens new window) | Raises an event. |
| set() (opens new window) | Stores a value identified by a key into cache. |
| setDbConnection() (opens new window) | Sets the DB connection used by the cache component. |
| setGCProbability() (opens new window) |
# getDbConnection()
Signature
public Craft\DbConnection getDbConnection ( )
# Protected Methods
| Method | Description |
|---|---|
| addValue() (opens new window) | Stores a value identified by a key into cache if the cache does not contain this key. |
| createCacheTable() | |
| deleteValue() (opens new window) | Deletes a value with the specified key from cache This method should be implemented by child classes to delete the data from actual cache storage. |
| flushValues() (opens new window) | Deletes all values from cache. |
| gc() (opens new window) | Removes the expired data values. |
| generateUniqueKey() (opens new window) | |
| getValue() (opens new window) | Retrieves a value from cache with a specified key. |
| getValues() (opens new window) | Retrieves multiple values from cache with the specified keys. |
| setValue() (opens new window) | Stores a value identified by a key in cache. |
# createCacheTable()
View source (opens new window)
Arguments
$db(Craft\DbConnection)$tableName(string (opens new window))
Signature
protected void createCacheTable ( $db, $tableName )