yiisoft/yii2-redis API Documentation 2.0

This is the API Documentation for the yiisoft/yii2-redis extension. Here you will find detailed information about all classes provided by this extension. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 2.0 of the extension. You can use the dropdown menu on the top right to switch between versions.

Class Description
yii\redis\ActiveQuery ActiveQuery represents a query associated with an Active Record class.
yii\redis\ActiveRecord ActiveRecord is the base class for classes representing relational data in terms of objects.
yii\redis\Cache Redis Cache implements a cache application component based on redis key-value store.
yii\redis\Connection The redis connection class is used to establish a connection to a redis server.
yii\redis\LuaScriptBuilder LuaScriptBuilder builds lua scripts used for retrieving data from redis.
yii\redis\Mutex Redis Mutex implements a mutex component using redis as the storage medium.
yii\redis\Session Redis Session implements a session component using redis as the storage medium.
yii\redis\SocketException SocketException indicates a socket connection failure in yii\redis\Connection.