K2hash::remove
キーを削除する
説明
public bool K2hash::remove ( string $key [, string $subkey ] )
キーを削除します。キーに紐づけられたキーをサブキーと呼びます。サブキーに紐づけられたキーを親キーと呼びます。
親キーのみを指定した場合は、サブキーは削除されません。
サブキーを指定した場合は、サブキーは削除され、親キーは削除されません。
パラメータ
- key
キー（親キー） - subkey
キーに紐付けられたキー（サブキー）
戻り値
成功した場合に true を、失敗した場合に false を返します。
例
- 例 1 - 親キーを削除する
<?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"));
?>
上の例の出力は以下となります。
bool(false)
string(9) "sub-value"
- 例 2 - キー（親キー）に紐づけられたキー（サブキー）を削除する
<?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"));
?>
上の例の出力は以下となります。
string(5) "value"
bool(false)
参考
- K2hash::removeAll - キーと、キーに紐づけられているキー（サブキー）を削除する
- K2hash::setValue - キーに値を設定する