Skip to content

Oefenweb/cakephp-redis

Repository files navigation

Redis plugin for CakePHP

Build Status PHP 7 ready Coverage Status Packagist downloads Code Climate Scrutinizer Code Quality

Redis (DataSource) Plugin for CakePHP

Requirements

  • CakePHP 2.9.0 or greater.
  • PHP 7.0.0 or greater.
  • PhpRedis.

Installation

Clone

  • Clone/Copy the files in this directory into app/Plugin/Redis

Composer

  • Ensure require is present in composer.json. This will install the plugin into app/Plugin/Redis:
{
	"require": {
		"oefenweb/cakephp-redis": "dev-master"
	}
}

Configuration

  • Ensure the plugin is loaded in app/Config/bootstrap.php by calling:
CakePlugin::load('Redis');
  • Ensure the plugin is configured in app/Config/database.php by specifying:
<?php
class DATABASE_CONFIG {

	public $redis = [
		'datasource' => 'Redis.RedisSource',
		'host' => '127.0.0.1',
		'port' => 6379,
		'password' => '',
		'database' => 0,
		'timeout' => 0,
		'persistent' => false,
		'unix_socket' => '',
		'prefix' => '',
	];

Usage

Get a (connected / configured) Redis instance:

<?php
App::uses('ConnectionManager', 'Model');

$Redis = ConnectionManager::getDataSource('redis');

Call Redis's ping command:

$Redis->ping();