クラス
HW_API 拡張モジュールが提供する API は、完全にオブジェクト指向です。
Hyperwave SDK の C++ インターフェイスに非常によく似ています。
この API は、以下のクラスからなります。
-
HW_API
-
HW_API_Object
-
HW_API_Attribute
-
HW_API_Error
-
HW_API_Content
-
HW_API_Reason
Hyperwave SDK に含まれているクラスのうち、
HW_API_String、
HW_API_String_Array
のような基本的なクラスは実装されていません。
PHP には、それらに代わる強力な機能があるからです。
各クラスにはメソッドが含まれており、その名前は Hyperwave SDK
の対応するメソッドと同じです。この関数に引数を渡す方法は
PHP の他の拡張モジュールとは少し異なっており、HW SDK の C++ API
に似ています。複数のパラメータを別々に渡すのではなく、
それらをひとつの連想配列にまとめて単一のパラメータとして渡します。
連想配列のキーの名前は、HW SDK に記述されている内容と同じです。
一般的なパラメータについては以下で説明します。
それ以外のパラメータが必要になる場合は、必要に応じて説明されます。
-
objectIdentifier オブジェクトの名前あるいは ID。
例 "rootcollection"、"0x873A8768 0x00000002"。
-
parentIdentifier
親オブジェクトの名前あるいは ID。
-
object HW_API_Object クラスのインスタンス。
-
parameters HW_API_Object クラスのインスタンス。
-
version オブジェクトのバージョン。
-
mode 実行される操作を定義する整数値。
-
attributeSelector
文字列の配列で、個々の要素は属性の名前となります。
オブジェクトレコードを取得する際に特定の属性を含めたい場合に使用します。
-
objectQuery
オブジェクトのリストの中から特定のオブジェクトを選択するためのクエリ。
hw_api::children() や hw_api::find()
のような関数から返されるオブジェクトの数を減らすために使用します。
注意:
boolean 型のメソッドは、
TRUE、FALSE あるいは
HW_API_Error オブジェクトを返します。