Class: Doctrine_Cache_Memcache

Source Location: /Doctrine/Cache/Memcache.php

Class Doctrine_Cache_Memcache

Class Overview

Doctrine_Cache_Memcache

Located in /Doctrine/Cache/Memcache.php [line 34]

Doctrine_Cache_Driver
   |
   --Doctrine_Cache_Memcache
Author(s): Information Tags:
Version:  $Revision: 1080 $
Link:  www.phpdoctrine.com
Since:  1.0
License:  LGPL

Properties

Methods

[ Top ]
Inherited Properties, Constants, and Methods
Inherited Properties Inherited Methods Inherited Constants

Inherited From Doctrine_Cache_Driver

Doctrine_Cache_Driver::$_options

Inherited From Doctrine_Cache_Driver

Doctrine_Cache_Driver::__construct()
constructor
Doctrine_Cache_Driver::getOption()
getOption
Doctrine_Cache_Driver::setOption()
setOption

[ Top ]
Property Summary
Memcache   $_memcache  

[ Top ]
Method Summary
Doctrine_Cache_Memcache   __construct()   constructor
mixed   contains()   Test if a cache is available or not (for the given id)
boolean   delete()   Remove a cache record
string   fetch()   Test if a cache is available for the given id and (if yes) return it (false else)
boolean   save()   Save some string datas into a cache record

[ Top ]
Properties
Memcache   $_memcache = null [line 39]
API Tags:
Access:  protected


[ Top ]
Methods
Constructor __construct  [line 45]

  Doctrine_Cache_Memcache __construct( [array $options = array()]  )

constructor

Parameters:
array   $options:  associative array of cache driver options

API Tags:
Access:  public


Redefinition of:
Doctrine_Cache_Driver::__construct()
constructor

[ Top ]
contains  [line 98]

  mixed contains( string $id  )

Test if a cache is available or not (for the given id)

Parameters:
string   $id:  cache id

API Tags:
Return:  false (a cache is not available) or "last modified" timestamp (int) of the available cache record
Access:  public


[ Top ]
delete  [line 128]

  boolean delete( string $id  )

Remove a cache record

Parameters:
string   $id:  cache id

API Tags:
Return:  true if no problem
Access:  public


[ Top ]
fetch  [line 82]

  string fetch( string $id, [boolean $testCacheValidity = true]  )

Test if a cache is available for the given id and (if yes) return it (false else)

Note : return value is always "string" (unserialization is done by the core not by the backend)

Parameters:
string   $id:  cache id
boolean   $testCacheValidity:  if set to false, the cache validity won't be tested

API Tags:
Return:  cached datas (or false)
Access:  public


[ Top ]
save  [line 112]

  boolean save( string $id, string $data, [int $lifeTime = false]  )

Save some string datas into a cache record

Note : $data is always saved as a string

Parameters:
string   $data:  data to cache
string   $id:  cache id
int   $lifeTime:  if != false, set a specific lifetime for this cache record (null => infinite lifeTime)

API Tags:
Return:  true if no problem
Access:  public


[ Top ]