phpDocumentor Cotonti
[ class tree: Cotonti ] [ index: Cotonti ] [ all elements ]

Class: Memcache_driver

Source Location: /cache.php

Class Memcache_driver

Class Overview

Memcache distributed persistent cache driver implementation. Give it a higher priority if a cluster of webservers is used and Memcached is running via TCP/IP between them.

In other circumstances this only should be used if no APC/eAccelerator/XCache available, keeping in mind that File_cache might be still faster.

Located in /cache.php [line 739]

Dynamic_cache_driver
   |
   --Temporary_cache_driver
      |
      --Memcache_driver
Author(s):
  • trustmaster
Information Tags:

Properties

Methods

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

Inherited From Temporary_cache_driver

Temporary_cache_driver::dec()
Decrements counter value
Temporary_cache_driver::get_info()
Returns information about memory usage if available.
Temporary_cache_driver::get_ini_size()
Gets a size limit from php.ini
Temporary_cache_driver::inc()
Increments counter value

Inherited From Dynamic_cache_driver

Dynamic_cache_driver::store()
Stores data as object image in cache

[ Top ]
Property Summary
int   $compressed   Compression flag
Memcache   $memcache   PHP Memcache instance

[ Top ]
Method Summary
Memcache_driver   __construct()   Creates an object and establishes Memcached server connection
void   clear()  
void   dec()  
void   exists()  
void   get()  
void   get_info()  
void   inc()  
void   remove()  
void   store()  

[ Top ]
Properties
int   $compressed = true [line 750]

Compression flag

API Tags:
Access:  protected


[ Top ]
Memcache   $memcache = NULL [line 745]

PHP Memcache instance

API Tags:
Access:  protected


[ Top ]
Methods
Constructor __construct  [line 760]

  Memcache_driver __construct( [string $host = 'localhost'], [int $port = 11211], [bool $persistent = true], [bool $compressed = true]  )

Creates an object and establishes Memcached server connection

Parameters:
string   $host:  Memcached host
int   $port:  Memcached port
bool   $persistent:  Use persistent connection
bool   $compressed:  Use compression

API Tags:
Access:  public


[ Top ]
clear  [line 770]

  void clear( [ $realm = '']  )

Parameters:
   $realm: 

API Tags:
See:  Cache_driver::clear()
Access:  public


[ Top ]
dec  [line 786]

  void dec( $id, [ $realm = COT_DEFAULT_REALM], [ $value = 1]  )

Parameters:
   $id: 
   $realm: 
   $value: 

API Tags:
See:  Temporary_cache_driver::dec()
Access:  public


Redefinition of:
Temporary_cache_driver::dec()
Decrements counter value

[ Top ]
exists  [line 801]

  void exists( $id, [ $realm = COT_DEFAULT_REALM]  )

Parameters:
   $id: 
   $realm: 

API Tags:
See:  Cache_driver::exists()
Access:  public


[ Top ]
get  [line 809]

  void get( $id, [ $realm = COT_DEFAULT_REALM]  )

Parameters:
   $id: 
   $realm: 

API Tags:
See:  Cache_driver::get()
Access:  public


[ Top ]
get_info  [line 817]

  void get_info( )


API Tags:
See:  Temporary_cache_driver::get_info()
Access:  public


Redefinition of:
Temporary_cache_driver::get_info()
Returns information about memory usage if available.

[ Top ]
inc  [line 830]

  void inc( $id, [ $realm = COT_DEFAULT_REALM], [ $value = 1]  )

Parameters:
   $id: 
   $realm: 
   $value: 

API Tags:
See:  Temporary_cache_driver::inc()
Access:  public


Redefinition of:
Temporary_cache_driver::inc()
Increments counter value

[ Top ]
remove  [line 845]

  void remove( $id, [ $realm = COT_DEFAULT_REALM]  )

Parameters:
   $id: 
   $realm: 

API Tags:
See:  Cache_driver::remove()
Access:  public


[ Top ]
store  [line 853]

  void store( $id, $data, [ $realm = COT_DEFAULT_REALM], [ $ttl = COT_DEFAULT_TTL]  )

Parameters:
   $id: 
   $data: 
   $realm: 
   $ttl: 

API Tags:
See:  Dynamic_cache_driver::store()
Access:  public


Redefinition of:
Dynamic_cache_driver::store()
Stores data as object image in cache

[ Top ]

Documentation generated on Fri, 19 Mar 2010 17:45:21 +0000 by phpDocumentor 1.4.3