PHP Class Jamm\Memory\APCObject

Inheritance: extends MemoryObject, implements Jamm\Memory\IMemoryStorage
Show file Open project: jamm/memory Class Usage Examples

Protected Properties

Property Type Description
$defragmentation_prefix
$lock_key_prefix because I love my wife Katya :)
$prefix
$tags_prefix

Public Methods

Method Description
__construct ( string $ID = '' )
add ( string $key, mixed $value, integer $ttl = 259200, array | string $tags = NULL ) : boolean Add value to memory storage, only if this key does not exists (or false will be returned).
del ( string | array $key ) : boolean Delete key or array of keys from storage
del_by_tags ( array | string $tags ) : boolean Delete keys by tags
del_old ( ) : boolean Delete old (by ttl) variables from storage It's very important function to prevent APC's cache fragmentation.
getKeyTTL ( string $key ) : integer Returns, how many seconds left till key expiring.
get_ID ( )
get_keys ( ) Return array of all stored keys
get_stat ( ) : array
increment ( string $key, mixed $by_value = 1, integer $limit_keys_count, integer $ttl = 259200 ) : integer | string | array Increment value of the key
lock_key ( mixed $key, mixed &$auto_unlocker_variable ) : boolean Get exclusive mutex for key. Key will be still accessible to read and write, but another process can exclude dog-pile effect, if before updating the key he will try to get this mutex.
read ( string | array $key, mixed &$ttl_left ) : mixed Read data from memory storage
save ( string $key, mixed $value, integer $ttl = 259200, array | string $tags = NULL ) : boolean Save variable in memory storage
select_fx ( callable $fx, boolean $get_array = false ) : mixed Select from storage via callback function
set_ID ( $ID )
set_tags ( string $key, string | array $tags, integer $ttl = self::max_ttl ) : boolean Associate tags with keys
unlock_key ( KeyAutoUnlocker $auto_unlocker ) : boolean Unlock key, locked by method 'lock_key'

Protected Methods

Method Description
del_old_cached ( )

Method Details

__construct() public method

public __construct ( string $ID = '' )
$ID string

add() public method

Add value to memory storage, only if this key does not exists (or false will be returned).
public add ( string $key, mixed $value, integer $ttl = 259200, array | string $tags = NULL ) : boolean
$key string
$value mixed
$ttl integer
$tags array | string
return boolean

del() public method

Delete key or array of keys from storage
public del ( string | array $key ) : boolean
$key string | array
return boolean

del_by_tags() public method

Delete keys by tags
public del_by_tags ( array | string $tags ) : boolean
$tags array | string - tag or array of tags
return boolean

del_old() public method

Delete old (by ttl) variables from storage It's very important function to prevent APC's cache fragmentation.
public del_old ( ) : boolean
return boolean

del_old_cached() protected method

protected del_old_cached ( )

getKeyTTL() public method

Returns, how many seconds left till key expiring.
public getKeyTTL ( string $key ) : integer
$key string
return integer

get_ID() public method

public get_ID ( )

get_keys() public method

Return array of all stored keys
public get_keys ( )

get_stat() public method

public get_stat ( ) : array
return array

increment() public method

Increment value of the key
public increment ( string $key, mixed $by_value = 1, integer $limit_keys_count, integer $ttl = 259200 ) : integer | string | array
$key string
$by_value mixed if stored value is an array: if $by_value is a value in array, new element will be pushed to the end of array, if $by_value is a key=>value array, new key=>value pair will be added (or updated)
$limit_keys_count integer - maximum count of elements (used only if stored value is array)
$ttl integer - set time to live for key
return integer | string | array new value of key

lock_key() public method

Example: Process 1 reads key simultaneously with Process 2. Value of this key are too old, so Process 1 going to refresh it. Simultaneously with Process 2. But both of them trying to lock_key, and Process 1 only will refresh value of key (taking it from database, e.g.), and Process 2 can decide, what he want to do - use old value and not spent time to database, or something else.
public lock_key ( mixed $key, mixed &$auto_unlocker_variable ) : boolean
$key mixed
$auto_unlocker_variable mixed - pass empty, just declared variable
return boolean

read() public method

Read data from memory storage
public read ( string | array $key, mixed &$ttl_left ) : mixed
$key string | array (string or array of string keys)
$ttl_left mixed = (ttl - time()) of key. Use to exclude dog-pile effect, with lock/unlock_key methods.
return mixed

save() public method

Save variable in memory storage
public save ( string $key, mixed $value, integer $ttl = 259200, array | string $tags = NULL ) : boolean
$key string
$value mixed
$ttl integer - time to live (store) in seconds
$tags array | string - array of tags for this key
return boolean

select_fx() public method

Select from storage via callback function
public select_fx ( callable $fx, boolean $get_array = false ) : mixed
$fx callable ($value_array,$key)
$get_array boolean
return mixed

set_ID() public method

public set_ID ( $ID )

set_tags() public method

Associate tags with keys
public set_tags ( string $key, string | array $tags, integer $ttl = self::max_ttl ) : boolean
$key string
$tags string | array
$ttl integer
return boolean

unlock_key() public method

Unlock key, locked by method 'lock_key'
public unlock_key ( KeyAutoUnlocker $auto_unlocker ) : boolean
$auto_unlocker KeyAutoUnlocker
return boolean

Property Details

$defragmentation_prefix protected property

protected $defragmentation_prefix

$lock_key_prefix protected property

because I love my wife Katya :)
protected $lock_key_prefix

$prefix protected property

protected $prefix

$tags_prefix protected property

protected $tags_prefix