PHP Class Jamm\Memory\MemcacheObject

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

Protected Properties

Property Type Description
$lock_key_prefix string
$memcache Jamm\Memory\IMemcacheDecorator
$prefix
$tag_prefix
$ttl_table_name string array (key=>ttl)

Public Methods

Method Description
__construct ( string $ID = '', string $host = 'localhost', integer $port = 11211 )
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 | array 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
getKeyTTL ( $key )
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 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 Only values of 'array' type will be selected
set_ID ( $ID )
unlock_key ( KeyAutoUnlocker $auto_unlocker ) : boolean Unlock key, locked by method 'lock_key'

Protected Methods

Method Description
delTTLOfKey ( $key, &$ttl_table )
getKeysOfTag ( $tag )
read_TTL_table ( )
save_TTL_table ( array $table ) : void
setKeyTTL ( $key, $ttl )
setMemcacheObject ( $host = 'localhost', $port = 11211 )
setTags ( string $key, array | string $tags ) : boolean
ttl_to_expiration ( $ttl )

Method Details

__construct() public method

public __construct ( string $ID = '', string $host = 'localhost', integer $port = 11211 )
$ID string Symbol "." will be replaced to "_"
$host string
$port integer

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 | array
$key string | array - keys
return boolean | array - if array of keys was passed, on error will be returned array of not deleted keys, or 'true' on success.

delTTLOfKey() protected method

protected delTTLOfKey ( $key, &$ttl_table )

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
public del_old ( ) : boolean
return boolean

getKeyTTL() public method

public getKeyTTL ( $key )

getKeysOfTag() protected method

protected getKeysOfTag ( $tag )

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 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 array: if $by_value is value in array, new element will be pushed to the end of array, if $by_value is key=>value array, 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
return integer | string | array new value of key

lock_key() public method

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.
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

read_TTL_table() protected method

protected read_TTL_table ( )

save() public method

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

save_TTL_table() protected method

protected save_TTL_table ( array $table ) : void
$table array
return void

select_fx() public method

Select from storage via callback function Only values of 'array' type will be selected
public select_fx ( callable $fx, boolean $get_array = false ) : mixed
$fx callable ($value_array,$key)
$get_array boolean
return mixed

setKeyTTL() protected method

protected setKeyTTL ( $key, $ttl )

setMemcacheObject() protected method

protected setMemcacheObject ( $host = 'localhost', $port = 11211 )

setTags() protected method

protected setTags ( string $key, array | string $tags ) : boolean
$key string
$tags array | string
return boolean

set_ID() public method

public set_ID ( $ID )

ttl_to_expiration() protected method

protected ttl_to_expiration ( $ttl )

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

$lock_key_prefix protected property

protected string $lock_key_prefix
return string

$memcache protected property

protected IMemcacheDecorator,Jamm\Memory $memcache
return Jamm\Memory\IMemcacheDecorator

$prefix protected property

protected $prefix

$tag_prefix protected property

protected $tag_prefix

$ttl_table_name protected property

array (key=>ttl)
protected string $ttl_table_name
return string