K2hash::remove
Removes the key
Description
public bool K2hash::remove ( string $key [, string $subkey ] )
Removes the key.
Parameters
- key
Specifies the key to remove. - subkey
Specifies the key associated with the key.
Return Values
Returns true on success or false on failure.
Examples
- Example 1 - Removes the key
<?php
$k2hash = new K2hash();
$k2hash->openMem();
$k2hash->setValue("test1", "value");
$k2hash->setValue("sub1", "sub-value");
$k2hash->addSubkey("test1", "sub1");
$k2hash->remove("test1");
var_dump($k2hash->getValue("test1"));
var_dump($k2hash->getValue("sub1"));
?>
The above example will output:
bool(false)
string(9) "sub-value"
- Example 2 - Remove the keys linked with a key
<?php
$k2hash = new K2hash();
$k2hash->openMem();
$k2hash->setValue("test1", "value");
$k2hash->setValue("sub1", "sub-value");
$k2hash->addSubkey("test1", "sub1");
$k2hash->remove("test1", "sub1");
var_dump($k2hash->getValue("test1"));
var_dump($k2hash->getValue("sub1"));
?>
The above example will output:
string(5) "value"
bool(false)
See Also
- K2hash::removeAll - Removes the key and the keys associated with the key
- K2hash::setValue - Sets the value associated with the key