Skip to content
CakePHP Redis Session Store
Branch: master
Clone or download
Pull request Compare This branch is 5 commits ahead, 2 commits behind m3nt0r:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
README.md
RedisSession.php

README.md

Redis Session Store for CakePHP 2

This class can be used in CakePHP and saves session data into Redis, an open source key-value store.

Installation

  1. Place the RedisSession.php into app/Model/DataSource/Session/.

  2. Open app/Config/core.php and find 'Session'.

  3. Add the value of the Configure:

    Configure::write('Session.handler', array('engine' => 'RedisSession'));

That's it.

Usage

Redis on localhost

If you have a default Redis installation running on localhost you don't need to change anything. It will connect and take over.

To confirm that it does indeed write to Redis you can use redis-cli monitor and refresh your browser. You should see some GET and SETEX calls.

Redis on a foreign host

If you run on a different host you have to add two config settings in your core.php to setup the connection.

Configure::write('RedisSession.hostname', 'some.host.name');
Configure::write('RedisSession.port', 1337);//port
Configure::write('RedisSession.password', 'your password');// password
Configure::write('RedisSession.database', 0);// database number

About

I've ran the core component tests with this store enabled (CakePHP 2.1.3).

The class comes with iRedis, a very lightweight Redis Library by Dan Horrigan. The library is embedded inside the source file, wrapped in a class_exists() condition. If you want to use your own version make sure to include it early or just delete the iRedis block. I leave that up to you. I wanted to keep this store small.

Garbage collection is handled by Redis. I use SETEX (expire) when writing to the store. The key will delete itself when the session expires. You can verify the remaining time with TTL [key].

I have no complex key-namespacing going on. The key however is prefixed with the session name ('Session.cookie' value) followed by the session_id()

The cookie.path is hardcoded to '/'

Enjoy!

You can’t perform that action at this time.