Hyperwave API Fonctions
intégration dans Apache
L'intégration dans Apache et éventuellement d'autres serveurs est déjà décrite dans le module Hyperwave, qui a été la première extension à se connecter au serveur Hyperwave.
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
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,FALSEou un objet HW_API_Error.
Sommaire
- hw_api::checkin — Archive un objet
- hw_api::checkout — Extrait un objet
- hw_api::children — Retourne le fils d'un objet
- hw_api::content — Retourne le contenu d'un objet
- hw_api::copy — Copie physique
- hw_api::dbstat — Retourne des statistiques sur le serveur de bases
- hw_api::dcstat — Retourne des statistiques sur le serveur de cache de document
- hw_api::dstanchors — Liste toutes les ancres de destination
- hw_api::dstofsrcanchor — Retourne la destination d'une ancre source
- hw_api::find — Recherche des objets
- hw_api::ftstat — Retourne des statistiques sur le serveur de textes
- hw_api::hwstat — Retourne les statistiques sur le serveur Hyperwave
- hw_api::identify — S'identifie auprès du serveur Hyperwave
- hw_api::info — Retourne des informations sur la configuration du serveur
- hw_api::insert — Insère un nouvel objet
- hw_api::insertanchor — Insère un nouvel objet de type ancre
- hw_api::insertcollection — Insère un nouvel objet de type collection
- hw_api::insertdocument — Insère un nouvel objet de type document
- hw_api::link — Crée un lien vers un objet
- hw_api::lock — Verrouille un objet
- hw_api::move — Déplace un objet d'une collection à l'autre
- hw_api::object — Lit les informations d'attribut
- hw_api::objectbyanchor — Retourne l'objet propriétaire d'une ancre
- hw_api::parents — Retourne le parent d'un objet
- hw_api::remove — Efface un objet
- hw_api::replace — Remplace un objet
- hw_api::setcommittedversion — Valide une version autre que la dernière
- hw_api::srcanchors — Retourne la liste de toutes les ancres
- hw_api::srcsofdst — Retourne les sources d'un objet de destination
- hw_api::unlock — Déverrouille un objet HyperWave verrouillé
- hw_api::user — Retourne le propriétaire d'un objet
- hw_api::userlist — Retourne la liste des utilisateurs connectés
- hw_api_attribute::key — Retourne la clé d'un attribut
- hw_api_attribute::langdepvalue — Retourne la valeur d'un attribut dans une langue
- hw_api_attribute::value — Retourne la valeur d'un attribut
- hw_api_attribute::values — Retourne toutes les valeurs de l'attribut
- hw_api_content::mimetype — Retourne le type MIME
- hw_api_content::read — Lit le contenu
- hw_api_error::count — Retourne le nombre d'erreurs
- hw_api_error::reason — Retourne la première raison d'erreur
- hw_api_object::assign — Clone un objet
- hw_api_object::attreditable — Vérifie si un attribut est éditable
- hw_api_object::count — Retourne le nombre d'attributs
- hw_api_object::insert — Insère un nouvel attribut HyperWave
- hw_api_object::remove — Supprime un attribut HyperWave
- hw_api_object::title — Retourne le titre de l'attribut
- hw_api_object::value — Retourne la valeur de l'attribut
- hw_api_reason::description — Retourne la description d'une raison
- hw_api_reason::type — Retourne le type de raison
- hwapi_attribute_new — Crée une nouvelle instance de la classe hw_api_attribute
- hwapi_content_new — Crée une nouvelle instance de la classe hw_api_content
- hwapi_hgcsp — Retourne un objet de classe hw_api
- hwapi_object_new — Crée une nouvelle instance de la classe hwapi_object_new
