xpdo/cache/xpdomemcache.class.php

Classes

package: xpdo
subpackage: cache
Classes: xPDOMemCache

Description

Provides a memcache-powered xPDOCache implementation.

This requires the memcache extension for PHP.

\xPDOMemCache
jump to top

Extends from: \xPDOCache
package: xpdo
subpackage: cache
Properties: $memcache
Methods: __construct; add; delete; flush; get; replace; set

Description

Provides a memcache-powered xPDOCache implementation.

This requires the memcache extension for PHP.

Properties

$memcache
jump to class

$memcache = 'null'

Details

visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
           $xpdo,  $options
              =
              array
          )
        
        :

Arguments

$xpdo
$options

Details

visibility: public
final: false
static: false

add
jump to class

add(
          string $key, string $var, integer $expire
              =
              0, array $options
              =
              array
          )
        
        :
        boolean

Adds a value to the cache.

Arguments

$key: string
A unique key identifying the item being set.
$var: string
A reference to the PHP variable representing the item.
$expire: integer
The amount of seconds for the variable to expire in.
$options: array
Additional options for the operation.

Output

boolean: True if successful

Details

visibility: public
final: false
static: false

delete
jump to class

delete(
          string $key, array $options
              =
              array
          )
        
        :
        boolean

Deletes a value from the cache.

Arguments

$key: string
A unique key identifying the item being deleted.
$options: array
Additional options for the operation.

Output

boolean: True if successful

Details

visibility: public
final: false
static: false

flush
jump to class

flush(
          array $options
              =
              array
          )
        
        :
        boolean

Flush all values from the cache.

Arguments

$options: array
Additional options for the operation.

Output

boolean: True if successful.

Details

visibility: public
final: false
static: false

get
jump to class

get(
          string $key, array $options
              =
              array
          )
        
        :
        mixed

Gets a value from the cache.

Arguments

$key: string
A unique key identifying the item to fetch.
$options: array
Additional options for the operation.

Output

mixed: The value retrieved from the cache.

Details

visibility: public
final: false
static: false

replace
jump to class

replace(
          string $key, string $var, integer $expire
              =
              0, array $options
              =
              array
          )
        
        :
        boolean

Replaces a value in the cache.

Arguments

$key: string
A unique key identifying the item being set.
$var: string
A reference to the PHP variable representing the item.
$expire: integer
The amount of seconds for the variable to expire in.
$options: array
Additional options for the operation.

Output

boolean: True if successful

Details

visibility: public
final: false
static: false

set
jump to class

set(
          string $key, string $var, integer $expire
              =
              0, array $options
              =
              array
          )
        
        :
        boolean

Sets a value in the cache.

Arguments

$key: string
A unique key identifying the item being set.
$var: string
A reference to the PHP variable representing the item.
$expire: integer
The amount of seconds for the variable to expire in.
$options: array
Additional options for the operation.

Output

boolean: True if successful

Details

visibility: public
final: false
static: false

xpdo/cache/xpdomemcache.class.php

Description

\xPDOMemCachejump to top

Description

Properties

$memcachejump to class

Details

Methods

__constructjump to class

Arguments

Details

addjump to class

Arguments

Output

Details

deletejump to class

Arguments

Output

Details

flushjump to class

Arguments

Output

Details

getjump to class

Arguments

Output

Details

replacejump to class

Arguments

Output

Details

setjump to class

Arguments

Output

Details

\xPDOMemCache
jump to top

$memcache
jump to class

__construct
jump to class

add
jump to class

delete
jump to class

flush
jump to class

get
jump to class

replace
jump to class

set
jump to class