Overview

Namespaces

  • Apptus
    • ESales
      • Connector
        • Report
        • Time
    • Util
      • Cache
  • PHP

Classes

  • ApcStateCache
  • ArrayStateCache
  • MemcachedStateCache
  • MemcacheStateCache
  • NoStateCache
  • PrefixStateCache
  • SQLite3StateCache

Interfaces

  • StateCache
  • Overview
  • Namespace
  • Class
  • Tree

Interface StateCache

Interface for a key based string cache.

Direct known implementers

Apptus\Util\Cache\ApcStateCache, Apptus\Util\Cache\ArrayStateCache, Apptus\Util\Cache\MemcachedStateCache, Apptus\Util\Cache\MemcacheStateCache, Apptus\Util\Cache\NoStateCache, Apptus\Util\Cache\PrefixStateCache, Apptus\Util\Cache\SQLite3StateCache
Namespace: Apptus\Util\Cache
Located at StateCache.php
Methods summary
public boolean
# add( string $key, string $value, integer $expire )

Add a non-existing entry to the cache.

Add a non-existing entry to the cache.

Parameters

$key
$value
$expire
maximum time, in seconds, this entry will be in the cache.

Returns

boolean
True on success, false on failure. Returns false if the key already exists.
public boolean
# delete( string $key )

Remove an entry from the cache.

Remove an entry from the cache.

Parameters

$key

Returns

boolean
True on success, false on failure.
public boolean|string
# get( string $key )

Get an entry from the cache.

Get an entry from the cache.

Parameters

$key

Returns

boolean|string
Value as a string or false if key was not found.
public array
# getMulti( array $keys )

Get several entries from the cache.

Get several entries from the cache.

Parameters

$keys
indexed array with the keys that should be fetched from the cache.

Returns

array
An associative array of key => value pairs for all keys found.
public boolean
# replace( string $key, string $value, integer $expire )

Replace an existing entry in the cache.

Replace an existing entry in the cache.

Parameters

$key
$value
$expire
maximum time, in seconds, this entry will be in the cache.

Returns

boolean
True on success, false on failure. Return false if key does not already exist.
public boolean
# set( string $key, string $value, integer $expire )

Set an entry in the cache.

Set an entry in the cache.

Parameters

$key
$value
$expire
maximum time, in seconds, this entry will be in the cache.

Returns

boolean
True on success, false on failure.
public boolean
# setMulti( array $items, integer $expire )

Set several entries in the cache.

Set several entries in the cache.

Parameters

$items
associative array of key => value pairs.
$expire
maximum time, in seconds, these entries will be in the cache.

Returns

boolean
True on success, false on failure.
Apptus ESales Connector PHP API documentation generated by ApiGen