hw_Modifyobject

説明

このコマンドによりオブジェクトレコードの個々の属性を削除、追加、 修正することが可能となります。オブジェクトはオブジェクトID object_to_changeにより指定します。最初の配 列 remove は、削除する属性のリストです。二 番目の配列 add は、加えたい属性のリストで す。ある属性を修正するためには、古い属性を削除し、新規に追加する 必要があります。hw_modifyobject() は、 削除する属性の値が文字列または配列でない限り、つねに属性を追加する前に 属性の削除を行います。

最後のパラメータは、修正を再帰的に行うかどうかを指定します。 1は、再帰的な修正を意味します。オブジェクトのいくつかを修正できな い場合、通知されることなくスキップされます。 hw_error() は、いくつかのオブジェクトが 修正されなかったことからエラーを発生しない可能性があります。

二つの配列のキーは属性の名前です。各配列要素の値は、配列または文 字列またはその他のものとすることができます。配列の場合、各属性の 値は、各要素のキーにコロンと各要素の値を加えたものから構成されま す。文字列の場合、属性の値として指定します。空文字列を指定すると その属性は完全に削除されます。値が文字列でも配列でもなく、整数の ような他のものである場合、その属性に関して処理は全く行われません。 このような動作は、既存の属性に新規の値を追加するのではなく、 完全に新規の属性を追加したい場合に必要です。remove 配列がその属性 に関する空の文字列を含む場合、値が存在しないため、その属性の削除 は失敗します。続いてその属性に新規の値を追加する処理も同じく失敗 します。属性の値を例えば0に設定すると削除することさえできませんが、 加算は実行可能です。

値 'books'を有する属性 'Name' を 'articles' に変更したい場合、 二つの配列を作成し、hw_modifyobject() をコールする 必要があります。

例 1属性を修正する // $connect は、Hyperwave サーバーへの既存の接続です。 // $objid は、修正するオブジェクトのIDです。 $remarr = array("Name" => "books"); $addarr = array("Name" => "articles"); $hw_modifyobject($connect, $objid, $remarr, $addarr);

名前=値の組を削除/追加するためには、オブジェクトレコードをremove/add 配列にて渡し、最後/3番目のパラメータは空の配列にします。 新規に属性を追加する場合には、 remove 配列におけるその属性の値を整数に設定して下さい。

例 2完全に新規の属性を追加する // $connect は、Hyperwave サーバーへの既存の接続です。 // $objid は、修正するオブジェクトのIDです。 $remarr = array("Name" => 0); $addarr = array("Name" => "articles"); $hw_modifyobject($connect, $objid, $remarr, $addarr);

$remarr = array("Title" => "en:Books");
       $addarr = array("Title" => "en:Articles");
       $hw_modifyobject($connect, $objid, $remarr, $addarr);

$remarr = array("Title" => array("en" => "Books"));
       $addarr = array("Title" => array("en" => "Articles", "ge"=>"Artikel"));
       $hw_modifyobject($connect, $objid, $remarr, $addarr);

$remarr = array("Title" => "");
       $addarr = array("Title" => "en:Articles");
       $hw_modifyobject($connect, $objid, $remarr, $addarr);

エラーを生じた場合はTRUE、それ以外の場合にはFALSEを返します。