Overview

Packages

  • Cache

Classes

  • Horde_Cache
  • Horde_Cache_Exception
  • Horde_Cache_Storage_Apc
  • Horde_Cache_Storage_Base
  • Horde_Cache_Storage_Eaccelerator
  • Horde_Cache_Storage_File
  • Horde_Cache_Storage_Memcache
  • Horde_Cache_Storage_Mock
  • Horde_Cache_Storage_Null
  • Horde_Cache_Storage_Session
  • Horde_Cache_Storage_Sql
  • Horde_Cache_Storage_Stack
  • Horde_Cache_Storage_Xcache
  • Overview
  • Package
  • Class
  • Tree

Class Horde_Cache_Storage_Sql

This class provides cache storage in a SQL databsae.

The table structure for the cache is as follows:

CREATE TABLE horde_cache (
    cache_id          VARCHAR(32) NOT NULL,
    cache_timestamp   BIGINT NOT NULL,
    cache_data        LONGBLOB,
    (Or on PostgreSQL:)
    cache_data        TEXT,
    (Or on some other DBMS systems:)
    cache_data        IMAGE,

    PRIMARY KEY (cache_id)
);

Copyright 2007-2012 Horde LLC (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Horde_Cache_Storage_Base
Extended by Horde_Cache_Storage_Sql
Package: Cache
Category: Horde
License: LGPL 2.1
Author: Ben Klang ben@alkaloid.net
Author: Michael Slusarz slusarz@horde.org
Located at Horde/Cache/Storage/Sql.php
Methods summary
public
# __construct( array $params = array() )

Constructor.

Constructor.

Parameters

$params
Parameters: <pre><span class="php-quote">'db'</span> - (Horde_Db_Adapter) [REQUIRED] The DB instance. <span class="php-quote">'table'</span> - (string) The name of the cache table. <span class="php-keyword1">DEFAULT</span>: <span class="php-quote">'horde_cache'</span></pre>

Throws

Horde_Cache_Exception

Overrides

Horde_Cache_Storage_Base::__construct()
public
# __destruct( )

Destructor.

Destructor.

public mixed
# get( string $key, integer $lifetime = 0 )

Parameters

$key
Object ID to query.
$lifetime
Lifetime of the object in seconds.

Returns

mixed
Cached data, or false if none was found.
public
# set( string $key, mixed $data, integer $lifetime = 0 )

Parameters

$key
Object ID used as the caching key.
$data
Data to store in the cache.
$lifetime
<p>Object lifetime - i.e. the time before the data becomes available for garbage collection. If 0 will not be GC'd.</p>
public boolean
# exists( string $key, integer $lifetime = 0 )

Parameters

$key
Cache key to check.
$lifetime
Lifetime of the key in seconds.

Returns

boolean
Existence.
public boolean
# expire( string $key )

Parameters

$key
Cache key to expire.

Returns

boolean
Success or failure.
public
# clear( )

Throws

Horde_Cache_Exception
Methods inherited from Horde_Cache_Storage_Base
setLogger()
API documentation generated by ApiGen