<p>Single-value key is a basic Redis structure. Rediska provides object-oriented way to work with keys.</p>
<h3>Example</h3>
<code>
// Initialize key with name "keyName"
require_once 'Rediska/Key.php';
$key = new Rediska_Key('keyName');
// Set value
$key->setValue('value');
// Get value
$value = $key->getValue();
// Delete key
$key->delete();
</code>
<h3>"getOrSetValue" magic method</h3>
<p>Also <span class="pre">Rediska_Key</span> provides a handy proxying method to set new value if key is not currently set:</p>
<code>
// Initialize key with expire 2 minutes
require_once 'Rediska/Key.php';
$key = new Rediska_Key('keyName', 60 * 2);
// Old way
$value = $key->getValue();
if ($value === null) {
$value = $exampleObject->getNewValue();
$key->setValue($value);
}
// New way
$value = $key->getOrSetValue($exampleObject)->getNewValue();
// You can also get and set value from object's propery
$value = $key->getOrSetValue($exampleObject)->newValue;
// or set the returning value of function (time() for example)
$value = $key->getOrSetValue()->time();
</code>
<h3>All methods</h3>
<code>
/**
* Construct key
*
* @param string $name Key name
* @param integer $expire Expire time in seconds
*/
public function __construct($name, $expire = null)
/**
* Set key value
*
* @param $value
* @return boolean
*/
public function setValue($value)
/**
* Get key value
*
* @return mixin
*/
public function getValue()
/**
* Get value, if value not present set it from chain method
*
* @param $object Object of chain method
*/
public function getOrSetValue($object = null)
/**
* Delete key
*
* @return boolean
*/
public function delete()
/**
* Exists in db
*
* @return boolean
*/
public function isExists()
/**
* Get key type
*
* @see Rediska#getType
* @return string
*/
public function getType()
/**
* Rename key
*
* @param string $newName
* @param boolean $overwrite
* @return boolean
*/
public function rename($newName, $overwrite = true)
/**
* Expire key
*
* @param integer $seconds
* @return boolean
*/
public function expire($seconds)
/**
* Get key lifetime
*
* @return integer
*/
public function getLifetime()
/**
* Move key to other Db
*
* @see Rediska#moveToDb
* @param integer $dbIndex
* @return boolean
*/
public function moveToDb($dbIndex)
/**
* Get key name
*
* @return string
*/
public function getName()
/**
* Set key name
*
* @param string $name
* @return Rediska_Key_Abstract
*/
public function setName($name)
/**
* Set Rediska instance
*
* @param Rediska $rediska
* @return Rediska_Key_Abstract
*/
public function setRediska(Rediska $rediska)
/**
* Get Rediska instance
*
* @return Rediska
*/
public function getRediska()
</code>
single-value-keys
0
2010-01-21T21:47:47Z
10
16
9
17
Single-value keys
2010-01-23T13:17:21Z
1