Modules

Cache_Eaccelerator
extends Kohana_Cache_Eaccelerator
extends Cache
extends Kohana_Cache

Kohana Cache Eaccelerator driver. Provides an opcode based driver for the Kohana Cache library.

Configuration example

Below is an example of an eaccelerator server configuration.

return array(
     'eaccelerator' => array(                          // Driver group
             'driver'         => 'eaccelerator',         // using Eaccelerator driver
      ),
)

In cases where only one cache group is required, if the group is named default there is no need to pass the group name when instantiating a cache instance.

General cache group configuration settings

Below are the settings available to all types of cache driver.

Name Required Description
driver YES (string) The driver type to use

System requirements

  • Kohana 3.0.x
  • PHP 5.2.4 or greater
  • Eaccelerator PHP extension
package
Kohana/Cache
category
Base
author
Kohana Team
copyright
© 2009-2010 Kohana Team
license
http://kohanaphp.com/license

Class declared in MODPATH/cache/classes/cache/eaccelerator.php on line 3.

Constants

DEFAULT_EXPIRE

integer 3600

Properties

public static string $default

default driver to use

string(4) "file"

public static Kohana_Cache $instances

instances

array(0) 

protected Kohana_Config $_config

Methods

public delete( string $id ) (defined in Kohana_Cache_Eaccelerator)

Delete a cache entry based on id

// Delete 'foo' entry from the eaccelerator group
Cache::instance('eaccelerator')->delete('foo');

Parameters

  • string $id required - Id to remove from cache

Return Values

  • boolean

Source Code

public function delete($id)
{
	return eaccelerator_rm($this->_sanitize_id($id));
}

public delete_all( ) (defined in Kohana_Cache_Eaccelerator)

Delete all cache entries.

Beware of using this method when using shared memory cache systems, as it will wipe every entry within the system for all clients.

// Delete all cache entries in the eaccelerator group
Cache::instance('eaccelerator')->delete_all();

Return Values

  • boolean

Source Code

public function delete_all()
{
	return eaccelerator_clean();
}

public get( string $id [, string $default = NULL ] ) (defined in Kohana_Cache_Eaccelerator)

Retrieve a cached value entry by id.

// Retrieve cache entry from eaccelerator group
$data = Cache::instance('eaccelerator')->get('foo');

// Retrieve cache entry from eaccelerator group and return 'bar' if miss
$data = Cache::instance('eaccelerator')->get('foo', 'bar');

Parameters

  • string $id required - Id of cache to entry
  • string $default = NULL - Default value to return if cache miss

Tags

Return Values

  • mixed

Source Code

public function get($id, $default = NULL)
{
	return (($data = eaccelerator_get($this->_sanitize_id($id))) === FALSE) ? $default : $data;
}

public set( string $id , string $data [, integer $lifetime = NULL ] ) (defined in Kohana_Cache_Eaccelerator)

Set a value to cache with id and lifetime

$data = 'bar';

// Set 'bar' to 'foo' in eaccelerator group, using default expiry
Cache::instance('eaccelerator')->set('foo', $data);

// Set 'bar' to 'foo' in eaccelerator group for 30 seconds
Cache::instance('eaccelerator')->set('foo', $data, 30);

Parameters

  • string $id required - Id of cache entry
  • string $data required - Data to set to cache
  • integer $lifetime = NULL - Lifetime in seconds

Return Values

  • boolean

Source Code

public function set($id, $data, $lifetime = NULL)
{
	if ($lifetime === NULL)
	{
		$lifetime = time() + Arr::get($this->_config, 'default_expire', Cache::DEFAULT_EXPIRE);
	}

	return eaccelerator_put($this->_sanitize_id($id), $data, $lifetime);
}

public __clone( ) (defined in Kohana_Cache)

Overload the __clone() method to prevent cloning

Tags

Return Values

  • void

Source Code

public function __clone()
{
	throw new Kohana_Cache_Exception('Cloning of Kohana_Cache objects is forbidden');
}

public static instance( [ string $group = NULL ] ) (defined in Kohana_Cache)

Creates a singleton of a Kohana Cache group. If no group is supplied the default cache group is used.

// Create an instance of the default group
$default_group = Cache::instance();

// Create an instance of a group
$foo_group = Cache::instance('foo');

// Access an instantiated group directly
$foo_group = Cache::$instances['default'];

Parameters

  • string $group = NULL - The name of the cache group to use [Optional]

Tags

Return Values

  • Kohana_Cache

Source Code

public static function instance($group = NULL)
{
	// If there is no group supplied
	if ($group === NULL)
	{
		// Use the default setting
		$group = Cache::$default;
	}

	if (isset(Cache::$instances[$group]))
	{
		// Return the current group if initiated already
		return Cache::$instances[$group];
	}

	$config = Kohana::config('cache');

	if ( ! $config->offsetExists($group))
	{
		throw new Kohana_Cache_Exception('Failed to load Kohana Cache group: :group', array(':group' => $group));
	}

	$config = $config->get($group);

	// Create a new cache type instance
	$cache_class = 'Cache_'.ucfirst($config['driver']);
	Cache::$instances[$group] = new $cache_class($config);

	// Return the instance
	return Cache::$instances[$group];
}

protected __construct( array $config ) (defined in Kohana_Cache_Eaccelerator)

Check for existence of the eAccelerator extension This method cannot be invoked externally. The driver must be instantiated using the Cache::instance() method.

Parameters

  • array $config required - Configuration

Tags

Source Code

protected function __construct(array $config)
{
	if ( ! extension_loaded('eaccelerator'))
	{
		throw new Kohana_Cache_Exception('PHP eAccelerator extension is not available.');
	}

	parent::__construct($config);
}

protected _sanitize_id( string $id ) (defined in Kohana_Cache)

Replaces troublesome characters with underscores.

// Sanitize a cache id
$id = $this->_sanitize_id($id);

Parameters

  • string $id required - Id of cache to sanitize

Return Values

  • string

Source Code

protected function _sanitize_id($id)
{
	// Change slashes and spaces to underscores
	return str_replace(array('/', '\\', ' '), '_', $id);
}