Services_Ebay
[ class tree: Services_Ebay ] [ index: Services_Ebay ] [ all elements ]

Class: Services_Ebay_Cache

Source Location: /Services_Ebay-0.13.1/Services/Ebay/Cache.php

Class Overview


Base class for all caches


Author(s):

Variables

Methods


Child classes:

Services_Ebay_Cache_Filesystem
Very simple filesystem cache

Inherited Variables

Inherited Methods


Class Details

[line 10]
Base class for all caches

$Id$



[ Top ]


Class Variables

$expiry =  null

[line 24]

stores the expiry object
  • Access: protected

Type:   object


[ Top ]

$options = array()

[line 17]

options of the cache
  • Access: protected

Type:   array


[ Top ]



Method Detail

__construct (Constructor)   [line 31]

Services_Ebay_Cache __construct( array $options)

constructor
  • Access: public

Parameters:

array   $options     options for the cache

[ Top ]

isValid   [line 92]

void isValid( string $Type, integer $ts, array $props)

check the validity of the cache
  • Access: protected

Parameters:

string   $Type     type of the model
integer   $ts     time the cache has been created
array   $props     model properties

[ Top ]

load   [line 44]

array|boolean load( string $Type, string $Key, integer $DetailLevel)

load a model from cache
  • Abstract:
  • Access: public

Overridden in child classes as:

Services_Ebay_Cache_Filesystem::load()
load a model from cache

Parameters:

string   $Type     model type
string   $Key     primary key
integer   $DetailLevel     detail level

[ Top ]

setExpiry   [line 71]

void setExpiry( string $type, mixed $params)

set the expiry type

Services_Ebay allows custom expiry objects to check the validity of a cached model. This enables you to create a cache lifetime depending of the end of the auction or the version number of a category listing.

The following expiry types have been implemented:

  • Static

  • Access: public

Parameters:

string   $type     expiry type
mixed   $params     parameters for the expiry

[ Top ]

store   [line 55]

boolean store( string $Type, string $Key, integer $DetailLevel, array $Props)

store model data in the cache
  • Abstract:
  • Access: public

Overridden in child classes as:

Services_Ebay_Cache_Filesystem::store()
store model data in the cache

Parameters:

string   $Type     model type
string   $Key     primary key
integer   $DetailLevel     detail level
array   $Props     properties

[ Top ]


Documentation generated on Thu, 30 Aug 2012 02:30:05 +0000 by phpDocumentor 1.4.3. PEAR Logo Copyright © PHP Group 2004.