RedisCache
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\RedisCache » CRedisCache (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
RedisCache implements a cache application component based on redis (opens new window).
RedisCache needs to be configured with {@link hostname}, {@link port} and {@link database} of the server to connect to. By default RedisCache assumes there is a redis server running on localhost at port 6379 and uses the database number 0.
RedisCache also supports the AUTH command (opens new window) of redis. When the server needs authentication, you can set the {@link password} property to authenticate with the server after connect.
The minimum required redis version is 2.0.0.
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
| $database (opens new window) | integer (opens new window) – The redis database to use. |
| $hashKey (opens new window) | boolean (opens new window) – Whether to md5-hash the cache key for normalization purposes. |
| $hostname (opens new window) | string (opens new window) – Hostname to use for connecting to the redis server. |
| $keyPrefix (opens new window) | string (opens new window) – A string prefixed to every cache key so that it is unique. |
| $options (opens new window) | integer (opens new window) – The options to pass to the flags parameter of stream_socket_client when connecting to the redis server. |
| $password (opens new window) | string (opens new window) – The password to use to authenticate with the redis server. |
| $port (opens new window) | integer (opens new window) – The port to use for connecting to the redis server. |
| $serializer (opens new window) | array (opens new window), boolean (opens new window) – The functions used to serialize and unserialize cached data. |
| $timeout (opens new window) | float (opens new window) – Timeout to use for connection to redis. |
# 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. |
| executeCommand() (opens new window) | Executes a redis command. |
| flush() (opens new window) | Deletes all values from cache. |
| get() (opens new window) | Retrieves a value from cache with a specified key. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| 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. |
# 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. |
| connect() | Establishes a connection to the redis server. It does nothing if the connection has already been established. |
| 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. |
| 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. |
# connect()
Establishes a connection to the redis server. It does nothing if the connection has already been established. Craft overrides this from Yii because the parent is explicitly checking for null in the password.
View source (opens new window)
Returns
Throws
Signature
protected null connect ( )