Classes
L'API fournie avec l'extension HW_API est complètement orientée objet.
Elle est très similaire à l'interface C++ du SDK Hyperwave.
Elle est constituée des classes suivantes :
-
HW_API
-
HW_API_Object
-
HW_API_Attribute
-
HW_API_Error
-
HW_API_Content
-
HW_API_Reason
Certains classes basiques comme
HW_API_String,
HW_API_String_Array, etc., qui existent dans le SDK
Hyperwave SDK n'ont pas été implémentées, car PHP a de puissants ersatz pour elles.
Chaque classe dispose de certaines méthodes, dont les noms sont identiques à
leur alter ego du SDK Hyperwave SDK. Le passage des arguments à ces fonctions
diffère de toutes les autres extensions PHP, mais est proche de l'API C++
du SDK Hyperwave. Au lieu de passer plusieurs paramètres, ils sont tous
placés dans un tableau associatif, et transmis sous la forme d'un seul
paramètre. Les paramètres les plus communs sont listés ci-dessous. Si d'autres
paramètres sont nécessaires, ils seront documentés à chaque cas.
-
objectIdentifier Le nom ou l'identifiant de l'objet,
e.g. "rootcollection", "0x873A8768 0x00000002".
-
parentIdentifier Le nom ou l'identifiant de l'objet
qui est considéré comme parent.
-
object Une instance de la classe HW_API_Object.
-
parameters Une instance de la classe HW_API_Object.
-
version La version de l'objet.
-
mode Un entier qui détermine la méthode
d'exécution de l'opération.
-
attributeSelector Un tableau de chaînes de
caractères, chacun contenant le nom d'un attribut. C'est le cas si
vous lisez des enregistrements d'objets, et que vous voulez inclure
certains attributs.
-
objectQuery Une requête pour sélectionner
certains objets dans une liste. Elle est utilisée pour réduire
le nombre d'objets qui a été livré par une fonction comme
hw_api::children() ou hw_api::find().
Note:
Les méthodes retournant un booléen peuvent retourner TRUE, FALSE ou
un objet HW_API_Error.