Modules

  1. –Kohana
    2. Debug
    3. I18n
    4. Kohana
    5. Kohana_Core
    6. Request
    7. Request_Client
    8. Request_Client_External
    9. Request_Client_Internal
    10. Response
    11. Route
    12. UTF8
    13. View
    14. –Cache
      1. Cache_Xcache
    15. +Configuration
      1. Config
      2. Config_File
      3. Config_Reader
    16. +Controller
      1. Controller
      2. Controller_REST
      3. Controller_Template
      4. Controller_Welcome
    17. +Exceptions
      1. HTTP_Exception
      2. HTTP_Exception_400
      3. HTTP_Exception_401
      4. HTTP_Exception_402
      5. HTTP_Exception_403
      6. HTTP_Exception_404
      7. HTTP_Exception_405
      8. HTTP_Exception_406
      9. HTTP_Exception_407
      10. HTTP_Exception_408
      11. HTTP_Exception_409
      12. HTTP_Exception_410
      13. HTTP_Exception_411
      14. HTTP_Exception_412
      15. HTTP_Exception_413
      16. HTTP_Exception_414
      17. HTTP_Exception_415
      18. HTTP_Exception_416
      19. HTTP_Exception_417
      20. HTTP_Exception_500
      21. HTTP_Exception_501
      22. HTTP_Exception_502
      23. HTTP_Exception_503
      24. HTTP_Exception_504
      25. HTTP_Exception_505
      26. Kohana_Exception
      27. Kohana_Request_Exception
      28. Kohana_View_Exception
      29. Validation_Exception
    18. +HTTP
      1. HTTP
      2. HTTP_Header
      3. HTTP_Header_Value
    19. +Helpers
      1. Arr
      2. CLI
      3. Cookie
      4. Date
      5. Feed
      6. File
      7. Form
      8. Fragment
      9. HTML
      10. Inflector
      11. Num
      12. Profiler
      13. Text
      14. URL
      15. Upload
    20. +Logging
      1. Log
      2. Log_File
      3. Log_StdErr
      4. Log_StdOut
      5. Log_Syslog
      6. Log_Writer
    21. +Models
      1. Model
    22. +Security
      1. Encrypt
      2. Security
      3. Valid
      4. Validation
    23. +Session
      1. Session
      2. Session_Cookie
      3. Session_Native
  2. +Kohana/Auth
    2. Auth
    3. Auth_File
    4. Auth_ORM
    5. Model_Auth_Role
    6. Model_Auth_User
    7. Model_Auth_User_Token
    8. Model_Role
    9. Model_User
    10. Model_User_Token
  3. +Kohana/Cache
    2. Cache
    3. Cache_Apc
    4. Cache_Eaccelerator
    5. Cache_File
    6. Cache_Memcache
    7. Cache_MemcacheTag
    8. Cache_Sqlite
    9. Cache_Wincache
    10. Kohana_Cache_Exception
    11. Kohana_Cache_GarbageCollect
    12. Kohana_Cache_Tagging
  4. +Kohana/Codebench
    2. Codebench
    3. +Controllers
      1. Controller_Codebench
    4. +Tests
      1. Bench_ArrCallback
      2. Bench_AutoLinkEmails
      3. Bench_DateSpan
      4. Bench_ExplodeLimit
      5. Bench_GruberURL
      6. Bench_LtrimDigits
      7. Bench_MDDoBaseURL
      8. Bench_MDDoImageURL
      9. Bench_MDDoIncludeViews
      10. Bench_StripNullBytes
      11. Bench_Transliterate
      12. Bench_URLSite
      13. Bench_UserFuncArray
      14. Bench_ValidColor
      15. Bench_ValidURL
  5. +Kohana/Database
    2. DB
    3. Database
    4. Database_Expression
    5. +Configuration
      1. Config_Database
    6. +Drivers
      1. Database_MySQL
      2. Database_PDO
    7. +Exceptions
      1. Database_Exception
    8. +Models
      1. Model_Database
    9. +Query
      1. Database_Query
      2. Database_Query_Builder
      3. Database_Query_Builder_Delete
      4. Database_Query_Builder_Insert
      5. Database_Query_Builder_Join
      6. Database_Query_Builder_Select
      7. Database_Query_Builder_Update
      8. Database_Query_Builder_Where
    10. +Query/Result
      1. Database_MySQL_Result
      2. Database_Result
      3. Database_Result_Cached
    11. +Session
      1. Session_Database
  6. +Kohana/Image
    2. Image
    3. +Drivers
      1. Image_GD
  7. +Kohana/ORM
    2. ORM
    3. ORM_Validation_Exception
  8. +Kohana/Userguide
    2. Kodoc
    3. Kodoc_Class
    4. Kodoc_Markdown
    5. Kodoc_Method
    6. Kodoc_Method_Param
    7. Kodoc_Property
    8. +Controllers
      1. Controller_Userguide
    9. +Undocumented
      1. Kodoc_Missing
  9. +[Unknown]
    2. HTTP_Interaction
    3. HTTP_Request
    4. HTTP_Response

Cache_Xcache
extends Kohana_Cache_Xcache
extends Cache
extends Kohana_Cache

Kohana Cache Xcache Driver

Requires Xcache http://xcache.lighttpd.net/

package
Kohana
category
Cache
author
Kohana Team
copyright
© 2009-2012 Kohana Team
license
http://kohanaphp.com/license

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

Constants

Properties

Methods

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 Config $_config

Methods

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

Delete a cache entry based on id

Parameters

  • string $id required - Id

Return Values

  • boolean

Source Code

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

public delete_all( ) (defined in Kohana_Cache_Xcache)

Delete all cache entries To use this method xcache.admin.enable_auth has to be Off in xcache.ini

Return Values

  • void

Source Code

?
public function delete_all()
{
    xcache_clear_cache(XC_TYPE_PHP, 0);
}

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

Retrieve a value based on an id

Parameters

  • string $id required - Id
  • string $default = NULL - Default [Optional] Default value to return if id not found

Return Values

  • mixed

Source Code

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

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

Set a value based on an id. Optionally add tags.

Parameters

  • string $id required - Id
  • string $data required - Data
  • integer $lifetime = NULL - Lifetime [Optional]

Return Values

  • boolean

Source Code

?
public function set($id, $data, $lifetime = NULL)
{
    if (NULL === $lifetime)
    {
        $lifetime = Arr::get($this->_config, 'default_expire', Cache::DEFAULT_EXPIRE);
    }
 
    return xcache_set($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

  • 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_Xcache)

Check for existence of the APC extension

Parameters

  • array $config required - Configuration

Tags

Source Code

?
protected function __construct(array $config)
{
    if ( ! extension_loaded('xcache'))
    {
        throw new Kohana_Cache_Exception('PHP Xcache 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);
}