cvs: phpdoc /fr/functions hw.xml
| From: | Damien Seguy | Date: | Thu, 30 Nov 2000 10:27:39 +0000 |
| Subject: | cvs: phpdoc /fr/functions hw.xml | ||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969333125@lists.php.net to get a copy of this message | ||
dams Thu Nov 30 02:27:39 2000 EDT
Modified files:
/phpdoc/fr/functions hw.xml
Log:
Adding the funcprototype tag.
Index: phpdoc/fr/functions/hw.xml diff -u phpdoc/fr/functions/hw.xml:1.2 phpdoc/fr/functions/hw.xml:1.3 --- phpdoc/fr/functions/hw.xml:1.2 Sat Jul 22 06:43:41 2000 +++ phpdoc/fr/functions/hw.xml Thu Nov 30 02:27:38 2000 @@ -1,1614 +1,2025 @@ - <reference id="ref.hyperwave"> - <title>Fonctions Hyperwave</title> - <titleabbrev>Hyperwave</titleabbrev> - - <partintro> - - <sect1 id="hw-intro"> - <title>Introduction</title> - <para> - <productname>Hyperwave</productname> a été developpé par - <ulink url="http://www.iicm.edu">IICM</ulink> à Graz. Son nom original était - <acronym>Hyper-G</acronym> et il a pris le nom de Hyperwave lors de sa - commercialisation (en 1996, si mes souvenirs sont bons). - </para> - <para> - Hyperwave n'est pas gratuit. La version actuelle est la 4.1, disponible à - <ulink url="http://www.hyperwave.com/">www.hyperwave.com</ulink>. Une version - limitée à 30 jours peut être demandée. - </para> - <para> - <acronym>HIS</acronym> est un système d'information similaire à une base de - données, (HIS, Hyperwave Information Server). HIS se concentre sur l'enregistrement - et la gestion des documents. Un document peut être n'importe quelle donnée, qui - peut être stockée dans un fichier. Chaque document est accompagné par un - enregistrement. Cet enregistrement contient des méta données à propos du document. - Ces méta données sont des listes d'attributs qui peuvent être étendues par - l'utilisateur. Un attribut est une paire clé/valeur de la forme : clé =valeur. - L'enregistrement complet contient autant de paire que le désire l'utilisateur. - Le nom d'un attribut n'a pas besoin d'être unique, c'est à dire qu'une même clé - peut apparaître plusieurs fois dans un enregistrement. Cela peut être utile si - vous devez donner un titre à votre document en plusieurs langues, par exemple. - Dans un cas pareil, la convention est que chaque valeur de titre est précédée - par deux lettres et deux points, tel que : 'fr:Titre en français' ou 'ge:Titel - in deutsch'. D'autres attributs comme une description ou des mots clés sont - aussi suceptibles de recourir à ce genre de procédé. Vous pouvez aussi remplacer - l'abréviation de langage par une autre chaîne, tant qu'elle est séparée de la - valeur par les deux points. - </para> - <para> - Chaque enregistrement a une représentation native qui contient toutes les paires - clé/valeur, séparées par un retour à la ligne. L'extension Hyperwave reconnaît une - autre représentation qui est un tableau associatif, oú les attributs servent de - clés. Les attributs multilingues étant géré sous la forme d'un autre tableau - associatif, dont les clés sont les chaînes de langue. En fait, tous les attributs - multiformes sont gérés sous la forme de tableau associatif. (Cela n'est pas encore - complètement codé. Uniquement les attributs de titre, description et mot clés - sont traités correctement). - </para> - <para> - En dehors des documents, tous les hyper liens contenus dans un documents sont - enregistrés dans un autre enregistrement. Les hyperliens qui sont à l'intérieur - d'un document en seront supprimés, et enregistrés dans des objets particuliers, - au moment de l'insertion dans la base de données. L'enregistrement des hyper-liens - contient les informations d'origine et d'objectif. Afin d'accéder au document - original, vous devre lire le document sans les liens, puis lire les liens, et - les réinsérer (les <function>hw_pipedocument</function> et - <function>hw_gettext</function> le font pour vous. L'avantage de séparer les - liens du document est évident : une fois qu'un document, cible d'un hyperlien, a - été renommé, le liens peut facilement être modifié. Le document contenant le lien - n'est pas modifié pour autant. Vous pouvez même ajouter un lien à un document - sans le modifier. - </para> - <para> - Dire que <function>hw_pipedocument</function> et <function>hw_gettext</function> - font l'insertion automatiquement n'est pas aussi simple qu'il n'y paraît. - L'insertion implique une certaine hiérarchie de document. Sur un serveur web, - la hiérarchie est fournie par le système de fichiers, mais Hyperwave dispose de - sa propre hiérarchie et les noms de fichiers ne reflètent pas la position d'un - objet dans cette hiérarchie. Ainsi, la création de liens requière en premier lieu - la construction de la hiérarchie et de l'espace des noms dans une hiérarchie web - et un espace de nom web. La différence fondamentale entre Hyperwave et le web est - qu'il y a une distinction claire en les noms et la hiérarchie dans Hyperwave. Le - nom ne contient aucune information à propos de la position de l'objet dans la - hiérarchie. Sur le web, le nom contient les informations de localisation dans la - hiérarchie. Cela conduit à deux méthodes de d'accès : soit la hiérarchie Hyperwave - et le nom de l'objet sont inscrit dans l'URL. Pour simplifier les choses, une - deuxième approche est pratiquée. L'objet Hyperwave de nom 'mon_objet' correspond à - l'URL 'http://hote/mon_objet', peu importe alors oú il est rangé dans la hiérarchie. - Un objet dont le nom est 'parent/mon_objet' peut être le fils de l'objet 'mon_objet' - dans la hiérarchie Hyperwave, bien que ce soit le contraire en convention web, et - cela risque de perturber l'utilisateur. - </para> - <para> - Ayant pris cette décision, un deuxième problème surgit : comment faire l'interface - avec PHP ? L' URL http://hote/mon_objet n'appelera aucun script PHP à moins que - vous ne demandiez à votre serveur web de le remplacer par autre chose, comme par - exemple : 'http://host/php3_script/mon_objet' et le script 'php3_script' utilise la - variable $PATH_INFO pour rechercher l'objet 'mon_objet' sur le serveur Hyperwave. - Il y a juste un petit inconvénient , qui peut facilement être corrigé. Réécrire - un URL ne vous permettra aucun accès aux autres documents du serveur web. Un - script de recherche dans le serveur Hyperwave serait impossible. Il vous faudra - donc au moins une autre règle pour exclure certaines URL, comme par exemple celles - qui commencent par http://host/Hyperwave. Voici de manière simple, la manière de - partager un espace de nom entre un serveur web et un serveur Hyperwave serveur. - </para> - <para> - Basé sur le mécanisme précédent, on trouve l'insertion dans les documents. - </para> - <para> - Il est plus compliqué d'avoir PHP ne fonctionne pas comme un module de serveur, ou - un scrip CGI, mais comme une application indépendante. Dans ce cas, il est utile - d'inscrire la hiérarchie et le nom de fichier Hyperwave dans le système de - fichier. Mais comme cela risque d'entrer en conflit avec le séparateur de dossier - ('/'), il faut le remplacer par un autre caractère,. '_'. - </para> - <para> - Le protocole réseau pour communiquer avec un serveur Hyperwave est appelé - <ulink url="http://www.hyperwave.de/7.17-hg-prot">HG-CSP</ulink> - (Hyper-G Client/Server Protocol). Il est basé sur des messages qui initie des - actions, comme par exemple, lire l'entête de fichier. Dans les premières versions - de Hyperwave Server deux clients natifs (Harmony, Amadeus) étaient fournis pour - permettre la communication avec le serveur. Ils ont disparu lors de la - commercialisation de Hyperwave. En tant qu'ersatz, un client appelé wavemaster est - désormais fourni. - wavemaster est un espèce ce convertisseur de protocole de - <abbrev>HTTP</abbrev> en <abbrev>HG-CSP</abbrev>. L'idée est de faire toute - l'administration de la base et la visualisation des documents par une interface - web. Le wavemaster implémente un jeu d'emplacement pour certaines actions de - personnalisation de l'interface. Ce jeu est appelé <abbrev>PLACE</abbrev> - language. <abbrev>PLACE</abbrev> pêche encore par le manque de nombreuse fonctions - de programmations, et le manque d'évolutivité. Cela a conduit à l'utilisation de - JavaScript ce qui ne rend pas la vie facile. - </para> - <para> - Que PHP supporte Hyperwave permet de combler ces manques. PHP implémente tous - les messages définis par <abbrev>HG-CSP</abbrev> mais fourni d'autres commandes - puissantes, comme par exemple, celle de lire des documents complets. - </para> - - <para> - Hyperwave dispose de sa propre terminologie pour localiser certaines informations. - Cette terminologie a été largement étendue. Presque toutes les fonctions utilisent - l'un des types de données suivants : - - <itemizedlist> - <listitem><simpara> - object ID: un entier, unique pour chaque objet sur le serveur Hyperwave. C'est - aussi un des attributs de l'enregistrement de l'objet (ObjectID).Les object ids - sont souvent utilisées comme paramètre d'entrée pour spécifier un objet. - </simpara></listitem> - <listitem><simpara> - object record: Une chaîne contenant des paires clé=valeur. Les paires sont - séparées par un retour à la ligne. Un enregistrement d'objet peut facilement - être converti en tableau, avec la fonction <function>hw_objrec2array</function>. - De nombreuses fonctions retournent un object records. Ces fonctions ont leur - nom qui finit par obj. - </simpara></listitem> - <listitem><simpara> - object array: Un tableau associatif qui contient tous les attributs d'un objet. - La clé est l'attribut. Si un attribut apparaît plusieurs fois, il sera - représenté sous la forme d'un tableau associatif ou indexé. Les attributs qui - dépendent des langues (comme title, keyword ou description) seront représentés sous la - forme d'un tableau associatif, dont les clés seront les abréviations de langues. - Tous les autres attributs à valeur multiple prendront la forme d'un tableau - indexé. - </simpara></listitem> - <listitem><simpara> - hw_document: Ce type est un nouveau type de données, qui contient le document - lui même, comme par exemple HTML, PDF etc. Il est optimisé pour les documents - HTML mais peut s'utiliser avec n'importe quel format. - </simpara></listitem> - </itemizedlist></para> - - <para> - De nombreuses fonctions qui retournent un tableau d'enregistrements, retournent aussi - un tableau associé, avec des informatiosn statistiques. Ce tableau est le dernier - élément du tableau d'enregistrements. Les statistiques contiennent les entrées - suivantes : - <variablelist> - <varlistentry> - <term>Hidden</term> - <listitem><simpara> - Nombre d'objet dont l'attribut PresentationHints est Hidden. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term>CollectionHead</term> - <listitem><simpara> - Nombre d'objet dont l'attribut PresentationHints est CollectionHead. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term>FullCollectionHead</term> - <listitem><simpara> - Nombre d'objet dont l'attribut PresentationHints est FullCollectionHead. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term>CollectionHeadNr</term> - <listitem><simpara> - Index du premier objet du tableau d'enregistrement avec l'attribut - PresentationHints à CollectionHead. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term>FullCollectionHeadNr</term> - <listitem><simpara> - Index du premier objet du tableau d'enregistrement avec l'attribut - PresentationHints est FullCollectionHead. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term>Total</term> - <listitem><simpara> - Total: Nombre d'enregistrements. </simpara></listitem> - </varlistentry> - </variablelist></para> - </sect1> - - <sect1 id="hw-apache"> - <title>Intégration avec Apache</title> - <para> - L'extension Hyperwave est utilisée de manière optimale lorsqu PHP est compilé - comme module Apache. Dans ce cas, le serveur Hyperwave sous jacent peut être - caché quasiment totalement aux utilisateurs, si Apache utilise son moteur d'écriture. - Les explications suivantes vous éclaireront : - </para> - <para> - Etant donné que PHP avec l'extension Hyperwave et Apache tend à remplacer - la solution native basé sur Wavemaster, je vais supposer que le serveur Apache - servira seulement d'interface Hyperwave. Ce n'est pas nécessaire, mais cela - simplifie grandment la configuration. Le concept est très simple. Premièrement, - vous avez besoin d'un script PHP qui évalue la variable <envar>PATH_INFO</envar> et - considère que cette valeur est un objet Hyperwave. Appelons ce script 'Hyperwave'. - L'URL <systemitem role="url">http://votre.hote/Hyperwave/nom_objet</systemitem> - retourne alors l'objet Hyperwave dont le nom est 'nom_objet'. Le script doit alors - réagir suivant le type de l'objet. Si c'est un groupe, il devra probablement - retourner une liste de fils. Si c'est un document, il pourra retourner son type - MIME et son contenu. Une amélioration peut être obtenue en utilisant le moteur - de réécriture d' Apache. D'un point de vue utilisateur, il est plus direct si - l'URL <systemitem role="url">http://votre.hote/nom_objet</systemitem> - retourne l'objet. La règle de réécriture est simple : - - <informalexample><programlisting role="apache-conf"> -RewriteRule ^/(.*) /usr/local/apache/htdocs/HyperWave/$1 [L] -</programlisting></informalexample> - - Maintenant toutes les URL pointent sur un objet Hyperwave. Cela conduit à un - problème simple. Il n'y a pas d'autre façon d'exécuter, c'est à dire rechercher, - un autre script que ce script 'Hyperwave'. Cela pourra être corrigé avec une autre - règle telle que: - - <informalexample><programlisting role="apache-conf"> -RewriteRule ^/hw/(.*) /usr/local/apache/htdocs/hw/$1 [L] -</programlisting></informalexample> - - Le dossier <filename class="directory">/usr/local/apache/htdocs/hw</filename> - sera ainsi reservé pour d'autres scripts et fichiers. Assurez vous que cette - règle est évaluée avant la première règle que nous avons définie. Il y a juste - un léger inconvénient : tous les objets Hyperwave qui commencent par 'hw/' seront - cachés. Alors, assurez vous que vous n'utilisez pas de tels noms. Si vous avez - besoin d'autres dossiers, par exemple, un dossier d'images, ajoutez simplement - d'autres règles. N'oubliez pas de lancer le moteur de réécriture avec - - <informalexample><programlisting role="apache-conf"> -RewriteEngine on -</programlisting></informalexample> - - Mon expérience m'a montré que vous aurez besoin des scripts suivants : - - <itemizedlist> - <listitem><simpara> - Retourne l'objet lui même </simpara></listitem> - <listitem><simpara> - Pour autoriser la recherche</simpara></listitem> - <listitem><simpara> - S'identifier</simpara></listitem> - <listitem><simpara> - Choisir une configuration </simpara></listitem> - <listitem><simpara> -Un script pour chaque fonction supplémentaire, comme afficher un objet, afficher des informations sur les utilisateurs, afficher le statut du serveur, etcÖ -</simpara></listitem> - </itemizedlist></para> - </sect1> - - <sect1 id="hw-todo"> - <title>A faire</title> - <para> - Il reste encore beaucoup à faire : - <itemizedlist> - <listitem><simpara>La fonction hw_InsertDocument doit être séparée en deux : - <function>hw_InsertObject</function> et - <function>hw_PutDocument</function>.</simpara></listitem> - <listitem><simpara>Les noms de nombreuses fonctions ne sont pas encore fixés. - </simpara></listitem> - <listitem><simpara> - La plupart des fonctions requièrent la connexion courante - comme premier paramètre. Cela conduit à beaucoup de frappe clavier, - même si il n'y a souvent qu'une seule connexion en jeu. Une connexion par - défaut améliorerait ceci. - </simpara></listitem> - </itemizedlist></para> - </sect1> - </partintro> - - <refentry id="function.hw-array2objrec"> - <refnamediv> - <refname>hw_Array2Objrec</refname> - <refpurpose>converti un tableau en un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>strin <function>hw_array2objrec</function></funcdef> - <paramdef>array <parameter>object_array</parameter></paramdef> - </funcsynopsis> - <para> - Converti un <parameter>object_array</parameter> en un objet. - Les attributs multiples tels que 'Title' en différentes langues seront traités - correctement. - </para> - <para> - Voir aussi <function>hw_objrec2array</function>. - </para> - </refsect1> - </refentry> - - <refentry id="function.hw-children"> - <refnamediv> - <refname>hw_Children</refname> - <refpurpose>Liste des object ids des objets fils.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_children</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un tableau avec des object ids. Chaque object id est celui d'un des fils du -groupe dont l'id est <parameter>objectID</parameter>. -Ce tableau contient tous les fils, documents et groupes. -</para> - </refsect1> - </refentry> - - <refentry id="function.hw-childrenobj"> - <refnamediv> - <refname>hw_ChildrenObj</refname> - <refpurpose>Liste des object records des objets fils.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_childrenobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un tableau avec des object records. Chaque object records est celui d'un des -fils du groupe dont l'id est <parameter>objectID</parameter>. -Ce tableau contient tous les fils, documents et groupes -</para> - </refsect1> - </refentry> - - <refentry id="function.hw-close"> - <refnamediv> - <refname>hw_Close</refname> - <refpurpose>Ferme la connexion Hyperwave.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_close</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> - Retourne false si la connexion n'est pas valide, et sinon, true. Ferme la connexion connection à un serveur Hyperwave.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-connect"> - <refnamediv> - <refname>hw_Connect</refname> - <refpurpose>Ouvre une connexion Hyperwave.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_connect</function></funcdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcsynopsis> - <para> -Ouvre une connexion Hyperwave et retourne un identifiant de connexion, en cas de succès, - ou false, si la connexion n'a pas pu être créée. Chaque argument doit être entouré de -guillemets, sauf le numéro de port. Les arguments <parameter>username</parameter> et - <parameter>password</parameter> sont optionnels, et peuvent être ignorés. Dans ce - cas, aucune identification ne sera faite au niveau du serveur. Cela revient à s'identifier en tant qu'utilisateur anonyme. Cette fonction retourne un identifiant de connexion qui sera nécessaire aux autres fonctions Hyperwave. Vous pouvez avoir plusieurs connexions simultanées. N'oubliez pas que les mots de passe ne sont pas cryptés. -</para> - <para> - Voir aussi <function>hw_pConnect</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-cp"> - <refnamediv> - <refname>hw_Cp</refname> - <refpurpose>Copie des objets.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_cp</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>array <parameter>object_id_array</parameter></paramdef> - <paramdef>int <parameter>destination id</parameter></paramdef> - </funcsynopsis> - <para> -Copie les objet ayant les objects id object_id_array, et crée un groupe ayant l'object id <parameter>destination id</parameter>.</para> - <para> -La valeur retournée est le nombre d'objets copiés. -</para> - <para> - Voir aussi <function>hw_mv</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-deleteobject"> - <refnamediv> - <refname>hw_Deleteobject</refname> - <refpurpose>Efface des objets.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_deleteobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>object_to_delete</parameter></paramdef> - </funcsynopsis> - <para> -Efface l'objet dont l'identifiant est object_to_delete. Toutes les instances de l'objets seront effacées. -</para> - <para> -Retourne TRUE si aucune erreur ne survient, et sinon, FALSE. -</para> - <para> - Voir aussi <function>hw_mv</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-docbyanchor"> - <refnamediv> - <refname>hw_DocByAnchor</refname> - <refpurpose>Identifiant d'objet de l'objet dans l'ancrage.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_docbyanchor</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>anchorID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne l'dentifiant d'objet de l'objet dans l'ancrage <parameter>anchorID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-docbyanchorobj"> - <refnamediv> - <refname>hw_DocByAnchorObj</refname> - <refpurpose>Attributs de l'objet dans l'ancrage.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_docbyanchorobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>anchorID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne les attributs du document qui correspond à <parameter>anchorID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-documentattributes"> - <refnamediv> - <refname>hw_DocumentAttributes</refname> - <refpurpose>Object record de hw_document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_documentattributes</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> - Retourne les attributs du document.</para> - <para> - Voir aussi <function>hw_DocumentBodyTag</function>, - <function>hw_DocumentSize</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-documentbodytag"> - <refnamediv> - <refname>hw_DocumentBodyTag</refname> - <refpurpose>Balise de corps d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_documentbodytag</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> -Retourne la balise BODY du document.Si le document est un document HTML , la balise BODY doit être affichée avant le document.</para> - <para> - Voir aussi <function>hw_DocumentAttributes</function>, - <function>hw_DocumentSize</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-documentcontent"> - <refnamediv> - <refname>hw_DocumentContent</refname> - <refpurpose>Contenu d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_documentcontent</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> -Retourne la balise BODY du document.Si le document est un document HTML , la balise BODY doit être affichée avant le document.</para> - <para> - Voir aussi <function>hw_DocumentAttributes</function>, - <function>hw_DocumentSize</function>, - <function>hw_DocumentSetContent</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-documentsetcontent"> - <refnamediv> - <refname>hw_DocumentSetContent</refname> - <refpurpose>Modifie/remplace le contenu d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_documentsetcontent</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - <paramdef>string <parameter>content</parameter></paramdef> - </funcsynopsis> - <para> -Modifie/remplace le contenu d'un document. Si le document est un document HTML, le contenu représente tout qui est placé au dela de la balise BODY. Les informations de HEAD et de la balise BODY sont enregistrés dans les attributs. Si vous fournissez aussi ces informations dans le corps du document, le serveur Hyperwave modifiera les attributs. Cela n'est cependant pas une bonne idée. Si la fonction échoue, l'ancien contenu est restauré. -</para> - <para> - Voir aussi <function>hw_DocumentAttributes</function>, - <function>hw_DocumentSize</function>, - <function>hw_DocumentContent</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-documentsize"> - <refnamediv> - <refname>hw_DocumentSize</refname> - <refpurpose>Taille d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_documentsize</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> - Retourne la taille du document en octets.</para> - <para> - Voir aussi <function>hw_DocumentBodyTag</function>, - <function>hw_DocumentAttributes</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-errormsg"> - <refnamediv> - <refname>hw_ErrorMsg</refname> - <refpurpose>Retourne un message d'erreur.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_errormsg</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> -Retourne une chaîne contenant le dernier message d'erreur, ou 'No Error' (pas d'erreur). Si false est retourné, cette fonction a échoué. Ce message est relatif à la dernière commande exécutée.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-edittext"> - <refnamediv> - <refname>hw_EditText</refname> - <refpurpose>Retourne un document texte.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_edittext</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> -Charge le texte du document sur le serveur. Les attributs du document ne doivent pas être modifiés tant que le document est en train d'être édité. Cette fonction n'est disponible que sur les documents texte. Elle n'ouvrira pas de canal de transfert, et donc, bloquera le script durant le transfert. -</para> - <para> - Voir aussi <function>hw_PipeDocument</function>, - <function>hw_free_document</function>, - <function>hw_DocumentBodyTag</function>, - <function>hw_DocumentSize</function>, - <function>hw_OutputDocument</function>, - <function>hw_GetText</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-error"> - <refnamediv> - <refname>hw_Error</refname> - <refpurpose>Retourne le code d'erreur.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_error</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> -Retourne le code d'erreur de la dernière erreur. Si la valeur 0 est retournée, c'est qu'il n'y avait pas d'erreur. L'erreur se rapporte à la dernière commande.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-free-document"> - <refnamediv> - <refname>hw_Free_Document</refname> - <refpurpose>Détruit un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_free_document</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> - Détruit un document Hyperwave.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getparents"> - <refnamediv> - <refname>hw_GetParents</refname> - <refpurpose>Identifiant d'objet des parents.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getparentsobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau indexé avec les identifiants des objets parents de <parameter>objectID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getparentsobj"> - <refnamediv> - <refname>hw_GetParentsObj</refname> - <refpurpose>Attributs des parents.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getparentsobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau indexé, avec les attributs et un tableau associé, d'informations statistiques à propos des attributs. Ce tableau associé est le dernier élément du tableau retourné. Chaque -attribut appartient au père de l'objet <parameter>objectID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getchildcoll"> - <refnamediv> - <refname>hw_GetChildColl</refname> - <refpurpose>Identifiant d'objet des groupes fils.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getchildcoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau contenant les identifiants d'objets des groupes fils du -groupe <parameter>objectID</parameter>. Cette fonction ne retournera pas d'identifiants -d'objets des documents fils.</para> - <para> - Voir aussi <function>hw_GetChildDocColl</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getchildcollobj"> - <refnamediv> - <refname>hw_GetChildCollObj</refname> - <refpurpose>object records d'un groupe d'enfants.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getchildcollobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau d'object record. Chaque object records appartient à un groupe d'enfants -de la collection <parameter>objectID</parameter>. La fonction ne retournera pas -de documents enfants.</para> - <para> - Voir aussi <function>hw_ChildrenObj</function>, - <function>hw_GetChildDocCollObj</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getremote"> - <refnamediv> - <refname>hw_GetRemote</refname> - <refpurpose>Retourne un document distant.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_getremote</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un document distant. Les documents distants sont , en Hyperwave, des documents -lus depuis une source externe. La plus part des documents éloignés sont des pages web -externes, ou des requêtes sur une base de données. Afin de pouvoir accéder à des sources - externes, grâces aux documents distants, Hyperwave introduit l'interface HGI (Hyperwave - Gateway Interface) qui est similaire à CGI. Actuellement, seuls les protocoles de ftp, -http et certaines bases de données sont accessibles avec HGI. <function>hw_GetRemote</function> - retourne le document de la source distante. Si vous voulez utiliser cette fonction, il vous faut vous familiariser HGIs. Il est aussi préférable d'utiliser PHP plutôt que Hyperwave pour accéder aux sources externes. Le support des bases de données sera plus difficile avec Hyperwave que PHP. -</para> - <para> - Voir aussi <function>hw_GetRemoteChildren</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getremotechildren"> - <refnamediv> - <refname>hw_GetRemoteChildren</refname> - <refpurpose>Retourne les fils d'un document distant.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_getremotechildren</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>object record</parameter></paramdef> - </funcsynopsis> - <para> -Retourne les fils d'un document distant. Les fils d'un document distant sont des -documents distants eux mêmes. Cela est cohérent si une requête sur une base de données -doit être rendu plus sélective, comme expliqué dans Hyperwave Programmers' Guide. -Si le nombre de fils est 1 la fonction va retourner le document lui même, la fonction -retournera le document lui même, formaté Hyperwave Gateway Interface (HGI). Si -le nombre de fils est supérieur 1 la fonction retournera un tableau d'attributs, -qui pourra servir à une nouvelle requête avec <function>hw_GetRemoteChildren</function>. -Ces attributs sont virtuels et n'existent pas sur le serveur Hyperwave, et ainsi, n'ont pas d'identifiant d'objet valide. L'ordre exact de ces objets est du ressort de HGI. Si vous voulez utiliser cette fonction, vous devez être très familier HGIs. Il vaut mieux PHP plutôt que Hyperwave pour accéder aux fichiers distants. Le support de base de données y est bien meilleur. -</para> - <para> - Voir aussi <function>hw_GetRemote</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getsrcbydestobj"> - <refnamediv> - <refname>hw_GetSrcByDestObj</refname> - <refpurpose>Retourne les ancrages qui pointent sur un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getsrcbydestobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne les attributs de tous les ancrages qui pointent sur <parameter>objectID</parameter>. -L'objet peut être un document ou un autre ancrage, de type destination. -</para> - <para> - Voir aussi <function>hw_GetAnchors</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getobject"> - <refnamediv> - <refname>hw_GetObject</refname> - <refpurpose>Attributs d'un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>[int|array] <parameter>objectID</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcsynopsis> - <para> -Retourne les attributs de l'objet dont l'identifiant est <parameter>objectID</parameter>, - si le second paramètre est un entier. Si le second paramètre est un tableau, la fonction retournera un tableau d'attributs. Dans ce cas, le dernier paramètre est aussi évalué. -</para> - <para> - <parameter>query</parameter> a la syntaxe suivante :</para> - <simpara> - <expression> ::= "(" <expression> ")" |</simpara> <simpara> - "!" <expression> | /* NOT */</simpara><simpara> - <expression> "||" <expression> | /* OR */</simpara><simpara> - <expression> "&&" <expression> | /* AND */</simpara><simpara> - <attribute> <operator> <value></simpara><simpara> - - <attribute> ::= /* * n'importe quel attribut (Title, Author, DocumentType ...) */</simpara><simpara> - - <operator> ::= "=" | /* égal */</simpara><simpara> - "<" | /* moins que (comparaison de type chaîne) */</simpara><simpara> - ">" | /* plus que (comparaison de type chaîne) */</simpara><simpara> - "~" /* recherche par expression régulière */</simpara><simpara></simpara> - <para> - <parameter>query</parameter> permet de sélectionner une nouvelle fois certains objets dans la liste des objets donnés. Contrairement aux autres requêtes, celle ci peut utiliser des attributs non indexés. Le nombre d'attributs retourné dépend de la requête de la requête, et des autorisations d'accès aux objets.</para> - <para> - Voir aussi <function>hw_GetAndLock</function>, - <function>hw_GetObjectByQuery</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getandlock"> - <refnamediv> - <refname>hw_GetAndLock</refname> - <refpurpose>Retourne les attributs, et verrouille l'objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_getandlock</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne les attributs, et verrouille l'objet <parameter>objectID</parameter>. -Le verrouillage empêchera les autres utilisateurs d'y accéder, jusqu'à ce qu'il soit deverrouillé. -</para> - <para> - Voir aussi <function>hw_Unlock</function>, - <function>hw_GetObject</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-gettext"> - <refnamediv> - <refname>hw_GetText</refname> - <refpurpose>Retourne un document texte.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_gettext</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>mixed - <parameter> - <optional>rootID/prefix</optional> - </parameter> - </paramdef> - </funcsynopsis> - <para> -Retourne le document de l'objet <parameter>objectID</parameter>. Si le document possède -des ancrages qui peuvent être insérés, ils seront déjà insérés. -L'option rootID/prefix peut être une chaîne ou un entier. Si c'est un entier, il -détermine la méthode d'insertion des liens dans le document. Par défaut, il vaut 0 et -les liens seront construits en fonction du nom de l'objet cible. Cela sert beaucoup -dans les applications web. Si un lien pointe sur un objet avec le nom -'film_internet' le lien HTML sera <A HREF="/internet_movie">. -La position réelle de la source et de la cible dans la hiérarchie seront ignorés. Vous devrez modificer votre site web pour qu'il réécrive les URL, comme par exemple '/mon_script.php3/film_internet'. 'mon_script.php3' devra analyser $PATH_INFO et savoir recherche le document '/mon_script.php3/film_internet'. Si vous ne voulez pas de ce comportement, vous pouvez affecter à rootID/prefix n'importe quel prefixe. Dans ce cas, ce sera une chaîne. -</para> - <para> -Si <parameter>rootID/prefix</parameter> est un entier différent de 0 le lien sera -construit avec tous les noms de la hiérarchie, en commencant à l'objet d'identifiant rootID/prefix, -et séparé par des slash. Si, par exemple, le document 'film_internet' est situé à -'a-b-c-internet_movie' et '-' qui sert de séparateur hiérarchique de niveau sur -le serveur Hyperwave et le document source est situé dans 'a-b-d-source' alors, le lien HTML -serait: <A HREF="../c/internet_movie">. Cela est très pratique si vous voulez télécharger tout le contenu d'un serveur sur un disque, et faire une carte du système sur votre disque. -</para> - <para> -Cette fonction n'est opérationnelle qu'avec des document de pur texte. Elle n'ouvrira pas de canal spécial de transfert, et ainsi, bloquera le script le temps du transfert. -</para> - <para> - Voir aussi <function>hw_PipeDocument</function>, - <function>hw_free_document</function>, - <function>hw_DocumentBodyTag</function>, - <function>hw_DocumentSize</function>, - <function>hw_OutputDocument</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getobjectbyquery"> - <refnamediv> - <refname>hw_GetObjectByQuery</refname> - <refpurpose>Recherche un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getobjectbyquery</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcsynopsis> - <para> -Recherche un objet sur tout le serveur et retourne un tableau d' object ids. -Le nombre maximum d'objet est limité par <parameter>max_hits</parameter>. - Si <parameter>max_hits</parameter> vaut -1 il n'y a pas de limite.</para> - <para> - La requête ne fonctionnera qu'avec des attributs indexés.</para> - <para> - Voir aussi <function>hw_GetObjectByQueryObj</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getobjectbyqueryobj"> - <refnamediv> - <refname>hw_GetObjectByQueryObj</refname> - <refpurpose>Recherche un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getobjectbyqueryobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcsynopsis> - <para> -Recherche un objet sur tout le serveur et retourne un tableau d' object records. -Le nombre maximum d'objet est limité par <parameter>max_hits</parameter>. Si <parameter>max_hits</parameter> -vaut -1 il n'y a pas de limite. -</para> - <para> - La requête ne fonctionnera qu'avec des attributs indexés.</para> - <para> - Voir aussi <function>hw_GetObjectByQuery</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getobjectbyquerycoll"> - <refnamediv> - <refname>hw_GetObjectByQueryColl</refname> - <refpurpose>Recherche un objet dans un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getobjectbyquerycoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcsynopsis> - <para> -Recherche un objet sur tout le groupe objectID et retourne un tableau d' object records. - Le nombre maximum d'objet est limité par <parameter>objectID</parameter>. Si <parameter>objectID</parameter> - vaut -1 il n'y a pas de limite. -</para> - <para> -La requête ne fonctionnera qu'avec des attributs indexés.</para> - <para> - Voir aussi <function>hw_GetObjectByQueryCollObj</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getobjectbyquerycollobj"> - <refnamediv> - <refname>hw_GetObjectByQueryCollObj</refname> - <refpurpose>Recherche un objet dans un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getobjectbyquerycollobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcsynopsis> - <para> -Recherche un objet sur tout le groupe objectID et retourne un tableau d' object records. - Le nombre maximum d'objet est limité par <parameter>objectID</parameter>. Si <parameter>objectID</parameter> - vaut -1 il n'y a pas de limite.</para> - <para> - La requête ne fonctionnera qu'avec des attributs indexés.</para> - <para> - Voir aussi <function>hw_GetObjectByQueryColl</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getchilddoccoll"> - <refnamediv> - <refname>hw_GetChildDocColl</refname> - <refpurpose>ids des documents fils d'un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getchilddoccoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau avec les id des documents fils d'une collection.</para> - <para> - Voir aussi <function>hw_GetChildColl</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getchilddoccollobj"> - <refnamediv> - <refname>hw_GetChildDocCollObj</refname> - <refpurpose>Attributs des documents fils d'un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getchilddoccollobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau contenant les attributs des documents fils du groupe <parameter>objectID</parameter>. </para> - <para> - Voir aussi <function>hw_ChildrenObj</function>, - <function>hw_GetChildCollObj</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getanchors"> - <refnamediv> - <refname>hw_GetAnchors</refname> - <refpurpose> Identifiants des ancrages d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getanchors</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau contenant les identifiants des ancrages du document <parameter>objectID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getanchorsobj"> - <refnamediv> - <refname>hw_GetAnchorsObj</refname> - <refpurpose>Attributs des ancrages d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getanchorsobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un tableau d'attributs des ancrages du document <parameter>objectID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-mv"> - <refnamediv> - <refname>hw_Mv</refname> - <refpurpose>Déplace un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_mv</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>array <parameter>object id array</parameter></paramdef> - <paramdef>int <parameter>source id</parameter></paramdef> - <paramdef>int <parameter>destination id</parameter></paramdef> - </funcsynopsis> - <para> -Déplaces les objets dont les identifiants sont passés dans le tableau <parameter>source id</parameter>, -depuis le <parameter>source id</parameter> dans le <parameter>destination id</parameter>. - Si destination id vaut 0, les objets ne seront plus insérés dans le groupe (ni dans le serveur). Dans ce cas, si une instance était la dernière instance d'un objet, l'objet sera effacé. Si vous voulez effacer toutes les instances d'un coup, utilisez <function>hw_deleteobject</function>. -</para> - <para> - La valeur retournée est le nombre d'objet déplacés.</para> - <para> - Voir aussi <function>hw_cp</function>, - <function>hw_deleteobject</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-identify"> - <refnamediv> - <refname>hw_Identify</refname> - <refpurpose>Identifie un utilisateur.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_identify</function></funcdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcsynopsis> - <para> -Identifies un utilisateur, dont le nom d'utilisateur est <parameter>username</parameter> and - et le mot de passe <parameter>password</parameter>. L'identification n'est valide -que pour la session en cours. Je ne pense pas que cette fonction serve souvent. Dans la plus part des cas, il est plus simple de s'identifier lors de l'ouverture de la connexion. -</para> - <para> - Voir aussi <function>hw_Connect</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-incollections"> - <refnamediv> - <refname>hw_InCollections</refname> - <refpurpose>Vérifie qu'un identifiant d'objet est dans un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_incollections</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>array <parameter>object_id_array</parameter></paramdef> - <paramdef>array <parameter>collection_id_array</parameter></paramdef> - <paramdef>int <parameter>return_collections</parameter></paramdef> - </funcsynopsis> - <para> -Vérifie qu'un ensemble d'objet (documents ou groupes) donnés par <parameter>object_id_array</parameter> - fait partie des groupe listés par <parameter>object_id_array</parameter>. -Lorsque le quatrième paramètre <parameter>return_collections</parameter> vaut 0, le -sous ensemble d'identifiant qui font partie d'un groupe (i.e. les documents ou groupes qui sont fils d'un ou plusieurs groupe, ou leurs fils, récurusivement) est retourné sous la forme d'un tableau. Cette option permet de mettre en valeur la partie de l'arborescence qui contient le résultat d'une requête, dans un sens graphique. -</para> - <para></para> - </refsect1> - </refentry> - - <refentry id="function.hw-info"> - <refnamediv> - <refname>hw_Info</refname> - <refpurpose>Informations à propos d'une connexion.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_info</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> - Retourne les informations de la connexion courante. La chaîne retournée a le format suivant : <Serverstring>, <Host>, - <Port>, <Username>, <Port of Client>, - <Byte swapping></para> - </refsect1> - </refentry> - - <refentry id="function.hw-inscoll"> - <refnamediv> - <refname>hw_InsColl</refname> - <refpurpose>Insère un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_inscoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>array <parameter>object_array</parameter></paramdef> - </funcsynopsis> - <para> -Insère un nouveau groupe, avec les attributs <parameter>object_array</parameter> dans le groupe -<parameter>objectID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-insdoc"> - <refnamediv> - <refname>hw_InsDoc</refname> - <refpurpose>Insère un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_insdoc</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>parentID</parameter></paramdef> - <paramdef>string <parameter>object_record</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcsynopsis> - <para> - Insère un nouveau document avec les attributs <parameter>object_record</parameter>, -dans le groupe <parameter>parentID</parameter>. Cette fonction insère soit un objet -avec ses seuls attributs, soit pur objet ascii, avec <parameter>text</parameter> si il est fourni. -Si vous voulez insérer un document de type général, utilisez plutôt - <function>hw_insertdocument</function>.</para> - <para> - Voir aussi <function>hw_InsertDocument</function>, - <function>hw_InsColl</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-insertdocument"> - <refnamediv> - <refname>hw_InsertDocument</refname> - <refpurpose>Insère un document dans un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_insertdocument</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>parent_id</parameter></paramdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> -Insère un document dans le groupe <parameter>parent_id</parameter>. Le document doit -avoir été créé auparavant avec <function>hw_New_Document</function>. Assurez vous que -les attributs du nouveau document contiennent au moins les attributs suivants : -Type, DocumentType, Title et Name. Vous aurez aussi parfois besoin de MimeType. La fonction retourne l'identifiant de l'objet inséré, ou bien false. -</para> - <para> - Voir aussi <function>hw_PipeDocument</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-insertobject"> - <refnamediv> - <refname>hw_InsertObject</refname> - <refpurpose>Insère un object record.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_insertobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>object rec</parameter></paramdef> - <paramdef>string <parameter>parameter</parameter></paramdef> - </funcsynopsis> - <para> - Insère un objet dans le serveur. L'objet peut être n'importe quel objet Hyperwave valide. Reportez vous à la documentation HG-CSP pour plus de détails sur les paramètres.</para> - <para> - Note: Si vous voulez insérer un ancre, l'attribut Position doit être mis à la valeur start/end (début ou fin) ou encore 'invisible'. Les positions invisibles sont nécessaire si l'annotation n'a pas de liens correspondant dans le texte de l'annotation.</para> - <para> - Voir aussi <function>hw_PipeDocument</function>, - <function>hw_InsertDocument</function>, - <function>hw_InsDoc</function>, - <function>hw_InsColl</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-mapid"> - <refnamediv> - <refname>hw_mapid</refname> - <refpurpose>Représente un id globale en un id virtuel local.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_mapid</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>server id</parameter></paramdef> - <paramdef>int <parameter>object id</parameter></paramdef> - </funcsynopsis> - <para> - Represente l'id d'un objet global de n'importe quel serveur Hyperwave, même si -vous ne vous y êtes pas connecté avec <function>hw_connect</function>, -avec un id d'objet local virtuel. Cet id d'objet local peut alors être utilisé comme n'importe quel -id d'objet : par exemple on peut obtenir l'enregistrement d'objet avec la fonction - <function>hw_getobject</function>. L'id du serveur est la première partie -de l'id global (GOid) de l'objet, qui est en fait une adresse IP.</para> - <para> - Note: Afin d'utiliser cette fonction, vous devez lever le flag - F_DISTRIBUTED, ce qui ne peut être fait qu'à la compilation. Par défaut, il n'est pas levé. -Lisez les commentaires dans le fichier hg_comm.c - </para> - </refsect1> - </refentry> - - - <refentry id="function.hw-modifyobject"> - <refnamediv> - <refname>hw_Modifyobject</refname> - <refpurpose>Modifie les attributs d'objet record.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_modifyobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>object_to_change</parameter></paramdef> - <paramdef>array <parameter>remove</parameter></paramdef> - <paramdef>array <parameter>add</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - - </funcsynopsis> - <para> -Cette commande permet d'effacer, d'ajouter ou de modifier des attributs d'un objet. -L'objet est reperé par son identifiant <parameter>object_to_change</parameter>. -Le premier tableau, <parameter>remove</parameter>, est la liste des attributs à effacer. Le deuxième tableau <parameter>add</parameter> est la -liste des attributs à ajouter. Afin de modifier un attribut, il vous faudra dont l'effacer, -puis l'ajouter à nouveau. <function>hw_modifyobject</function> effacera toujours les -attributs avant de les ajouter, à moins que la valeur de l'attribut à effacer ne -soit pas une chaîne, ou un tableau.</para> - - <para> -Le dernier paramètre détermine si la modification est récursive ou pas. - 1 signigie que la modification est récursive. Si un objet ne peut pas être modifié, -il sera ignoré. <function>hw_error</function> n'indiquera alors pas toujours d'erreur, -même si certains objets n'ont pas pu être modifié. -</para> - - <para> -Les clés des deux tableaux sont les noms des attributs. La valeurs de chaque élément peut être un tableau, ou une chaîne ou n'importe quoi d'autre. Dans le cas du tableau, la valeur de l'attribut est construite en séparant chaque élément par un point virgule. Dans le cas de la chaîne, elle sert directement de valeur. Une chaîne vide provoquera un effacement de l'attribut. Dans le cas oú la valeur n'est ni un tableau, ni une chaîne, aucune opération ne sera effectuée. Cela est nécessaire si vous voulez ajouter un attribut complètement une nouvelle valeur pour un attribut existant. Si le tableau d'effacement contenait une chaîne vide comme attribut, le serveur tenterait d'effacer l'attribut, ce qui échouerai de toute manière, car cet attribut n'existe pas. L'ajout de cet attribut échouerai aussi. Affecter la valeur de 0 à cet attribut ne l'effacerait pas, et l'ajout fonctionnerait. -</para> - - <para> -Si vous voulez changer l'attribut 'Nom' de valeur courante 'livres' en 'articles' vous devrez faire deux tableaux, et appeler <function>hw_modifyobject</function>. - <example> - <title>Modification d'un attribut</title> - <programlisting role="php"> - // $connect est une connexion valide - // $objid est l'identifiant de l'objet - $remarr = array("Name" => "books"); - $addarr = array("Name" => "articles"); - $hw_modifyobject($connect, $objid, $remarr, $addarr); - </programlisting> - </example> -Afin d'effacer/ajouter une paire nom=valeur aux attributs d'un objet, utilisez simplement les tableaux d'effacement et d'ajout, et laissez le dernier/troisième paramètre vide. Si l'attribut est le premier de ce nom à ajouter, donnez une valeur entière à cet élément. - <example> - <title>Ajouter un nouvel attribut</title> - <programlisting role="php"> - // $connect is an existing connection to the Hyperwave server - // $objid is the ID of the object to modify - $remarr = array("Name" => 0); - $addarr = array("Name" => "articles"); - $hw_modifyobject($connect, $objid, $remarr, $addarr); - </programlisting> - </example></para> - <para> - <note> - <simpara> -Les attributs multilingues, (tels que 'Title'), peuvent être modifiés de deux manières : soit en fournissant la valeur de ces attributs de manière native (langue :valeur), soit en fournissant un tableau avec les éléments de chaque langue, comme décrit ci-dessus. L'exemple deviendrai alors : </simpara> - </note> - <example> - <title>modifying Title attribute</title> - <programlisting role="php"> - $remarr = array("Title" => "en:Books"); - $addarr = array("Title" => "en:Articles"); - $hw_modifyobject($connect, $objid, $remarr, $addarr); - </programlisting> - </example> - ou - <example> - <title>Modifier l'attribut Title</title> - <programlisting role="php"> - $remarr = array("Title" => array("en" => "Books")); - $addarr = array("Title" => array("en" => "Articles", "ge"=>"Artikel")); - $hw_modifyobject($connect, $objid, $remarr, $addarr); - </programlisting> - </example> -Pour supprimer l'entrée française 'Livres' et ajouter l'entrée 'Articles' et l'entrée allemande 'Artikel'. - <example> - <title>Suppression d'un attribut</title> - <programlisting role="php"> - $remarr = array("Title" => ""); - $addarr = array("Title" => "en:Articles"); - $hw_modifyobject($connect, $objid, $remarr, $addarr); - </programlisting> - </example> - <note><simpara> -Cet exemple va effacer tous les attributs avec le nom 'Title' et ajouter un nouvel attribut 'Title'. Cela peut être pratique pour effacer des attributs récursivement. - </simpara></note> - <note> - <simpara> -Si vous devez effacer tous les attributs avec un certains nom, vous devez passer une chaîne vide comme valeur. -</simpara> - </note> - <note><simpara> -Seul les attributs 'Title', 'Description' et 'Keyword' gère correctement le préfixe de langue. Pour les autres attributs qui ne portent pas de préfixe de language, le préfixe 'xx' sera assigné. - </simpara></note> - <note><simpara> -L'attribut 'Name' est un peu particuluer. Dans certains cas, il ne peut pas être complétement effacé. Vous aurez alors le message 'Change of base attribute' (l'apparition de cette erreur n'est pas très claire). Ainsi, vous aurez à ajouter une nouvelle entrée pour Name puis, effacer l'ancien. - </simpara></note> - <note><simpara> -Il ne faut pas encadrer cette fonction par des appels à <function>hw_getandlock</function> et <function>hw_unlock</function>. - <function>hw_modifyobject</function> le fait de manière interne. - </simpara></note></para> - <para> - Retourne TRUE si aucune erreur ne survient, et FALSE sinon.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-new-document"> - <refnamediv> - <refname>hw_New_Document</refname> - <refpurpose>Crée un nouveau document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_new_document</function></funcdef> - <paramdef>string <parameter>object_record</parameter></paramdef> - <paramdef>string <parameter>document_data</parameter></paramdef> - <paramdef>int <parameter>document_size</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un nouveau document Hyperwave avec comme données <parameter>document_data</parameter> et comme -attributs <parameter>object_record</parameter>. La longueur de <parameter>document_data</parameter> doit être données dans -<parameter>document_size</parameter>. Cette fonction n'insère pas l'objet dans le serveur Hyperwave. -</para> - <para> - Voir aussi <function>hw_free_document</function>, - <function>hw_DocumentSize</function>, - <function>hw_DocumentBodyTag</function>, - <function>hw_OutputDocument</function>, - <function>hw_InsertDocument</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-objrec2array"> - <refnamediv> - <refname>hw_Objrec2Array</refname> - <refpurpose>Converti les attributs d'un objet en tableau.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_objrec2array</function></funcdef> - <paramdef>string <parameter>object_record</parameter></paramdef> - </funcsynopsis> - <para> -Convertir les attributs <parameter>object_record</parameter> d'un objet en un tableau. -Les clés du tableau seront les noms des attributs. Les attributs multiples comme par exemple 'Title', dans différentes langues, seront rassemblées dans un autre tableau. Une clé est la partie gauche d'un attribut. Actuellement, seuls les attributs 'Title', 'Description' et 'Keyword' sont traités correctement. -</para> - <para> - Voir aussi <function>hw_array2objrec</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-outputdocument"> - <refnamediv> - <refname>hw_OutputDocument</refname> - <refpurpose>Affiche hw_document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_outputdocument</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> - Affiche hw_document sans la balise BODY.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-pconnect"> - <refnamediv> - <refname>hw_pConnect</refname> - <refpurpose>Crée une connexion persistante.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_pconnect</function></funcdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un index de connexion en cas de succès, et false si la connexion n'a pas pu -être créée. Ouvre une connexion persistante à un serveur Hyperwave. Tous les arguments -doivent être entre guillemets, hormis le numéro de port (port). Les arguments -<parameter>username</parameter> - et <parameter>password</parameter> sont optionnels, et peuvent être ignorés. Dans ce cas, aucune authentification ne sera faites, (connexion anonyme). Cette fonction retourne un index de connexion qui sera utilisée par les autres fonctions Hyperwave. Vous pouvez ouvrir plusieurs connexions simultanées. -</para> - <para> - Voir aussi <function>hw_Connect</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-pipedocument"> - <refnamediv> - <refname>hw_PipeDocument</refname> - <refpurpose>Retourne un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_pipedocument</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne le document Hyperwave d'objet id <parameter>objectID</parameter>. -Si le document a des ancrages, ils seront insérés. Le document sera transmis via -une connexion de données spéciale, qui ne bloque pas la connexion de contrôle (ie, le serveur n'attend pas la fin du transfert pour rendre la main). -</para> - <para> - Voir aussi <function>hw_GetText</function> (insertions), - <function>hw_free_document</function>, - <function>hw_DocumentSize</function>, - <function>hw_DocumentBodyTag</function>, - <function>hw_OutputDocument</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-root"> - <refnamediv> - <refname>hw_Root</refname> - <refpurpose>Object id de la racine.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_root</function></funcdef> - <paramdef><parameter></parameter></paramdef> - </funcsynopsis> - <para> -Retour l' Object id de la racine. Actuellement, cette identifiant est toujours 0. L'ensemble des fils de la racine est celui du serveur courant. -</para> - </refsect1> - </refentry> - - <refentry id="function.hw-unlock"> - <refnamediv> - <refname>hw_Unlock</refname> - <refpurpose>Déverrouille un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_unlock</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Déverrouille un document, et laisse l'accès aux autres utilisateurs.</para> - <para> - Voir aussi <function>hw_GetAndLock</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-who"> - <refnamediv> - <refname>hw_Who</refname> - <refpurpose>Liste des utilisateurs actuellement identifiés.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_who</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un tableau contenant la liste des utilisateurs actuellement connectés au serveur Hyperwave. Chaque élément du tableau est lui même un tableau, qui contient l'identifiant de l'élément, le nom, le système, la date de connexion (onSinceDate), l'heure de connexion (onSinceTime), la durée de connexion (TotalTime ) et self. 'self' contient 1 l'élément est l'utilisateur qui a appelé la fonction. -</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getusername"> - <refnamediv> - <refname>hw_Username</refname> - <refpurpose>Nom de l'utilisateur actuellement identifié.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_getusername</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> - Retourne le nom d'utilisateur utilisé par la connexion.</para> - </refsect1> - </refentry> - - </reference> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -sgml-parent-document:nil -sgml-default-dtd-file:"../manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: ---> + <reference id="ref.hyperwave"> + <title>Fonctions Hyperwave</title> + <titleabbrev>Hyperwave</titleabbrev> + <partintro> + <sect1 id="hw-intro"> + <title>Introduction</title> + <para> + <productname>Hyperwave</productname> a été developpé par + <ulink url="http://www.iicm.edu">IICM</ulink> à Graz. Son nom + original était <acronym>Hyper-G</acronym> et il a pris le nom de + Hyperwave lors de sa commercialisation (en 1996, si mes souvenirs sont bons). + </para> + <para> + Hyperwave n'est pas gratuit. La version actuelle est la 4.1, disponible à + <ulink url="http://www.hyperwave.com/">www.hyperwave.com</ulink>. Une version + limitée à 30 jours peut être demandée. + </para> + <para> + <acronym>HIS</acronym> est un système d'information similaire à + une base de données, (HIS, Hyperwave Information Server). HIS se + concentre sur l'enregistrement et la gestion des documents. Un document peut + être n'importe quelle donnée, qui peut être stockée + dans un fichier. Chaque document est accompagné par un enregistrement. + Cet enregistrement contient des méta données à propos + du document. Ces méta données sont des listes d'attributs qui + peuvent être étendues par l'utilisateur. Un attribut est une paire + clé/valeur de la forme : clé =valeur. L'enregistrement complet + contient autant de paire que le désire l'utilisateur. Le nom d'un + attribut n'a pas besoin d'être unique, c'est à dire qu'une + même clé peut apparaître plusieurs fois dans un + enregistrement. Cela peut être utile si vous devez donner un + titre à votre document en plusieurs langues, par exemple. Dans un + cas pareil, la convention est que chaque valeur de titre est + précédée par deux lettres et deux points, tel que : + 'fr:Titre en français' ou 'ge:Titel in deutsch'. D'autres attributs + comme une description ou des mots clés sont aussi suceptibles de + recourir à ce genre de procédé. Vous pouvez aussi + remplacer l'abréviation de langage par une autre chaîne, + tant qu'elle est séparée de la valeur par les deux points. + </para> + <para> + Chaque enregistrement a une représentation native qui contient toutes + les paires clé/valeur, séparées par un retour à + la ligne. L'extension Hyperwave reconnaît une autre représentation + qui est un tableau associatif, oú les attributs servent de clés. + Les attributs multilingues étant géré sous la forme d'un + autre tableau associatif, dont les clés sont les chaînes de + langue. En fait, tous les attributs multiformes sont gérés + sous la forme de tableau associatif. (Cela n'est pas encore complètement + codé. Uniquement les attributs de titre, description et mot clés + sont traités correctement). + </para> + <para> + En dehors des documents, tous les hyper liens contenus dans un documents sont + enregistrés dans un autre enregistrement. Les hyperliens qui sont + à l'intérieur d'un document en seront supprimés, et + enregistrés dans des objets particuliers, au moment de l'insertion + dans la base de données. L'enregistrement des hyper-liens + contient les informations d'origine et d'objectif. Afin d'accéder + au document original, vous devre lire le document sans les liens, puis lire + les liens, et les réinsérer (les + <function>hw_pipedocument</function> et <function>hw_gettext</function> le + font pour vous. L'avantage de séparer les liens du document est + évident : une fois qu'un document, cible d'un hyperlien, a + été renommé, le liens peut facilement être + modifié. Le document contenant le lien n'est pas modifié + pour autant. Vous pouvez même ajouter un lien à un document sans + le modifier. + </para> + <para> + Dire que <function>hw_pipedocument</function> et <function>hw_gettext</function> + font l'insertion automatiquement n'est pas aussi simple qu'il n'y paraît. + L'insertion implique une certaine hiérarchie de document. Sur un serveur + web, la hiérarchie est fournie par le système de fichiers, mais + Hyperwave dispose de sa propre hiérarchie et les noms de fichiers ne + reflètent pas la position d'un objet dans cette hiérarchie. + Ainsi, la création de liens requière en premier lieu + la construction de la hiérarchie et de l'espace des noms dans + une hiérarchie web et un espace de nom web. La différence + fondamentale entre Hyperwave et le web est qu'il y a une distinction claire + en les noms et la hiérarchie dans Hyperwave. Le nom ne contient aucune + information à propos de la position de l'objet dans la hiérarchie. + Sur le web, le nom contient les informations de localisation dans la + hiérarchie. Cela conduit à deux méthodes de d'accès : + soit la hiérarchie Hyperwave et le nom de l'objet sont inscrit dans + l'URL. Pour simplifier les choses, une deuxième approche est + pratiquée. L'objet Hyperwave de nom 'mon_objet' correspond à + l'URL 'http://hote/mon_objet', peu importe alors oú il est rangé + dans la hiérarchie. Un objet dont le nom est 'parent/mon_objet' peut + être le fils de l'objet 'mon_objet' dans la hiérarchie Hyperwave, + bien que ce soit le contraire en convention web, et cela risque de perturber + l'utilisateur. + </para> + <para> + Ayant pris cette décision, un deuxième problème surgit : + comment faire l'interface avec PHP ? L' URL http://hote/mon_objet n'appelera + aucun script PHP à moins que vous ne demandiez à votre serveur + web de le remplacer par autre chose, comme par exemple : + 'http://host/php3_script/mon_objet' et le script 'php3_script' utilise la + variable $PATH_INFO pour rechercher l'objet 'mon_objet' sur le serveur Hyperwave. + Il y a juste un petit inconvénient , qui peut facilement être + corrigé. Réécrire une URL ne vous permettra aucun + accès aux autres documents du serveur web. Un script de recherche + dans le serveur Hyperwave serait impossible. Il vous faudra donc au moins + une autre règle pour exclure certaines URL, comme par exemple celles + qui commencent par http://host/Hyperwave. Voici de manière simple, + la manière de partager un espace de nom entre un serveur web et un + serveur Hyperwave serveur. + </para> + <para> + Basé sur le mécanisme précédent, on trouve + l'insertion dans les documents. + </para> + <para> + Il est plus compliqué d'avoir PHP ne fonctionne pas comme un module + de serveur, ou un scrip CGI, mais comme une application indépendante. + Dans ce cas, il est utile d'inscrire la hiérarchie et le nom de fichier + Hyperwave dans le système de fichier. Mais comme cela risque d'entrer + en conflit avec le séparateur de dossier ('/'), il faut le remplacer + par un autre caractère,. '_'. + </para> + <para> + Le protocole réseau pour communiquer avec un serveur Hyperwave est + appelé <ulink url="http://www.hyperwave.de/7.17-hg-prot">HG-CSP</ulink> + (Hyper-G Client/Server Protocol). Il est basé sur des messages qui + initie des actions, comme par exemple, lire l'entête de fichier. Dans + les premières versions de Hyperwave Server deux clients natifs + (Harmony, Amadeus) étaient fournis pour permettre la communication + avec le serveur. Ils ont disparu lors de la commercialisation de Hyperwave. + En tant qu'ersatz, un client appelé wavemaster est désormais + fourni. wavemaster est un espèce ce convertisseur de protocole de + <abbrev>HTTP</abbrev> en <abbrev>HG-CSP</abbrev>. L'idée est de faire + toute l'administration de la base et la visualisation des documents par une + interface web. Le wavemaster implémente un jeu d'emplacement pour + certaines actions de personnalisation de l'interface. Ce jeu est appelé + <abbrev>PLACE</abbrev> language. <abbrev>PLACE</abbrev> pêche encore par + le manque de nombreuse fonctions de programmations, et le manque + d'évolutivité. Cela a conduit à l'utilisation de + JavaScript ce qui ne rend pas la vie facile. + </para> + <para> + Que PHP supporte Hyperwave permet de combler ces manques. PHP implémente + tous les messages définis par <abbrev>HG-CSP</abbrev> mais fourni + d'autres commandes puissantes, comme par exemple, celle de lire des documents + complets. + </para> + <para> + Hyperwave dispose de sa propre terminologie pour localiser certaines + informations. Cette terminologie a été largement étendue. + Presque toutes les fonctions utilisent l'un des types de données + suivants : + <itemizedlist> + <listitem> + <simpara> + object ID: un entier, unique pour chaque objet sur le serveur Hyperwave. C'est + aussi un des attributs de l'enregistrement de l'objet (ObjectID).Les object ids + sont souvent utilisées comme paramètre d'entrée pour + spécifier un objet. + </simpara> + </listitem> + <listitem> + <simpara> + object record: Une chaîne contenant des paires clé=valeur. Les + paires sont séparées par un retour à la ligne. Un + enregistrement d'objet peut facilement être converti en tableau, avec + la fonction <function>hw_objrec2array</function>. De nombreuses fonctions + retournent un object records. Ces fonctions ont leur nom qui finit par obj. + </simpara> + </listitem> + <listitem> + <simpara> + object array: Un tableau associatif qui contient tous les attributs d'un objet. + La clé est l'attribut. Si un attribut apparaît plusieurs fois, il + sera représenté sous la forme d'un tableau associatif ou + indexé. Les attributs qui dépendent des langues (comme title, + keyword ou description) seront représentés sous la forme d'un + tableau associatif, dont les clés seront les abréviations de + langues. Tous les autres attributs à valeur multiple prendront la + forme d'un tableau indexé. + </simpara> + </listitem> + <listitem> + <simpara> + hw_document: Ce type est un nouveau type de données, qui contient le + document lui même, comme par exemple HTML, PDF etc. Il est + optimisé pour les documents HTML mais peut s'utiliser avec n'importe + quel format. + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + De nombreuses fonctions qui retournent un tableau d'enregistrements, retournent + aussi un tableau associé, avec des informatiosn statistiques. Ce tableau + est le dernier élément du tableau d'enregistrements. Les + statistiques contiennent les entrées suivantes : + <variablelist> + <varlistentry> + <term>Hidden</term> + <listitem> + <simpara> + Nombre d'objets dont l'attribut PresentationHints est Hidden. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>CollectionHead</term> + <listitem> + <simpara> + Nombre d'objet dont l'attribut PresentationHints est CollectionHead. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>FullCollectionHead</term> + <listitem> + <simpara> + Nombre d'objet dont l'attribut PresentationHints est FullCollectionHead. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>CollectionHeadNr</term> + <listitem> + <simpara> + Index du premier objet du tableau d'enregistrement avec l'attribut + PresentationHints à CollectionHead. + </simpara></listitem> + </varlistentry> + <varlistentry> + <term>FullCollectionHeadNr</term> + <listitem> + <simpara> + Index du premier objet du tableau d'enregistrement avec l'attribut + PresentationHints est FullCollectionHead. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>Total</term> + <listitem> + <simpara> + Total: Nombre d'enregistrements. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + </sect1> + <sect1 id="hw-apache"> + <title>Intégration avec Apache</title> + <para> + L'extension Hyperwave est utilisée de manière optimale lorsque + PHP est compilé comme module Apache. Dans ce cas, le serveur Hyperwave + sous jacent peut être caché quasiment totalement aux utilisateurs, + si Apache utilise son moteur d'écriture. Les explications suivantes vous + éclaireront : + </para> + <para> + Etant donné que PHP avec l'extension Hyperwave et Apache tend à + remplacer la solution native basé sur Wavemaster, je vais supposer que + le serveur Apache servira seulement d'interface Hyperwave. Ce n'est pas + nécessaire, mais cela simplifie grandment la configuration. Le + concept est très simple. Premièrement, vous avez besoin d'un + script PHP qui évalue la variable <envar>PATH_INFO</envar> et + considère que cette valeur est un objet Hyperwave. Appelons ce script + 'Hyperwave'. L'URL + <systemitem role="url">http://votre.hote/Hyperwave/nom_objet</systemitem> + retourne alors l'objet Hyperwave dont le nom est 'nom_objet'. Le script doit + alors réagir suivant le type de l'objet. Si c'est un groupe, il devra + probablement retourner une liste de fils. Si c'est un document, il pourra + retourner son type MIME et son contenu. Une amélioration peut + être obtenue en utilisant le moteur de réécriture d'Apache. + D'un point de vue utilisateur, il est plus direct si l'URL + <systemitem role="url">http://votre.hote/nom_objet</systemitem> + retourne l'objet. La règle de réécriture est simple : + <informalexample> + <programlisting role="apache-conf"> +RewriteRule ^/(.*) /usr/local/apache/htdocs/HyperWave/$1 [L] + </programlisting> + </informalexample> + Maintenant toutes les URL pointent sur un objet Hyperwave. Cela conduit à + un problème simple. Il n'y a pas d'autre façon d'exécuter, + c'est à dire rechercher, un autre script que ce script 'Hyperwave'. + Cela pourra être corrigé avec une autre règle telle que: + <informalexample> + <programlisting role="apache-conf"> +RewriteRule ^/hw/(.*) /usr/local/apache/htdocs/hw/$1 [L] + </programlisting> + </informalexample> + Le dossier <filename class="directory">/usr/local/apache/htdocs/hw</filename> + sera ainsi reservé pour d'autres scripts et fichiers. Assurez vous que + cette règle est évaluée avant la première + règle que nous avons définie. Il y a juste un léger + inconvénient : tous les objets Hyperwave qui commencent par 'hw/' seront + cachés. Alors, assurez vous que vous n'utilisez pas de tels noms. Si vous + avez besoin d'autres dossiers, par exemple, un dossier d'images, ajoutez + simplement d'autres règles. N'oubliez pas de lancer le moteur de + réécriture avec + <informalexample> + <programlisting role="apache-conf"> +RewriteEngine on + </programlisting> + </informalexample> + Mon expérience m'a montré que vous aurez besoin + des scripts suivants : + <itemizedlist> + </simpara> + </listitem> + <listitem> + <simpara> + Retourne l'objet lui même + </simpara> + </listitem> + <listitem> + <simpara> + Pour autoriser la recherche + </simpara> + </listitem> + <listitem> + <simpara> + S'identifier + </simpara> + </listitem> + <listitem> + <simpara> + Choisir une configuration + </simpara> + </listitem> + <listitem> + <simpara> + Un script pour chaque fonction supplémentaire, comme afficher + un objet, afficher des informations sur les utilisateurs, afficher + le statut du serveur, etc... + </simpara> + </listitem> + </itemizedlist> + </para> + </sect1> + <sect1 id="hw-todo"> + <title>A faire</title> + <para> + Il reste encore beaucoup à faire : + <itemizedlist> + <listitem> + <simpara> + La fonction hw_InsertDocument doit être séparée + en deux : <function>hw_insertobject</function> et + <function>hw_putdocument</function>. + </simpara> + </listitem> + <listitem> + <simpara> + Les noms de nombreuses fonctions ne sont pas encore fixés. + </simpara> + </listitem> + <listitem> + <simpara> + La plupart des fonctions requièrent la connexion courante + comme premier paramètre. Cela conduit à beaucoup de frappe + clavier, même si il n'y a souvent qu'une seule connexion en jeu. + Une connexion par défaut améliorerait ceci. + </simpara> + </listitem> + </itemizedlist> + </para> + </sect1> + </partintro> + <refentry id="function.hw-array2objrec"> + <refnamediv> + <refname>hw_Array2Objrec</refname> + <refpurpose>converti un tableau en un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_array2objrec</function></funcdef> + <paramdef>array <parameter>object_array</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_array2objrec</function> onvertit un + <parameter>object_array</parameter> en un objet. Les attributs multiples + tels que 'Title' en différentes langues seront traités + correctement. + </para> + <para> + Voir aussi <function>hw_objrec2array</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-children"> + <refnamediv> + <refname>hw_Children</refname> + <refpurpose>Liste des object ids des objets fils.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_children</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_children</function> retourne un tableau avec des object ids. + Chaque object id est celui d'un des fils du groupe dont l'id est + <parameter>objectID</parameter>. Ce tableau contient tous les fils, + documents et groupes. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-childrenobj"> + <refnamediv> + <refname>hw_ChildrenObj</refname> + <refpurpose>Liste des object records des objets fils.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_childrenobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_childrenobj</function> retourne un tableau avec des + object records. Chaque object records est celui d'un des fils du groupe + dont l'id est <parameter>objectID</parameter>. + Ce tableau contient tous les fils, documents et groupes + </para> + </refsect1> + </refentry> + <refentry id="function.hw-close"> + <refnamediv> + <refname>hw_Close</refname> + <refpurpose>Ferme la connexion Hyperwave.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_close</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_close</function> retourne FALSE si la connexion n'est pas valide, + et sinon, true. Ferme la connexion connection à un serveur Hyperwave. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-connect"> + <refnamediv> + <refname>hw_Connect</refname> + <refpurpose>Ouvre une connexion Hyperwave.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_connect</function></funcdef> + <paramdef>string <parameter>host</parameter></paramdef> + <paramdef>int <parameter>port</parameter></paramdef> + <paramdef>string <parameter>username</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_connect</function> ouvre une connexion Hyperwave et retourne + un identifiant de connexion, en cas de succès, ou false, si la + connexion n'a pas pu être créée. Chaque argument + doit être entouré de guillemets, sauf le numéro de + port. Les arguments <parameter>username</parameter> et + <parameter>password</parameter> sont optionnels, et peuvent être + ignorés. Dans ce cas, aucune identification ne sera faite au niveau + du serveur. Cela revient à s'identifier en tant qu'utilisateur anonyme. + Cette fonction retourne un identifiant de connexion qui sera nécessaire + aux autres fonctions Hyperwave. Vous pouvez avoir plusieurs connexions + simultanées. N'oubliez pas que les mots de passe ne sont pas + cryptés. + </para> + <para> + Voir aussi <function>hw_pconnect</function>.</para> + </refsect1> + </refentry> + <refentry id="function.hw-cp"> + <refnamediv> + <refname>hw_Cp</refname> + <refpurpose>Copie des objets.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_cp</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>array <parameter>object_id_array</parameter></paramdef> + <paramdef>int <parameter>destination_id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_cp</function> copie les objet ayant les objects id + <parameter>object_id_array</parameter>, et crée un groupe + ayant l'object id <parameter>destination_id</parameter>. + </para> + <para> + La valeur retournée est le nombre d'objets copiés. + </para> + <para> + Voir aussi <function>hw_mv</function>.</para> + </refsect1> + </refentry> + <refentry id="function.hw-deleteobject"> + <refnamediv> + <refname>hw_Deleteobject</refname> + <refpurpose>Efface des objets.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_deleteobject</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>object_to_delete</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_deleteobject</function> efface l'objet dont l'identifiant est + <parameter>object_to_delete</parameter>. Toutes les instances de l'objets + seront effacées. + </para> + <para> + Retourne TRUE si aucune erreur ne survient, et sinon, FALSE. + </para> + <para> + Voir aussi <function>hw_mv</function>.</para> + </refsect1> + </refentry> + <refentry id="function.hw-docbyanchor"> + <refnamediv> + <refname>hw_DocByAnchor</refname> + <refpurpose>Identifiant d'objet de l'objet dans l'ancrage.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_docbyanchor</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>anchorID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_docbyanchor</function> retourne l'dentifiant d'objet de + l'objet dans l'ancrage <parameter>anchorID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-docbyanchorobj"> + <refnamediv> + <refname>hw_DocByAnchorObj</refname> + <refpurpose>Attributs de l'objet dans l'ancrage.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_docbyanchorobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>anchorID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_docbyanchorobj</function> retourne les attributs du + document qui correspond à <parameter>anchorID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-documentattributes"> + <refnamediv> + <refname>hw_DocumentAttributes</refname> + <refpurpose>Object record de hw_document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_documentattributes</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_documentattributes</function> retourne les attributs du document. + </para> + <para> + Voir aussi <function>hw_documentbodytag</function>, + <function>hw_documentsize</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-documentbodytag"> + <refnamediv> + <refname>hw_DocumentBodyTag</refname> + <refpurpose>Balise de corps d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_documentbodytag</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_documentbodytag</function> retourne la balise BODY du + document.Si le document est un document HTML , la balise BODY doit + être affichée avant le document. + </para> + <para> + Voir aussi <function>hw_documentattributes</function>, + <function>hw_documentsize</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-documentcontent"> + <refnamediv> + <refname>hw_DocumentContent</refname> + <refpurpose>Contenu d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_documentcontent</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_documentcontent</function> retourne la balise BODY du + document.Si le document est un document HTML , la balise BODY doit + être affichée avant le document. + </para> + <para> + Voir aussi <function>hw_documentattributes</function>, + <function>hw_documentsize</function>, + <function>hw_documentsetcontent</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-documentsetcontent"> + <refnamediv> + <refname>hw_DocumentSetContent</refname> + <refpurpose>Modifie/remplace le contenu d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_documentsetcontent</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + <paramdef>string <parameter>content</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_documentsetcontent</function> modifie/remplace le contenu + d'un document. Si le document est un document HTML, le contenu + représente tout qui est placé au dela de la balise BODY. + Les informations de HEAD et de la balise BODY sont enregistrés + dans les attributs. Si vous fournissez aussi ces informations dans le + corps du document, le serveur Hyperwave modifiera les attributs. Cela + n'est cependant pas une bonne idée. Si la fonction échoue, + l'ancien contenu est restauré. + </para> + <para> + Voir aussi <function>hw_documentattributes</function>, + <function>hw_documentsize</function>, + <function>hw_documentcontent</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-documentsize"> + <refnamediv> + <refname>hw_DocumentSize</refname> + <refpurpose>Taille d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_documentsize</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_documentsize</function> retourne la taille du document + en octets. + </para> + <para> + Voir aussi <function>hw_documentbodytag</function>, + <function>hw_documentattributes</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-errormsg"> + <refnamediv> + <refname>hw_ErrorMsg</refname> + <refpurpose>Retourne un message d'erreur.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_errormsg</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_errormsg</function> retourne une chaîne contenant + le dernier message d'erreur, ou 'No Error' (pas d'erreur). Si FALSE + est retourné, cette fonction a échoué. Ce message + est relatif à la dernière commande exécutée. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-edittext"> + <refnamediv> + <refname>hw_EditText</refname> + <refpurpose>Retourne un document texte.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_edittext</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_edittext</function> charge le texte du document sur le + serveur. Les attributs du document ne doivent pas être + modifiés tant que le document est en train d'être + édité. Cette fonction n'est disponible que sur les + documents texte. Elle n'ouvrira pas de canal de transfert, et donc, + bloquera le script durant le transfert. + </para> + <para> + Voir aussi <function>hw_pipedocument</function>, + <function>hw_free_document</function>, + <function>hw_documentbodytag</function>, + <function>hw_documentsize</function>, + <function>hw_outputdocument</function>, + <function>hw_gettext</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-error"> + <refnamediv> + <refname>hw_Error</refname> + <refpurpose>Retourne le code d'erreur.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_error</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_error</function> retourne le code d'erreur de la dernière + erreur. Si la valeur 0 est retournée, c'est qu'il n'y avait pas d'erreur. + L'erreur se rapporte à la dernière commande. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-free-document"> + <refnamediv> + <refname>hw_Free_Document</refname> + <refpurpose>Détruit un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_free_document</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_free_document</function> détruit un document Hyperwave. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getparents"> + <refnamediv> + <refname>hw_GetParents</refname> + <refpurpose>Identifiant d'objet des parents.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getparentsobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getparentsobj</function> retourne un tableau indexé + avec les identifiants des objets parents de <parameter>objectID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getparentsobj"> + <refnamediv> + <refname>hw_GetParentsObj</refname> + <refpurpose>Attributs des parents.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getparentsobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getparentsobj</function> retourne un tableau indexé, + avec les attributs et un tableau associé, d'informations statistiques + à propos des attributs. Ce tableau associé est le dernier + élément du tableau retourné. Chaque attribut + appartient au père de l'objet <parameter>objectID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getchildcoll"> + <refnamediv> + <refname>hw_GetChildColl</refname> + <refpurpose>Identifiant d'objet des groupes fils.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getchildcoll</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getchildcoll</function> retourne un tableau contenant les + identifiants d'objets des groupes fils du groupe + <parameter>objectID</parameter>. Cette fonction ne retournera pas + d'identifiants d'objets des documents fils. + </para> + <para> + Voir aussi <function>hw_getchilddoccoll</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getchildcollobj"> + <refnamediv> + <refname>hw_GetChildCollObj</refname> + <refpurpose>object records d'un groupe d'enfants.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getchildcollobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getchildcollobj</function> retourne un tableau d'object record. + Chaque object records appartient à un groupe d'enfants de la + collection <parameter>objectID</parameter>. La fonction ne retournera pas + de documents enfants. + </para> + <para> + Voir aussi <function>hw_childrenobj</function>, + <function>hw_getchilddoccollobj</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getremote"> + <refnamediv> + <refname>hw_GetRemote</refname> + <refpurpose>Retourne un document distant.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_getremote</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getremote</function> retourne un document distant. Les documents + distants sont , en Hyperwave, des documents lus depuis une source externe. La + plus part des documents éloignés sont des pages web externes, ou + des requêtes sur une base de données. Afin de pouvoir + accéder à des sources externes, grâces aux documents distants, + Hyperwave introduit l'interface HGI (Hyperwave Gateway Interface) qui est + similaire à CGI. Actuellement, seuls les protocoles de ftp, http et + certaines bases de données sont accessibles avec HGI. + <function>hw_getremote</function> retourne le document de la source + distante. Si vous voulez utiliser cette fonction, il vous faut vous + familiariser HGIs. Il est aussi préférable d'utiliser + PHP plutôt que Hyperwave pour accéder aux sources externes. + Le support des bases de données sera plus difficile avec Hyperwave + que PHP. + </para> + <para> + Voir aussi <function>hw_getremotechildren</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getremotechildren"> + <refnamediv> + <refname>hw_GetRemoteChildren</refname> + <refpurpose>Retourne les fils d'un document distant.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_getremotechildren</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>string <parameter>object record</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getremotechildren</function> retourne les fils d'un document + distant. Les fils d'un document distant sont des documents distants eux + mêmes. Cela est cohérent si une requête sur une base + de données doit être rendu plus sélective, comme + expliqué dans Hyperwave Programmers' Guide. Si le nombre de fils + est 1 la fonction va retourner le document lui même, la fonction + retournera le document lui même, formaté Hyperwave Gateway + Interface (HGI). Si le nombre de fils est supérieur 1 la fonction + retournera un tableau d'attributs, qui pourra servir à une nouvelle + requête avec <function>hw_getremotechildren</function>. Ces attributs + sont virtuels et n'existent pas sur le serveur Hyperwave, et ainsi, n'ont pas + d'identifiant d'objet valide. L'ordre exact de ces objets est du ressort de HGI. + Si vous voulez utiliser cette fonction, vous devez être très + familier HGIs. Il vaut mieux PHP plutôt que Hyperwave pour accéder + aux fichiers distants. Le support de base de données y est bien meilleur. + </para> + <para> + Voir aussi <function>hw_getremote</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getsrcbydestobj"> + <refnamediv> + <refname>hw_GetSrcByDestObj</refname> + <refpurpose>Retourne les ancrages qui pointent sur un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getsrcbydestobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getsrcbydestobj</function> retourne les attributs de tous + les ancrages qui pointent sur <parameter>objectID</parameter>. L'objet + peut être un document ou un autre ancrage, de type destination. + </para> + <para> + Voir aussi <function>hw_getanchors</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getobject"> + <refnamediv> + <refname>hw_GetObject</refname> + <refpurpose>Attributs d'un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getobject</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>[int|array] <parameter>objectID</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getobject</function> retourne les attributs de l'objet dont + l'identifiant est <parameter>objectID</parameter>, si le second + paramètre est un entier. Si le second paramètre est un + tableau, la fonction retournera un tableau d'attributs. Dans ce cas, + le dernier paramètre est aussi évalué. + </para> + <para> + <parameter>query</parameter> a la syntaxe suivante : + </para> + <simpara> + <expression> ::= "(" <expression> ")" | + </simpara> + <simpara> + "!" <expression> | /* NOT */ + </simpara> + <simpara> + <expression> "||" <expression> | /* OR */ + </simpara> + <simpara> + <expression> "&&" <expression> | /* AND */ + </simpara> + <simpara> + <attribute> <operator> <value> + </simpara> + <simpara> + <attribute> ::= /* * n'importe quel attribut (Title, Author, DocumentType ...) */ + </simpara> + <simpara> + <operator> ::= "=" | /* égal */ + </simpara> + <simpara> + "<" | /* moins que (comparaison de type chaîne) */ + </simpara> + <simpara> + ">" | /* plus que (comparaison de type chaîne) */ + </simpara> + <simpara> + "~" /* recherche par expression régulière */ + </simpara> + <simpara> + </simpara> + <para> + <parameter>query</parameter> permet de sélectionner une nouvelle fois + certains objets dans la liste des objets donnés. Contrairement aux + autres requêtes, celle ci peut utiliser des attributs non indexés. + Le nombre d'attributs retourné dépend de la requête de la + requête, et des autorisations d'accès aux objets. + </para> + <para> + Voir aussi <function>hw_getandlock</function>, + <function>hw_getobjectbyquery</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getandlock"> + <refnamediv> + <refname>hw_GetAndLock</refname> + <refpurpose>Retourne les attributs, et verrouille l'objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_getandlock</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getandlock</function> retourne les attributs, et verrouille + l'objet <parameter>objectID</parameter>. Le verrouillage empêchera + les autres utilisateurs d'y accéder, jusqu'à ce qu'il soit + deverrouillé. + </para> + <para> + Voir aussi <function>hw_unlock</function>, + <function>hw_getobject</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-gettext"> + <refnamediv> + <refname>hw_GetText</refname> + <refpurpose>Retourne un document texte.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_gettext</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + <paramdef>mixed + <parameter> + <optional>rootID/prefix</optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_gettext</function> retourne le document de l'objet + <parameter>objectID</parameter>. Si le document possède des ancrages + qui peuvent être insérés, ils seront déjà + insérés. L'option rootID/prefix peut être une + chaîne ou un entier. Si c'est un entier, il détermine la + méthode d'insertion des liens dans le document. Par défaut, + il vaut 0 et les liens seront construits en fonction du nom de l'objet cible. + Cela sert beaucoup dans les applications web. Si un lien pointe sur un objet + avec le nom 'film_internet' le lien HTML sera <A HREF="/internet_movie">. + La position réelle de la source et de la cible dans la hiérarchie + seront ignorés. Vous devrez modificer votre site web pour qu'il + réécrive les URL, comme par exemple + '/mon_script.php3/film_internet'. 'mon_script.php3' devra analyser + $PATH_INFO et savoir recherche le document '/mon_script.php3/film_internet'. + Si vous ne voulez pas de ce comportement, vous pouvez affecter à + rootID/prefix n'importe quel prefixe. Dans ce cas, ce sera une chaîne. + </para> + <para> + Si <parameter>rootID/prefix</parameter> est un entier différent de 0 + le lien sera construit avec tous les noms de la hiérarchie, en + commencant à l'objet d'identifiant rootID/prefix, et séparé + par des slash. Si, par exemple, le document 'film_internet' est situé + à 'a-b-c-internet_movie' et '-' qui sert de séparateur + hiérarchique de niveau sur le serveur Hyperwave et le document + source est situé dans 'a-b-d-source' alors, le lien HTML serait: + <A HREF="../c/internet_movie">. Cela est très pratique si vous + voulez télécharger tout le contenu d'un serveur sur un disque, + et faire une carte du système sur votre disque. + </para> + <para> + <function>hw_gettext</function> n'est opérationnelle qu'avec des + documents de pur texte. Elle n'ouvrira pas de canal spécial de + transfert, et ainsi, bloquera le script le temps du transfert. + </para> + <para> + Voir aussi <function>hw_pipedocument</function>, + <function>hw_free_document</function>, + <function>hw_documentbodytag</function>, + <function>hw_documentsize</function>, + <function>hw_outputdocument</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getobjectbyquery"> + <refnamediv> + <refname>hw_GetObjectByQuery</refname> + <refpurpose>Recherche un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getobjectbyquery</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> + <paramdef>int <parameter>max_hits</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getobjectbyquery</function> recherche un objet sur tout le serveur + et retourne un tableau d' object ids. Le nombre maximum d'objet est limité + par <parameter>max_hits</parameter>. Si <parameter>max_hits</parameter> vaut -1 + il n'y a pas de limite. + </para> + <para> + La requête ne fonctionnera qu'avec des attributs indexés. + </para> + <para> + Voir aussi <function>hw_getobjectbyqueryobj</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getobjectbyqueryobj"> + <refnamediv> + <refname>hw_GetObjectByQueryObj</refname> + <refpurpose>Recherche un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getobjectbyqueryobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> + <paramdef>int <parameter>max_hits</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getobjectbyqueryobj</function> recherche un objet sur tout le + serveur et retourne un tableau d' object records. Le nombre maximum d'objet + est limité par <parameter>max_hits</parameter>. Si + <parameter>max_hits</parameter> vaut -1 il n'y a pas de limite. + </para> + <para> + La requête ne fonctionnera qu'avec des attributs indexés. + </para> + <para> + Voir aussi <function>hw_getobjectbyquery</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getobjectbyquerycoll"> + <refnamediv> + <refname>hw_GetObjectByQueryColl</refname> + <refpurpose>Recherche un objet dans un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getobjectbyquerycoll</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> + <paramdef>int <parameter>max_hits</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getobjectbyquerycoll</function> recherche un objet sur tout + le groupe objectID et retourne un tableau d' object records. Le nombre + maximum d'objet est limité par <parameter>objectID</parameter>. Si + <parameter>objectID</parameter> vaut -1 il n'y a pas de limite. + </para> + <para> + La requête ne fonctionnera qu'avec des attributs indexés. + </para> + <para> + Voir aussi <function>hw_getobjectbyquerycollobj</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getobjectbyquerycollobj"> + <refnamediv> + <refname>hw_GetObjectByQueryCollObj</refname> + <refpurpose>Recherche un objet dans un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getobjectbyquerycollobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> + <paramdef>int <parameter>max_hits</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getobjectbyquerycollobj</function> recherche un objet sur tout + le groupe objectID et retourne un tableau d' object records. Le nombre maximum + d'objet est limité par <parameter>objectID</parameter>. Si + <parameter>objectID</parameter> vaut -1 il n'y a pas de limite. + </para> + <para> + La requête ne fonctionnera qu'avec des attributs indexés. + </para> + <para> + Voir aussi <function>hw_getobjectbyquerycoll</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getchilddoccoll"> + <refnamediv> + <refname>hw_GetChildDocColl</refname> + <refpurpose>ids des documents fils d'un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getchilddoccoll</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getchilddoccoll</function> retourne un tableau avec les id + des documents fils d'une collection. + </para> + <para> + Voir aussi <function>hw_getchildcoll</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getchilddoccollobj"> + <refnamediv> + <refname>hw_GetChildDocCollObj</refname> + <refpurpose>Attributs des documents fils d'un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getchilddoccollobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getchilddoccollobj</function> retourne un tableau contenant + les attributs des documents fils du groupe <parameter>objectID</parameter>. + </para> + <para> + Voir aussi <function>hw_childrenobj</function>, + <function>hw_getchildcollobj</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getanchors"> + <refnamediv> + <refname>hw_GetAnchors</refname> + <refpurpose>Identifiants des ancrages d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getanchors</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getanchors</function> retourne un tableau contenant les + identifiants des ancrages du document <parameter>objectID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getanchorsobj"> + <refnamediv> + <refname>hw_GetAnchorsObj</refname> + <refpurpose>Attributs des ancrages d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getanchorsobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getanchorsobj</function> retourne un tableau d'attributs + des ancrages du document <parameter>objectID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-mv"> + <refnamediv> + <refname>hw_Mv</refname> + <refpurpose>Déplace un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_mv</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>array <parameter>object id array</parameter></paramdef> + <paramdef>int <parameter>source id</parameter></paramdef> + <paramdef>int <parameter>destination id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_mv</function> déplaces les objets dont les identifiants + sont passés dans le tableau <parameter>source id</parameter>, depuis + le <parameter>source id</parameter> dans le + <parameter>destination id</parameter>. Si destination id vaut 0, les objets + ne seront plus insérés dans le groupe (ni dans le serveur). + Dans ce cas, si une instance était la dernière instance d'un + objet, l'objet sera effacé. Si vous voulez effacer toutes les instances + d'un coup, utilisez <function>hw_deleteobject</function>. + </para> + <para> + La valeur retournée est le nombre d'objet déplacés. + </para> + <para> + Voir aussi <function>hw_cp</function>, + <function>hw_deleteobject</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-identify"> + <refnamediv> + <refname>hw_Identify</refname> + <refpurpose>Identifie un utilisateur.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_identify</function></funcdef> + <paramdef>string <parameter>username</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_identify</function> identifie un utilisateur, dont le nom + d'utilisateur est <parameter>username</parameter> et le mot de passe + <parameter>password</parameter>. L'identification n'est valide + que pour la session en cours. Je ne pense pas que cette fonction serve + souvent. Dans la plus part des cas, il est plus simple de s'identifier lors + de l'ouverture de la connexion. + </para> + <para> + Voir aussi <function>hw_connect</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-incollections"> + <refnamediv> + <refname>hw_InCollections</refname> + <refpurpose> + Vérifie qu'un identifiant d'objet est dans un groupe. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_incollections</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>array <parameter>object_id_array</parameter></paramdef> + <paramdef>array <parameter>collection_id_array</parameter></paramdef> + <paramdef>int <parameter>return_collections</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_incollections</function> vérifie qu'un ensemble d'objets + (documents ou groupes) donnés par <parameter>object_id_array</parameter> + fait partie des groupe listés par <parameter>object_id_array</parameter>. + Lorsque le quatrième paramètre + <parameter>return_collections</parameter> vaut 0, le sous ensemble + d'identifiants qui font partie d'un groupe (i.e. les documents ou groupes + qui sont fils d'un ou plusieurs groupe, ou leurs fils, récurusivement) + est retourné sous la forme d'un tableau. Cette option permet de mettre + en valeur la partie de l'arborescence qui contient le résultat d'une + requête, dans un sens graphique. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-info"> + <refnamediv> + <refname>hw_Info</refname> + <refpurpose>Informations à propos d'une connexion.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_info</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_info</function> retourne les informations de la connexion + courante. La chaîne retournée a le format suivant : + <Serverstring>, <Host>, <Port>, <Username>, + <Port of Client>, <Byte swapping> + </para> + </refsect1> + </refentry> + <refentry id="function.hw-inscoll"> + <refnamediv> + <refname>hw_InsColl</refname> + <refpurpose>Insère un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_inscoll</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + <paramdef>array <parameter>object_array</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_inscoll</function> insère un nouveau groupe, avec + les attributs <parameter>object_array</parameter> dans le groupe + <parameter>objectID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-insdoc"> + <refnamediv> + <refname>hw_InsDoc</refname> + <refpurpose>Insère un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_insdoc</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>parentID</parameter></paramdef> + <paramdef>string <parameter>object_record</parameter></paramdef> + <paramdef>string <parameter>text</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_insdoc</function> insère un nouveau document avec + les attributs <parameter>object_record</parameter>, dans le groupe + <parameter>parentID</parameter>. Cette fonction insère soit un objet + avec ses seuls attributs, soit pur objet ascii, avec + <parameter>text</parameter> si il est fourni. Si vous voulez insérer + un document de type général, utilisez plutôt + <function>hw_insertdocument</function>. + </para> + <para> + Voir aussi <function>hw_insertdocument</function>, + <function>hw_inscoll</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-insertdocument"> + <refnamediv> + <refname>hw_InsertDocument</refname> + <refpurpose>Insère un document dans un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_insertdocument</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>parent_id</parameter></paramdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_insertdocument</function> insère un document dans le + groupe <parameter>parent_id</parameter>. Le document doit avoir + été créé auparavant avec + <function>hw_new_document</function>. Assurez vous que les attributs du + nouveau document contiennent au moins les attributs suivants : + Type, DocumentType, Title et Name. Vous aurez aussi parfois besoin de + MimeType. La fonction retourne l'identifiant de l'objet inséré, + ou bien false. + </para> + <para> + Voir aussi <function>hw_pipedocument</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-insertobject"> + <refnamediv> + <refname>hw_InsertObject</refname> + <refpurpose>Insère un object record.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_insertobject</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>string <parameter>object rec</parameter></paramdef> + <paramdef>string <parameter>parameter</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_insertobject</function> insère un objet dans + le serveur. L'objet peut être n'importe quel objet Hyperwave + valide. Reportez vous à la documentation HG-CSP pour plus + de détails sur les paramètres. + </para> + <para> + Note: Si vous voulez insérer un ancre, l'attribut Position + doit être mis à la valeur start/end (début ou + fin) ou encore 'invisible'. Les positions invisibles sont nécessaire + si l'annotation n'a pas de liens correspondant dans le texte de + l'annotation. + </para> + <para> + Voir aussi <function>hw_pipedocument</function>, + <function>hw_insertdocument</function>, + <function>hw_insdoc</function>, + <function>hw_inscoll</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-mapid"> + <refnamediv> + <refname>hw_mapid</refname> + <refpurpose>Représente un id globale en un id virtuel local.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_mapid</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>server id</parameter></paramdef> + <paramdef>int <parameter>object id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_mapid</function> représente l'id d'un objet global de n'importe + quel serveur Hyperwave, même si vous ne vous y êtes pas + connecté avec <function>hw_connect</function>, avec un id d'objet + local virtuel. Cet id d'objet local peut alors être utilisé + comme n'importe quel id d'objet : par exemple on peut obtenir l'enregistrement + d'objet avec la fonction <function>hw_getobject</function>. L'id du serveur + est la première partie de l'id global (GOid) de l'objet, qui est en + fait une adresse IP. + </para> + <para> + Note: Afin d'utiliser cette fonction, vous devez lever le flag F_DISTRIBUTED, + ce qui ne peut être fait qu'à la compilation. Par défaut, + il n'est pas levé. Lisez les commentaires dans le fichier hg_comm.c + </para> + </refsect1> + </refentry> + <refentry id="function.hw-modifyobject"> + <refnamediv> + <refname>hw_Modifyobject</refname> + <refpurpose>Modifie les attributs d'objet record.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_modifyobject</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>object_to_change</parameter></paramdef> + <paramdef>array <parameter>remove</parameter></paramdef> + <paramdef>array <parameter>add</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_modifyobject</function> permet d'effacer, d'ajouter ou de + modifier les attributs d'un objet. L'objet est reperé par son + identifiant <parameter>object_to_change</parameter>. Le premier tableau, + <parameter>remove</parameter>, est la liste des attributs à effacer. + Le deuxième tableau <parameter>add</parameter> est la liste des + attributs à ajouter. Afin de modifier un attribut, il vous faudra + dont l'effacer, puis l'ajouter à nouveau. + <function>hw_modifyobject</function> effacera toujours les attributs avant + de les ajouter, à moins que la valeur de l'attribut à effacer + ne soit pas une chaîne, ou un tableau. + </para> + <para> + Le dernier paramètre détermine si la modification est + récursive ou pas. 1 signigie que la modification est récursive. + Si un objet ne peut pas être modifié, il sera ignoré. + <function>hw_error</function> n'indiquera alors pas toujours d'erreur, + même si certains objets n'ont pas pu être modifié. + </para> + <para> + Les clés des deux tableaux sont les noms des attributs. La valeurs + de chaque élément peut être un tableau, ou une chaîne + ou n'importe quoi d'autre. Dans le cas du tableau, la valeur de l'attribut + est construite en séparant chaque élément par un + point virgule. Dans le cas de la chaîne, elle sert directement de + valeur. Une chaîne vide provoquera un effacement de l'attribut. + Dans le cas oú la valeur n'est ni un tableau, ni une chaîne, + aucune opération ne sera effectuée. Cela est nécessaire + si vous voulez ajouter un attribut complètement une nouvelle valeur pour + un attribut existant. Si le tableau d'effacement contenait une chaîne + vide comme attribut, le serveur tenterait d'effacer l'attribut, ce qui + échouerai de toute manière, car cet attribut n'existe pas. + L'ajout de cet attribut échouerai aussi. Affecter la valeur de 0 + à cet attribut ne l'effacerait pas, et l'ajout fonctionnerait. + </para> + <para> + Si vous voulez changer l'attribut 'Nom' de valeur courante 'livres' en + 'articles' vous devrez faire deux tableaux, et appeler + <function>hw_modifyobject</function>. + <example> + <title>Modification d'un attribut</title> + <programlisting role="php"> + // $connect est une connexion valide + // $objid est l'identifiant de l'objet + $remarr = array("Name" => "books"); + $addarr = array("Name" => "articles"); + $hw_modifyobject($connect, $objid, $remarr, $addarr); + </programlisting> + </example> + Afin d'effacer/ajouter une paire nom=valeur aux attributs d'un objet, + utilisez simplement les tableaux d'effacement et d'ajout, et laissez + le dernier/troisième paramètre vide. Si l'attribut est + le premier de ce nom à ajouter, donnez une valeur entière + à cet élément. + <example> + <title>Ajouter un nouvel attribut</title> + <programlisting role="php"> + // $connect st une connexion Hyperwave valide + // $objid est l'identifiant de l'objet à modifier + $remarr = array("Name" => 0); + $addarr = array("Name" => "articles"); + $hw_modifyobject($connect, $objid, $remarr, $addarr); + </programlisting> + </example> + </para> + <para> + <note> + <simpara> + Les attributs multilingues, (tels que 'Title'), peuvent être + modifiés de deux manières : soit en fournissant la + valeur de ces attributs de manière native (langue :valeur), + soit en fournissant un tableau avec les éléments de + chaque langue, comme décrit ci-dessus. L'exemple deviendrai + alors : + </simpara> + </note> + <example> + <title>Modifier l'attribut de Titre (Title)</title> + <programlisting role="php"> + $remarr = array("Title" => "en:Books"); + $addarr = array("Title" => "en:Articles"); + $hw_modifyobject($connect, $objid, $remarr, $addarr); + </programlisting> + </example> + ou + <example> + <title>Modifier l'attribut Title</title> + <programlisting role="php"> + $remarr = array("Title" => array("en" => "Books")); + $addarr = array("Title" => array("en" => "Articles", "ge"=>"Artikel")); + $hw_modifyobject($connect, $objid, $remarr, $addarr); + </programlisting> + </example> + Pour supprimer l'entrée française 'Livres' et ajouter + l'entrée 'Articles' et l'entrée allemande 'Artikel'. + <example> + <title>Suppression d'un attribut</title> + <programlisting role="php"> + $remarr = array("Title" => ""); + $addarr = array("Title" => "en:Articles"); + $hw_modifyobject($connect, $objid, $remarr, $addarr); + </programlisting> + </example> + <note> + <simpara> + Cet exemple va effacer tous les attributs avec le nom 'Title' et ajouter + un nouvel attribut 'Title'. Cela peut être pratique pour effacer des + attributs récursivement. + </simpara> + </note> + <note> + <simpara> + Si vous devez effacer tous les attributs avec un certains nom, vous devez + passer une chaîne vide comme valeur. + </simpara> + </note> + <note> + <simpara> + Seuls les attributs 'Title', 'Description' et 'Keyword' gère + correctement le préfixe de langue. Pour les autres attributs qui + ne portent pas de préfixe de language, le préfixe 'xx' sera + assigné. + </simpara> + </note> + <note> + <simpara> + L'attribut 'Name' est un peu particuluer. Dans certains cas, il ne peut pas + être complétement effacé. Vous aurez alors le message + 'Change of base attribute' (l'apparition de cette erreur n'est pas très + claire). Ainsi, vous aurez à ajouter une nouvelle entrée pour + Name puis, effacer l'ancien. + </simpara> + </note> + <note> + <simpara> + Il ne faut pas encadrer cette fonction par des appels à + <function>hw_getandlock</function> et <function>hw_unlock</function>. + <function>hw_modifyobject</function> le fait de manière interne. + </simpara> + </note> + </para> + <para> + Retourne TRUE si aucune erreur ne survient, et FALSE sinon. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-new-document"> + <refnamediv> + <refname>hw_New_Document</refname> + <refpurpose>Crée un nouveau document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_new_document</function></funcdef> + <paramdef>string <parameter>object_record</parameter></paramdef> + <paramdef>string <parameter>document_data</parameter></paramdef> + <paramdef>int <parameter>document_size</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_new_document</function> retourne un nouveau document Hyperwave + avec comme données <parameter>document_data</parameter> et comme + attributs <parameter>object_record</parameter>. La longueur de + <parameter>document_data</parameter> doit être données dans + <parameter>document_size</parameter>. Cette fonction n'insère pas + l'objet dans le serveur Hyperwave. + </para> + <para> + Voir aussi <function>hw_free_document</function>, + <function>hw_documentsize</function>, + <function>hw_documentbodytag</function>, + <function>hw_outputdocument</function>, + <function>hw_insertdocument</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-objrec2array"> + <refnamediv> + <refname>hw_Objrec2Array</refname> + <refpurpose>Converti les attributs d'un objet en tableau.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_objrec2array</function></funcdef> + <paramdef>string <parameter>object_record</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_objrec2array</function> convertit les attributs + <parameter>object_record</parameter> d'un objet en un tableau. Les + clés du tableau seront les noms des attributs. Les attributs + multiples comme par exemple 'Title', dans différentes langues, + seront rassemblées dans un autre tableau. Une clé est la + partie gauche d'un attribut. Actuellement, seuls les attributs 'Title', + 'Description' et 'Keyword' sont traités correctement. + </para> + <para> + Voir aussi <function>hw_array2objrec</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-outputdocument"> + <refnamediv> + <refname>hw_OutputDocument</refname> + <refpurpose>Affiche hw_document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_outputdocument</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_outputdocument</function> affiche <parameter>hw_document</parameter> + sans la balise BODY. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-pconnect"> + <refnamediv> + <refname>hw_pConnect</refname> + <refpurpose>Crée une connexion persistante.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_pconnect</function></funcdef> + <paramdef>string <parameter>host</parameter></paramdef> + <paramdef>int <parameter>port</parameter></paramdef> + <paramdef>string <parameter>username</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_pconnect</function> retourne un index de connexion en cas de + succès, et FALSE si la connexion n'a pas pu être créée. + Ouvre une connexion persistante à un serveur Hyperwave. Tous les + arguments doivent être entre guillemets, hormis le numéro + de port (port). Les arguments <parameter>username</parameter> et + <parameter>password</parameter> sont optionnels, et peuvent être + ignorés. Dans ce cas, aucune authentification ne sera faites, + (connexion anonyme). Cette fonction retourne un index de connexion qui + sera utilisée par les autres fonctions Hyperwave. Vous pouvez + ouvrir plusieurs connexions simultanées. + </para> + <para> + Voir aussi <function>hw_connect</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-pipedocument"> + <refnamediv> + <refname>hw_PipeDocument</refname> + <refpurpose>Retourne un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_pipedocument</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_pipedocument</function> retourne le document Hyperwave d'objet + id <parameter>objectID</parameter>. Si le document a des ancrages, ils seront + insérés. Le document sera transmis via une connexion de + données spéciale, qui ne bloque pas la connexion de + contrôle (ie, le serveur n'attend pas la fin du transfert pour + rendre la main). + </para> + <para> + Voir aussi <function>hw_gettext</function> (insertions), + <function>hw_free_document</function>, + <function>hw_documentsize</function>, + <function>hw_documentbodytag</function>, + <function>hw_outputdocument</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-root"> + <refnamediv> + <refname>hw_Root</refname> + <refpurpose>Object id de la racine.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_root</function></funcdef> + <paramdef><parameter></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_root</function> retourne l' object id de la racine. + Actuellement, cette identifiant est toujours 0. L'ensemble des fils + de la racine est celui du serveur courant. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-unlock"> + <refnamediv> + <refname>hw_Unlock</refname> + <refpurpose>Déverrouille un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_unlock</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_unlock</function> déverrouille un document, et laisse + l'accès aux autres utilisateurs. + </para> + <para> + Voir aussi <function>hw_getandlock</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-who"> + <refnamediv> + <refname>hw_Who</refname> + <refpurpose>Liste des utilisateurs actuellement identifiés.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_who</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_who</function> retourne un tableau contenant la liste des + utilisateurs actuellement connectés au serveur Hyperwave. Chaque + élément du tableau est lui même un tableau, qui contient + l'identifiant de l'élément, le nom, le système, la date + de connexion (onSinceDate), l'heure de connexion (onSinceTime), la + durée de connexion (TotalTime ) et self. 'self' contient + l'élément est l'utilisateur qui a appelé la fonction. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getusername"> + <refnamediv> + <refname>hw_Username</refname> + <refpurpose>Nom de l'utilisateur actuellement identifié.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_getusername</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getusername</function> retourne le nom d'utilisateur + utilisé par la connexion. + </para> + </refsect1> + </refentry> + </reference> +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +-->
Index: phpdoc/fr/functions/hw.xml diff -u phpdoc/fr/functions/hw.xml:1.2 phpdoc/fr/functions/hw.xml:1.3 --- phpdoc/fr/functions/hw.xml:1.2 Sat Jul 22 06:43:41 2000 +++ phpdoc/fr/functions/hw.xml Thu Nov 30 02:27:38 2000 @@ -1,1614 +1,2025 @@ - <reference id="ref.hyperwave"> - <title>Fonctions Hyperwave</title> - <titleabbrev>Hyperwave</titleabbrev> - - <partintro> - - <sect1 id="hw-intro"> - <title>Introduction</title> - <para> - <productname>Hyperwave</productname> a été developpé par - <ulink url="http://www.iicm.edu">IICM</ulink> à Graz. Son nom original était - <acronym>Hyper-G</acronym> et il a pris le nom de Hyperwave lors de sa - commercialisation (en 1996, si mes souvenirs sont bons). - </para> - <para> - Hyperwave n'est pas gratuit. La version actuelle est la 4.1, disponible à - <ulink url="http://www.hyperwave.com/">www.hyperwave.com</ulink>. Une version - limitée à 30 jours peut être demandée. - </para> - <para> - <acronym>HIS</acronym> est un système d'information similaire à une base de - données, (HIS, Hyperwave Information Server). HIS se concentre sur l'enregistrement - et la gestion des documents. Un document peut être n'importe quelle donnée, qui - peut être stockée dans un fichier. Chaque document est accompagné par un - enregistrement. Cet enregistrement contient des méta données à propos du document. - Ces méta données sont des listes d'attributs qui peuvent être étendues par - l'utilisateur. Un attribut est une paire clé/valeur de la forme : clé =valeur. - L'enregistrement complet contient autant de paire que le désire l'utilisateur. - Le nom d'un attribut n'a pas besoin d'être unique, c'est à dire qu'une même clé - peut apparaître plusieurs fois dans un enregistrement. Cela peut être utile si - vous devez donner un titre à votre document en plusieurs langues, par exemple. - Dans un cas pareil, la convention est que chaque valeur de titre est précédée - par deux lettres et deux points, tel que : 'fr:Titre en français' ou 'ge:Titel - in deutsch'. D'autres attributs comme une description ou des mots clés sont - aussi suceptibles de recourir à ce genre de procédé. Vous pouvez aussi remplacer - l'abréviation de langage par une autre chaîne, tant qu'elle est séparée de la - valeur par les deux points. - </para> - <para> - Chaque enregistrement a une représentation native qui contient toutes les paires - clé/valeur, séparées par un retour à la ligne. L'extension Hyperwave reconnaît une - autre représentation qui est un tableau associatif, oú les attributs servent de - clés. Les attributs multilingues étant géré sous la forme d'un autre tableau - associatif, dont les clés sont les chaînes de langue. En fait, tous les attributs - multiformes sont gérés sous la forme de tableau associatif. (Cela n'est pas encore - complètement codé. Uniquement les attributs de titre, description et mot clés - sont traités correctement). - </para> - <para> - En dehors des documents, tous les hyper liens contenus dans un documents sont - enregistrés dans un autre enregistrement. Les hyperliens qui sont à l'intérieur - d'un document en seront supprimés, et enregistrés dans des objets particuliers, - au moment de l'insertion dans la base de données. L'enregistrement des hyper-liens - contient les informations d'origine et d'objectif. Afin d'accéder au document - original, vous devre lire le document sans les liens, puis lire les liens, et - les réinsérer (les <function>hw_pipedocument</function> et - <function>hw_gettext</function> le font pour vous. L'avantage de séparer les - liens du document est évident : une fois qu'un document, cible d'un hyperlien, a - été renommé, le liens peut facilement être modifié. Le document contenant le lien - n'est pas modifié pour autant. Vous pouvez même ajouter un lien à un document - sans le modifier. - </para> - <para> - Dire que <function>hw_pipedocument</function> et <function>hw_gettext</function> - font l'insertion automatiquement n'est pas aussi simple qu'il n'y paraît. - L'insertion implique une certaine hiérarchie de document. Sur un serveur web, - la hiérarchie est fournie par le système de fichiers, mais Hyperwave dispose de - sa propre hiérarchie et les noms de fichiers ne reflètent pas la position d'un - objet dans cette hiérarchie. Ainsi, la création de liens requière en premier lieu - la construction de la hiérarchie et de l'espace des noms dans une hiérarchie web - et un espace de nom web. La différence fondamentale entre Hyperwave et le web est - qu'il y a une distinction claire en les noms et la hiérarchie dans Hyperwave. Le - nom ne contient aucune information à propos de la position de l'objet dans la - hiérarchie. Sur le web, le nom contient les informations de localisation dans la - hiérarchie. Cela conduit à deux méthodes de d'accès : soit la hiérarchie Hyperwave - et le nom de l'objet sont inscrit dans l'URL. Pour simplifier les choses, une - deuxième approche est pratiquée. L'objet Hyperwave de nom 'mon_objet' correspond à - l'URL 'http://hote/mon_objet', peu importe alors oú il est rangé dans la hiérarchie. - Un objet dont le nom est 'parent/mon_objet' peut être le fils de l'objet 'mon_objet' - dans la hiérarchie Hyperwave, bien que ce soit le contraire en convention web, et - cela risque de perturber l'utilisateur. - </para> - <para> - Ayant pris cette décision, un deuxième problème surgit : comment faire l'interface - avec PHP ? L' URL http://hote/mon_objet n'appelera aucun script PHP à moins que - vous ne demandiez à votre serveur web de le remplacer par autre chose, comme par - exemple : 'http://host/php3_script/mon_objet' et le script 'php3_script' utilise la - variable $PATH_INFO pour rechercher l'objet 'mon_objet' sur le serveur Hyperwave. - Il y a juste un petit inconvénient , qui peut facilement être corrigé. Réécrire - un URL ne vous permettra aucun accès aux autres documents du serveur web. Un - script de recherche dans le serveur Hyperwave serait impossible. Il vous faudra - donc au moins une autre règle pour exclure certaines URL, comme par exemple celles - qui commencent par http://host/Hyperwave. Voici de manière simple, la manière de - partager un espace de nom entre un serveur web et un serveur Hyperwave serveur. - </para> - <para> - Basé sur le mécanisme précédent, on trouve l'insertion dans les documents. - </para> - <para> - Il est plus compliqué d'avoir PHP ne fonctionne pas comme un module de serveur, ou - un scrip CGI, mais comme une application indépendante. Dans ce cas, il est utile - d'inscrire la hiérarchie et le nom de fichier Hyperwave dans le système de - fichier. Mais comme cela risque d'entrer en conflit avec le séparateur de dossier - ('/'), il faut le remplacer par un autre caractère,. '_'. - </para> - <para> - Le protocole réseau pour communiquer avec un serveur Hyperwave est appelé - <ulink url="http://www.hyperwave.de/7.17-hg-prot">HG-CSP</ulink> - (Hyper-G Client/Server Protocol). Il est basé sur des messages qui initie des - actions, comme par exemple, lire l'entête de fichier. Dans les premières versions - de Hyperwave Server deux clients natifs (Harmony, Amadeus) étaient fournis pour - permettre la communication avec le serveur. Ils ont disparu lors de la - commercialisation de Hyperwave. En tant qu'ersatz, un client appelé wavemaster est - désormais fourni. - wavemaster est un espèce ce convertisseur de protocole de - <abbrev>HTTP</abbrev> en <abbrev>HG-CSP</abbrev>. L'idée est de faire toute - l'administration de la base et la visualisation des documents par une interface - web. Le wavemaster implémente un jeu d'emplacement pour certaines actions de - personnalisation de l'interface. Ce jeu est appelé <abbrev>PLACE</abbrev> - language. <abbrev>PLACE</abbrev> pêche encore par le manque de nombreuse fonctions - de programmations, et le manque d'évolutivité. Cela a conduit à l'utilisation de - JavaScript ce qui ne rend pas la vie facile. - </para> - <para> - Que PHP supporte Hyperwave permet de combler ces manques. PHP implémente tous - les messages définis par <abbrev>HG-CSP</abbrev> mais fourni d'autres commandes - puissantes, comme par exemple, celle de lire des documents complets. - </para> - - <para> - Hyperwave dispose de sa propre terminologie pour localiser certaines informations. - Cette terminologie a été largement étendue. Presque toutes les fonctions utilisent - l'un des types de données suivants : - - <itemizedlist> - <listitem><simpara> - object ID: un entier, unique pour chaque objet sur le serveur Hyperwave. C'est - aussi un des attributs de l'enregistrement de l'objet (ObjectID).Les object ids - sont souvent utilisées comme paramètre d'entrée pour spécifier un objet. - </simpara></listitem> - <listitem><simpara> - object record: Une chaîne contenant des paires clé=valeur. Les paires sont - séparées par un retour à la ligne. Un enregistrement d'objet peut facilement - être converti en tableau, avec la fonction <function>hw_objrec2array</function>. - De nombreuses fonctions retournent un object records. Ces fonctions ont leur - nom qui finit par obj. - </simpara></listitem> - <listitem><simpara> - object array: Un tableau associatif qui contient tous les attributs d'un objet. - La clé est l'attribut. Si un attribut apparaît plusieurs fois, il sera - représenté sous la forme d'un tableau associatif ou indexé. Les attributs qui - dépendent des langues (comme title, keyword ou description) seront représentés sous la - forme d'un tableau associatif, dont les clés seront les abréviations de langues. - Tous les autres attributs à valeur multiple prendront la forme d'un tableau - indexé. - </simpara></listitem> - <listitem><simpara> - hw_document: Ce type est un nouveau type de données, qui contient le document - lui même, comme par exemple HTML, PDF etc. Il est optimisé pour les documents - HTML mais peut s'utiliser avec n'importe quel format. - </simpara></listitem> - </itemizedlist></para> - - <para> - De nombreuses fonctions qui retournent un tableau d'enregistrements, retournent aussi - un tableau associé, avec des informatiosn statistiques. Ce tableau est le dernier - élément du tableau d'enregistrements. Les statistiques contiennent les entrées - suivantes : - <variablelist> - <varlistentry> - <term>Hidden</term> - <listitem><simpara> - Nombre d'objet dont l'attribut PresentationHints est Hidden. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term>CollectionHead</term> - <listitem><simpara> - Nombre d'objet dont l'attribut PresentationHints est CollectionHead. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term>FullCollectionHead</term> - <listitem><simpara> - Nombre d'objet dont l'attribut PresentationHints est FullCollectionHead. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term>CollectionHeadNr</term> - <listitem><simpara> - Index du premier objet du tableau d'enregistrement avec l'attribut - PresentationHints à CollectionHead. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term>FullCollectionHeadNr</term> - <listitem><simpara> - Index du premier objet du tableau d'enregistrement avec l'attribut - PresentationHints est FullCollectionHead. - </simpara></listitem> - </varlistentry> - <varlistentry> - <term>Total</term> - <listitem><simpara> - Total: Nombre d'enregistrements. </simpara></listitem> - </varlistentry> - </variablelist></para> - </sect1> - - <sect1 id="hw-apache"> - <title>Intégration avec Apache</title> - <para> - L'extension Hyperwave est utilisée de manière optimale lorsqu PHP est compilé - comme module Apache. Dans ce cas, le serveur Hyperwave sous jacent peut être - caché quasiment totalement aux utilisateurs, si Apache utilise son moteur d'écriture. - Les explications suivantes vous éclaireront : - </para> - <para> - Etant donné que PHP avec l'extension Hyperwave et Apache tend à remplacer - la solution native basé sur Wavemaster, je vais supposer que le serveur Apache - servira seulement d'interface Hyperwave. Ce n'est pas nécessaire, mais cela - simplifie grandment la configuration. Le concept est très simple. Premièrement, - vous avez besoin d'un script PHP qui évalue la variable <envar>PATH_INFO</envar> et - considère que cette valeur est un objet Hyperwave. Appelons ce script 'Hyperwave'. - L'URL <systemitem role="url">http://votre.hote/Hyperwave/nom_objet</systemitem> - retourne alors l'objet Hyperwave dont le nom est 'nom_objet'. Le script doit alors - réagir suivant le type de l'objet. Si c'est un groupe, il devra probablement - retourner une liste de fils. Si c'est un document, il pourra retourner son type - MIME et son contenu. Une amélioration peut être obtenue en utilisant le moteur - de réécriture d' Apache. D'un point de vue utilisateur, il est plus direct si - l'URL <systemitem role="url">http://votre.hote/nom_objet</systemitem> - retourne l'objet. La règle de réécriture est simple : - - <informalexample><programlisting role="apache-conf"> -RewriteRule ^/(.*) /usr/local/apache/htdocs/HyperWave/$1 [L] -</programlisting></informalexample> - - Maintenant toutes les URL pointent sur un objet Hyperwave. Cela conduit à un - problème simple. Il n'y a pas d'autre façon d'exécuter, c'est à dire rechercher, - un autre script que ce script 'Hyperwave'. Cela pourra être corrigé avec une autre - règle telle que: - - <informalexample><programlisting role="apache-conf"> -RewriteRule ^/hw/(.*) /usr/local/apache/htdocs/hw/$1 [L] -</programlisting></informalexample> - - Le dossier <filename class="directory">/usr/local/apache/htdocs/hw</filename> - sera ainsi reservé pour d'autres scripts et fichiers. Assurez vous que cette - règle est évaluée avant la première règle que nous avons définie. Il y a juste - un léger inconvénient : tous les objets Hyperwave qui commencent par 'hw/' seront - cachés. Alors, assurez vous que vous n'utilisez pas de tels noms. Si vous avez - besoin d'autres dossiers, par exemple, un dossier d'images, ajoutez simplement - d'autres règles. N'oubliez pas de lancer le moteur de réécriture avec - - <informalexample><programlisting role="apache-conf"> -RewriteEngine on -</programlisting></informalexample> - - Mon expérience m'a montré que vous aurez besoin des scripts suivants : - - <itemizedlist> - <listitem><simpara> - Retourne l'objet lui même </simpara></listitem> - <listitem><simpara> - Pour autoriser la recherche</simpara></listitem> - <listitem><simpara> - S'identifier</simpara></listitem> - <listitem><simpara> - Choisir une configuration </simpara></listitem> - <listitem><simpara> -Un script pour chaque fonction supplémentaire, comme afficher un objet, afficher des informations sur les utilisateurs, afficher le statut du serveur, etcÖ -</simpara></listitem> - </itemizedlist></para> - </sect1> - - <sect1 id="hw-todo"> - <title>A faire</title> - <para> - Il reste encore beaucoup à faire : - <itemizedlist> - <listitem><simpara>La fonction hw_InsertDocument doit être séparée en deux : - <function>hw_InsertObject</function> et - <function>hw_PutDocument</function>.</simpara></listitem> - <listitem><simpara>Les noms de nombreuses fonctions ne sont pas encore fixés. - </simpara></listitem> - <listitem><simpara> - La plupart des fonctions requièrent la connexion courante - comme premier paramètre. Cela conduit à beaucoup de frappe clavier, - même si il n'y a souvent qu'une seule connexion en jeu. Une connexion par - défaut améliorerait ceci. - </simpara></listitem> - </itemizedlist></para> - </sect1> - </partintro> - - <refentry id="function.hw-array2objrec"> - <refnamediv> - <refname>hw_Array2Objrec</refname> - <refpurpose>converti un tableau en un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>strin <function>hw_array2objrec</function></funcdef> - <paramdef>array <parameter>object_array</parameter></paramdef> - </funcsynopsis> - <para> - Converti un <parameter>object_array</parameter> en un objet. - Les attributs multiples tels que 'Title' en différentes langues seront traités - correctement. - </para> - <para> - Voir aussi <function>hw_objrec2array</function>. - </para> - </refsect1> - </refentry> - - <refentry id="function.hw-children"> - <refnamediv> - <refname>hw_Children</refname> - <refpurpose>Liste des object ids des objets fils.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_children</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un tableau avec des object ids. Chaque object id est celui d'un des fils du -groupe dont l'id est <parameter>objectID</parameter>. -Ce tableau contient tous les fils, documents et groupes. -</para> - </refsect1> - </refentry> - - <refentry id="function.hw-childrenobj"> - <refnamediv> - <refname>hw_ChildrenObj</refname> - <refpurpose>Liste des object records des objets fils.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_childrenobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un tableau avec des object records. Chaque object records est celui d'un des -fils du groupe dont l'id est <parameter>objectID</parameter>. -Ce tableau contient tous les fils, documents et groupes -</para> - </refsect1> - </refentry> - - <refentry id="function.hw-close"> - <refnamediv> - <refname>hw_Close</refname> - <refpurpose>Ferme la connexion Hyperwave.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_close</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> - Retourne false si la connexion n'est pas valide, et sinon, true. Ferme la connexion connection à un serveur Hyperwave.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-connect"> - <refnamediv> - <refname>hw_Connect</refname> - <refpurpose>Ouvre une connexion Hyperwave.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_connect</function></funcdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcsynopsis> - <para> -Ouvre une connexion Hyperwave et retourne un identifiant de connexion, en cas de succès, - ou false, si la connexion n'a pas pu être créée. Chaque argument doit être entouré de -guillemets, sauf le numéro de port. Les arguments <parameter>username</parameter> et - <parameter>password</parameter> sont optionnels, et peuvent être ignorés. Dans ce - cas, aucune identification ne sera faite au niveau du serveur. Cela revient à s'identifier en tant qu'utilisateur anonyme. Cette fonction retourne un identifiant de connexion qui sera nécessaire aux autres fonctions Hyperwave. Vous pouvez avoir plusieurs connexions simultanées. N'oubliez pas que les mots de passe ne sont pas cryptés. -</para> - <para> - Voir aussi <function>hw_pConnect</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-cp"> - <refnamediv> - <refname>hw_Cp</refname> - <refpurpose>Copie des objets.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_cp</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>array <parameter>object_id_array</parameter></paramdef> - <paramdef>int <parameter>destination id</parameter></paramdef> - </funcsynopsis> - <para> -Copie les objet ayant les objects id object_id_array, et crée un groupe ayant l'object id <parameter>destination id</parameter>.</para> - <para> -La valeur retournée est le nombre d'objets copiés. -</para> - <para> - Voir aussi <function>hw_mv</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-deleteobject"> - <refnamediv> - <refname>hw_Deleteobject</refname> - <refpurpose>Efface des objets.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_deleteobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>object_to_delete</parameter></paramdef> - </funcsynopsis> - <para> -Efface l'objet dont l'identifiant est object_to_delete. Toutes les instances de l'objets seront effacées. -</para> - <para> -Retourne TRUE si aucune erreur ne survient, et sinon, FALSE. -</para> - <para> - Voir aussi <function>hw_mv</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-docbyanchor"> - <refnamediv> - <refname>hw_DocByAnchor</refname> - <refpurpose>Identifiant d'objet de l'objet dans l'ancrage.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_docbyanchor</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>anchorID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne l'dentifiant d'objet de l'objet dans l'ancrage <parameter>anchorID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-docbyanchorobj"> - <refnamediv> - <refname>hw_DocByAnchorObj</refname> - <refpurpose>Attributs de l'objet dans l'ancrage.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_docbyanchorobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>anchorID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne les attributs du document qui correspond à <parameter>anchorID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-documentattributes"> - <refnamediv> - <refname>hw_DocumentAttributes</refname> - <refpurpose>Object record de hw_document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_documentattributes</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> - Retourne les attributs du document.</para> - <para> - Voir aussi <function>hw_DocumentBodyTag</function>, - <function>hw_DocumentSize</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-documentbodytag"> - <refnamediv> - <refname>hw_DocumentBodyTag</refname> - <refpurpose>Balise de corps d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_documentbodytag</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> -Retourne la balise BODY du document.Si le document est un document HTML , la balise BODY doit être affichée avant le document.</para> - <para> - Voir aussi <function>hw_DocumentAttributes</function>, - <function>hw_DocumentSize</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-documentcontent"> - <refnamediv> - <refname>hw_DocumentContent</refname> - <refpurpose>Contenu d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_documentcontent</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> -Retourne la balise BODY du document.Si le document est un document HTML , la balise BODY doit être affichée avant le document.</para> - <para> - Voir aussi <function>hw_DocumentAttributes</function>, - <function>hw_DocumentSize</function>, - <function>hw_DocumentSetContent</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-documentsetcontent"> - <refnamediv> - <refname>hw_DocumentSetContent</refname> - <refpurpose>Modifie/remplace le contenu d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_documentsetcontent</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - <paramdef>string <parameter>content</parameter></paramdef> - </funcsynopsis> - <para> -Modifie/remplace le contenu d'un document. Si le document est un document HTML, le contenu représente tout qui est placé au dela de la balise BODY. Les informations de HEAD et de la balise BODY sont enregistrés dans les attributs. Si vous fournissez aussi ces informations dans le corps du document, le serveur Hyperwave modifiera les attributs. Cela n'est cependant pas une bonne idée. Si la fonction échoue, l'ancien contenu est restauré. -</para> - <para> - Voir aussi <function>hw_DocumentAttributes</function>, - <function>hw_DocumentSize</function>, - <function>hw_DocumentContent</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-documentsize"> - <refnamediv> - <refname>hw_DocumentSize</refname> - <refpurpose>Taille d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_documentsize</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> - Retourne la taille du document en octets.</para> - <para> - Voir aussi <function>hw_DocumentBodyTag</function>, - <function>hw_DocumentAttributes</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-errormsg"> - <refnamediv> - <refname>hw_ErrorMsg</refname> - <refpurpose>Retourne un message d'erreur.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_errormsg</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> -Retourne une chaîne contenant le dernier message d'erreur, ou 'No Error' (pas d'erreur). Si false est retourné, cette fonction a échoué. Ce message est relatif à la dernière commande exécutée.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-edittext"> - <refnamediv> - <refname>hw_EditText</refname> - <refpurpose>Retourne un document texte.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_edittext</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> -Charge le texte du document sur le serveur. Les attributs du document ne doivent pas être modifiés tant que le document est en train d'être édité. Cette fonction n'est disponible que sur les documents texte. Elle n'ouvrira pas de canal de transfert, et donc, bloquera le script durant le transfert. -</para> - <para> - Voir aussi <function>hw_PipeDocument</function>, - <function>hw_free_document</function>, - <function>hw_DocumentBodyTag</function>, - <function>hw_DocumentSize</function>, - <function>hw_OutputDocument</function>, - <function>hw_GetText</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-error"> - <refnamediv> - <refname>hw_Error</refname> - <refpurpose>Retourne le code d'erreur.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_error</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> -Retourne le code d'erreur de la dernière erreur. Si la valeur 0 est retournée, c'est qu'il n'y avait pas d'erreur. L'erreur se rapporte à la dernière commande.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-free-document"> - <refnamediv> - <refname>hw_Free_Document</refname> - <refpurpose>Détruit un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_free_document</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> - Détruit un document Hyperwave.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getparents"> - <refnamediv> - <refname>hw_GetParents</refname> - <refpurpose>Identifiant d'objet des parents.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getparentsobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau indexé avec les identifiants des objets parents de <parameter>objectID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getparentsobj"> - <refnamediv> - <refname>hw_GetParentsObj</refname> - <refpurpose>Attributs des parents.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getparentsobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau indexé, avec les attributs et un tableau associé, d'informations statistiques à propos des attributs. Ce tableau associé est le dernier élément du tableau retourné. Chaque -attribut appartient au père de l'objet <parameter>objectID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getchildcoll"> - <refnamediv> - <refname>hw_GetChildColl</refname> - <refpurpose>Identifiant d'objet des groupes fils.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getchildcoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau contenant les identifiants d'objets des groupes fils du -groupe <parameter>objectID</parameter>. Cette fonction ne retournera pas d'identifiants -d'objets des documents fils.</para> - <para> - Voir aussi <function>hw_GetChildDocColl</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getchildcollobj"> - <refnamediv> - <refname>hw_GetChildCollObj</refname> - <refpurpose>object records d'un groupe d'enfants.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getchildcollobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau d'object record. Chaque object records appartient à un groupe d'enfants -de la collection <parameter>objectID</parameter>. La fonction ne retournera pas -de documents enfants.</para> - <para> - Voir aussi <function>hw_ChildrenObj</function>, - <function>hw_GetChildDocCollObj</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getremote"> - <refnamediv> - <refname>hw_GetRemote</refname> - <refpurpose>Retourne un document distant.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_getremote</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un document distant. Les documents distants sont , en Hyperwave, des documents -lus depuis une source externe. La plus part des documents éloignés sont des pages web -externes, ou des requêtes sur une base de données. Afin de pouvoir accéder à des sources - externes, grâces aux documents distants, Hyperwave introduit l'interface HGI (Hyperwave - Gateway Interface) qui est similaire à CGI. Actuellement, seuls les protocoles de ftp, -http et certaines bases de données sont accessibles avec HGI. <function>hw_GetRemote</function> - retourne le document de la source distante. Si vous voulez utiliser cette fonction, il vous faut vous familiariser HGIs. Il est aussi préférable d'utiliser PHP plutôt que Hyperwave pour accéder aux sources externes. Le support des bases de données sera plus difficile avec Hyperwave que PHP. -</para> - <para> - Voir aussi <function>hw_GetRemoteChildren</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getremotechildren"> - <refnamediv> - <refname>hw_GetRemoteChildren</refname> - <refpurpose>Retourne les fils d'un document distant.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_getremotechildren</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>object record</parameter></paramdef> - </funcsynopsis> - <para> -Retourne les fils d'un document distant. Les fils d'un document distant sont des -documents distants eux mêmes. Cela est cohérent si une requête sur une base de données -doit être rendu plus sélective, comme expliqué dans Hyperwave Programmers' Guide. -Si le nombre de fils est 1 la fonction va retourner le document lui même, la fonction -retournera le document lui même, formaté Hyperwave Gateway Interface (HGI). Si -le nombre de fils est supérieur 1 la fonction retournera un tableau d'attributs, -qui pourra servir à une nouvelle requête avec <function>hw_GetRemoteChildren</function>. -Ces attributs sont virtuels et n'existent pas sur le serveur Hyperwave, et ainsi, n'ont pas d'identifiant d'objet valide. L'ordre exact de ces objets est du ressort de HGI. Si vous voulez utiliser cette fonction, vous devez être très familier HGIs. Il vaut mieux PHP plutôt que Hyperwave pour accéder aux fichiers distants. Le support de base de données y est bien meilleur. -</para> - <para> - Voir aussi <function>hw_GetRemote</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getsrcbydestobj"> - <refnamediv> - <refname>hw_GetSrcByDestObj</refname> - <refpurpose>Retourne les ancrages qui pointent sur un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getsrcbydestobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne les attributs de tous les ancrages qui pointent sur <parameter>objectID</parameter>. -L'objet peut être un document ou un autre ancrage, de type destination. -</para> - <para> - Voir aussi <function>hw_GetAnchors</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getobject"> - <refnamediv> - <refname>hw_GetObject</refname> - <refpurpose>Attributs d'un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>[int|array] <parameter>objectID</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - </funcsynopsis> - <para> -Retourne les attributs de l'objet dont l'identifiant est <parameter>objectID</parameter>, - si le second paramètre est un entier. Si le second paramètre est un tableau, la fonction retournera un tableau d'attributs. Dans ce cas, le dernier paramètre est aussi évalué. -</para> - <para> - <parameter>query</parameter> a la syntaxe suivante :</para> - <simpara> - <expression> ::= "(" <expression> ")" |</simpara> <simpara> - "!" <expression> | /* NOT */</simpara><simpara> - <expression> "||" <expression> | /* OR */</simpara><simpara> - <expression> "&&" <expression> | /* AND */</simpara><simpara> - <attribute> <operator> <value></simpara><simpara> - - <attribute> ::= /* * n'importe quel attribut (Title, Author, DocumentType ...) */</simpara><simpara> - - <operator> ::= "=" | /* égal */</simpara><simpara> - "<" | /* moins que (comparaison de type chaîne) */</simpara><simpara> - ">" | /* plus que (comparaison de type chaîne) */</simpara><simpara> - "~" /* recherche par expression régulière */</simpara><simpara></simpara> - <para> - <parameter>query</parameter> permet de sélectionner une nouvelle fois certains objets dans la liste des objets donnés. Contrairement aux autres requêtes, celle ci peut utiliser des attributs non indexés. Le nombre d'attributs retourné dépend de la requête de la requête, et des autorisations d'accès aux objets.</para> - <para> - Voir aussi <function>hw_GetAndLock</function>, - <function>hw_GetObjectByQuery</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getandlock"> - <refnamediv> - <refname>hw_GetAndLock</refname> - <refpurpose>Retourne les attributs, et verrouille l'objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_getandlock</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne les attributs, et verrouille l'objet <parameter>objectID</parameter>. -Le verrouillage empêchera les autres utilisateurs d'y accéder, jusqu'à ce qu'il soit deverrouillé. -</para> - <para> - Voir aussi <function>hw_Unlock</function>, - <function>hw_GetObject</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-gettext"> - <refnamediv> - <refname>hw_GetText</refname> - <refpurpose>Retourne un document texte.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_gettext</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>mixed - <parameter> - <optional>rootID/prefix</optional> - </parameter> - </paramdef> - </funcsynopsis> - <para> -Retourne le document de l'objet <parameter>objectID</parameter>. Si le document possède -des ancrages qui peuvent être insérés, ils seront déjà insérés. -L'option rootID/prefix peut être une chaîne ou un entier. Si c'est un entier, il -détermine la méthode d'insertion des liens dans le document. Par défaut, il vaut 0 et -les liens seront construits en fonction du nom de l'objet cible. Cela sert beaucoup -dans les applications web. Si un lien pointe sur un objet avec le nom -'film_internet' le lien HTML sera <A HREF="/internet_movie">. -La position réelle de la source et de la cible dans la hiérarchie seront ignorés. Vous devrez modificer votre site web pour qu'il réécrive les URL, comme par exemple '/mon_script.php3/film_internet'. 'mon_script.php3' devra analyser $PATH_INFO et savoir recherche le document '/mon_script.php3/film_internet'. Si vous ne voulez pas de ce comportement, vous pouvez affecter à rootID/prefix n'importe quel prefixe. Dans ce cas, ce sera une chaîne. -</para> - <para> -Si <parameter>rootID/prefix</parameter> est un entier différent de 0 le lien sera -construit avec tous les noms de la hiérarchie, en commencant à l'objet d'identifiant rootID/prefix, -et séparé par des slash. Si, par exemple, le document 'film_internet' est situé à -'a-b-c-internet_movie' et '-' qui sert de séparateur hiérarchique de niveau sur -le serveur Hyperwave et le document source est situé dans 'a-b-d-source' alors, le lien HTML -serait: <A HREF="../c/internet_movie">. Cela est très pratique si vous voulez télécharger tout le contenu d'un serveur sur un disque, et faire une carte du système sur votre disque. -</para> - <para> -Cette fonction n'est opérationnelle qu'avec des document de pur texte. Elle n'ouvrira pas de canal spécial de transfert, et ainsi, bloquera le script le temps du transfert. -</para> - <para> - Voir aussi <function>hw_PipeDocument</function>, - <function>hw_free_document</function>, - <function>hw_DocumentBodyTag</function>, - <function>hw_DocumentSize</function>, - <function>hw_OutputDocument</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getobjectbyquery"> - <refnamediv> - <refname>hw_GetObjectByQuery</refname> - <refpurpose>Recherche un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getobjectbyquery</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcsynopsis> - <para> -Recherche un objet sur tout le serveur et retourne un tableau d' object ids. -Le nombre maximum d'objet est limité par <parameter>max_hits</parameter>. - Si <parameter>max_hits</parameter> vaut -1 il n'y a pas de limite.</para> - <para> - La requête ne fonctionnera qu'avec des attributs indexés.</para> - <para> - Voir aussi <function>hw_GetObjectByQueryObj</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getobjectbyqueryobj"> - <refnamediv> - <refname>hw_GetObjectByQueryObj</refname> - <refpurpose>Recherche un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getobjectbyqueryobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcsynopsis> - <para> -Recherche un objet sur tout le serveur et retourne un tableau d' object records. -Le nombre maximum d'objet est limité par <parameter>max_hits</parameter>. Si <parameter>max_hits</parameter> -vaut -1 il n'y a pas de limite. -</para> - <para> - La requête ne fonctionnera qu'avec des attributs indexés.</para> - <para> - Voir aussi <function>hw_GetObjectByQuery</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getobjectbyquerycoll"> - <refnamediv> - <refname>hw_GetObjectByQueryColl</refname> - <refpurpose>Recherche un objet dans un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getobjectbyquerycoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcsynopsis> - <para> -Recherche un objet sur tout le groupe objectID et retourne un tableau d' object records. - Le nombre maximum d'objet est limité par <parameter>objectID</parameter>. Si <parameter>objectID</parameter> - vaut -1 il n'y a pas de limite. -</para> - <para> -La requête ne fonctionnera qu'avec des attributs indexés.</para> - <para> - Voir aussi <function>hw_GetObjectByQueryCollObj</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getobjectbyquerycollobj"> - <refnamediv> - <refname>hw_GetObjectByQueryCollObj</refname> - <refpurpose>Recherche un objet dans un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getobjectbyquerycollobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>string <parameter>query</parameter></paramdef> - <paramdef>int <parameter>max_hits</parameter></paramdef> - </funcsynopsis> - <para> -Recherche un objet sur tout le groupe objectID et retourne un tableau d' object records. - Le nombre maximum d'objet est limité par <parameter>objectID</parameter>. Si <parameter>objectID</parameter> - vaut -1 il n'y a pas de limite.</para> - <para> - La requête ne fonctionnera qu'avec des attributs indexés.</para> - <para> - Voir aussi <function>hw_GetObjectByQueryColl</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getchilddoccoll"> - <refnamediv> - <refname>hw_GetChildDocColl</refname> - <refpurpose>ids des documents fils d'un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getchilddoccoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau avec les id des documents fils d'une collection.</para> - <para> - Voir aussi <function>hw_GetChildColl</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getchilddoccollobj"> - <refnamediv> - <refname>hw_GetChildDocCollObj</refname> - <refpurpose>Attributs des documents fils d'un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getchilddoccollobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau contenant les attributs des documents fils du groupe <parameter>objectID</parameter>. </para> - <para> - Voir aussi <function>hw_ChildrenObj</function>, - <function>hw_GetChildCollObj</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getanchors"> - <refnamediv> - <refname>hw_GetAnchors</refname> - <refpurpose> Identifiants des ancrages d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getanchors</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Retourne un tableau contenant les identifiants des ancrages du document <parameter>objectID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getanchorsobj"> - <refnamediv> - <refname>hw_GetAnchorsObj</refname> - <refpurpose>Attributs des ancrages d'un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_getanchorsobj</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un tableau d'attributs des ancrages du document <parameter>objectID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-mv"> - <refnamediv> - <refname>hw_Mv</refname> - <refpurpose>Déplace un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_mv</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>array <parameter>object id array</parameter></paramdef> - <paramdef>int <parameter>source id</parameter></paramdef> - <paramdef>int <parameter>destination id</parameter></paramdef> - </funcsynopsis> - <para> -Déplaces les objets dont les identifiants sont passés dans le tableau <parameter>source id</parameter>, -depuis le <parameter>source id</parameter> dans le <parameter>destination id</parameter>. - Si destination id vaut 0, les objets ne seront plus insérés dans le groupe (ni dans le serveur). Dans ce cas, si une instance était la dernière instance d'un objet, l'objet sera effacé. Si vous voulez effacer toutes les instances d'un coup, utilisez <function>hw_deleteobject</function>. -</para> - <para> - La valeur retournée est le nombre d'objet déplacés.</para> - <para> - Voir aussi <function>hw_cp</function>, - <function>hw_deleteobject</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-identify"> - <refnamediv> - <refname>hw_Identify</refname> - <refpurpose>Identifie un utilisateur.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_identify</function></funcdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcsynopsis> - <para> -Identifies un utilisateur, dont le nom d'utilisateur est <parameter>username</parameter> and - et le mot de passe <parameter>password</parameter>. L'identification n'est valide -que pour la session en cours. Je ne pense pas que cette fonction serve souvent. Dans la plus part des cas, il est plus simple de s'identifier lors de l'ouverture de la connexion. -</para> - <para> - Voir aussi <function>hw_Connect</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-incollections"> - <refnamediv> - <refname>hw_InCollections</refname> - <refpurpose>Vérifie qu'un identifiant d'objet est dans un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_incollections</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>array <parameter>object_id_array</parameter></paramdef> - <paramdef>array <parameter>collection_id_array</parameter></paramdef> - <paramdef>int <parameter>return_collections</parameter></paramdef> - </funcsynopsis> - <para> -Vérifie qu'un ensemble d'objet (documents ou groupes) donnés par <parameter>object_id_array</parameter> - fait partie des groupe listés par <parameter>object_id_array</parameter>. -Lorsque le quatrième paramètre <parameter>return_collections</parameter> vaut 0, le -sous ensemble d'identifiant qui font partie d'un groupe (i.e. les documents ou groupes qui sont fils d'un ou plusieurs groupe, ou leurs fils, récurusivement) est retourné sous la forme d'un tableau. Cette option permet de mettre en valeur la partie de l'arborescence qui contient le résultat d'une requête, dans un sens graphique. -</para> - <para></para> - </refsect1> - </refentry> - - <refentry id="function.hw-info"> - <refnamediv> - <refname>hw_Info</refname> - <refpurpose>Informations à propos d'une connexion.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_info</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> - Retourne les informations de la connexion courante. La chaîne retournée a le format suivant : <Serverstring>, <Host>, - <Port>, <Username>, <Port of Client>, - <Byte swapping></para> - </refsect1> - </refentry> - - <refentry id="function.hw-inscoll"> - <refnamediv> - <refname>hw_InsColl</refname> - <refpurpose>Insère un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_inscoll</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - <paramdef>array <parameter>object_array</parameter></paramdef> - </funcsynopsis> - <para> -Insère un nouveau groupe, avec les attributs <parameter>object_array</parameter> dans le groupe -<parameter>objectID</parameter>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-insdoc"> - <refnamediv> - <refname>hw_InsDoc</refname> - <refpurpose>Insère un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_insdoc</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>parentID</parameter></paramdef> - <paramdef>string <parameter>object_record</parameter></paramdef> - <paramdef>string <parameter>text</parameter></paramdef> - </funcsynopsis> - <para> - Insère un nouveau document avec les attributs <parameter>object_record</parameter>, -dans le groupe <parameter>parentID</parameter>. Cette fonction insère soit un objet -avec ses seuls attributs, soit pur objet ascii, avec <parameter>text</parameter> si il est fourni. -Si vous voulez insérer un document de type général, utilisez plutôt - <function>hw_insertdocument</function>.</para> - <para> - Voir aussi <function>hw_InsertDocument</function>, - <function>hw_InsColl</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-insertdocument"> - <refnamediv> - <refname>hw_InsertDocument</refname> - <refpurpose>Insère un document dans un groupe.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_insertdocument</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>parent_id</parameter></paramdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> -Insère un document dans le groupe <parameter>parent_id</parameter>. Le document doit -avoir été créé auparavant avec <function>hw_New_Document</function>. Assurez vous que -les attributs du nouveau document contiennent au moins les attributs suivants : -Type, DocumentType, Title et Name. Vous aurez aussi parfois besoin de MimeType. La fonction retourne l'identifiant de l'objet inséré, ou bien false. -</para> - <para> - Voir aussi <function>hw_PipeDocument</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-insertobject"> - <refnamediv> - <refname>hw_InsertObject</refname> - <refpurpose>Insère un object record.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_insertobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>string <parameter>object rec</parameter></paramdef> - <paramdef>string <parameter>parameter</parameter></paramdef> - </funcsynopsis> - <para> - Insère un objet dans le serveur. L'objet peut être n'importe quel objet Hyperwave valide. Reportez vous à la documentation HG-CSP pour plus de détails sur les paramètres.</para> - <para> - Note: Si vous voulez insérer un ancre, l'attribut Position doit être mis à la valeur start/end (début ou fin) ou encore 'invisible'. Les positions invisibles sont nécessaire si l'annotation n'a pas de liens correspondant dans le texte de l'annotation.</para> - <para> - Voir aussi <function>hw_PipeDocument</function>, - <function>hw_InsertDocument</function>, - <function>hw_InsDoc</function>, - <function>hw_InsColl</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-mapid"> - <refnamediv> - <refname>hw_mapid</refname> - <refpurpose>Représente un id globale en un id virtuel local.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_mapid</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>server id</parameter></paramdef> - <paramdef>int <parameter>object id</parameter></paramdef> - </funcsynopsis> - <para> - Represente l'id d'un objet global de n'importe quel serveur Hyperwave, même si -vous ne vous y êtes pas connecté avec <function>hw_connect</function>, -avec un id d'objet local virtuel. Cet id d'objet local peut alors être utilisé comme n'importe quel -id d'objet : par exemple on peut obtenir l'enregistrement d'objet avec la fonction - <function>hw_getobject</function>. L'id du serveur est la première partie -de l'id global (GOid) de l'objet, qui est en fait une adresse IP.</para> - <para> - Note: Afin d'utiliser cette fonction, vous devez lever le flag - F_DISTRIBUTED, ce qui ne peut être fait qu'à la compilation. Par défaut, il n'est pas levé. -Lisez les commentaires dans le fichier hg_comm.c - </para> - </refsect1> - </refentry> - - - <refentry id="function.hw-modifyobject"> - <refnamediv> - <refname>hw_Modifyobject</refname> - <refpurpose>Modifie les attributs d'objet record.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_modifyobject</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>object_to_change</parameter></paramdef> - <paramdef>array <parameter>remove</parameter></paramdef> - <paramdef>array <parameter>add</parameter></paramdef> - <paramdef>int <parameter>mode</parameter></paramdef> - - </funcsynopsis> - <para> -Cette commande permet d'effacer, d'ajouter ou de modifier des attributs d'un objet. -L'objet est reperé par son identifiant <parameter>object_to_change</parameter>. -Le premier tableau, <parameter>remove</parameter>, est la liste des attributs à effacer. Le deuxième tableau <parameter>add</parameter> est la -liste des attributs à ajouter. Afin de modifier un attribut, il vous faudra dont l'effacer, -puis l'ajouter à nouveau. <function>hw_modifyobject</function> effacera toujours les -attributs avant de les ajouter, à moins que la valeur de l'attribut à effacer ne -soit pas une chaîne, ou un tableau.</para> - - <para> -Le dernier paramètre détermine si la modification est récursive ou pas. - 1 signigie que la modification est récursive. Si un objet ne peut pas être modifié, -il sera ignoré. <function>hw_error</function> n'indiquera alors pas toujours d'erreur, -même si certains objets n'ont pas pu être modifié. -</para> - - <para> -Les clés des deux tableaux sont les noms des attributs. La valeurs de chaque élément peut être un tableau, ou une chaîne ou n'importe quoi d'autre. Dans le cas du tableau, la valeur de l'attribut est construite en séparant chaque élément par un point virgule. Dans le cas de la chaîne, elle sert directement de valeur. Une chaîne vide provoquera un effacement de l'attribut. Dans le cas oú la valeur n'est ni un tableau, ni une chaîne, aucune opération ne sera effectuée. Cela est nécessaire si vous voulez ajouter un attribut complètement une nouvelle valeur pour un attribut existant. Si le tableau d'effacement contenait une chaîne vide comme attribut, le serveur tenterait d'effacer l'attribut, ce qui échouerai de toute manière, car cet attribut n'existe pas. L'ajout de cet attribut échouerai aussi. Affecter la valeur de 0 à cet attribut ne l'effacerait pas, et l'ajout fonctionnerait. -</para> - - <para> -Si vous voulez changer l'attribut 'Nom' de valeur courante 'livres' en 'articles' vous devrez faire deux tableaux, et appeler <function>hw_modifyobject</function>. - <example> - <title>Modification d'un attribut</title> - <programlisting role="php"> - // $connect est une connexion valide - // $objid est l'identifiant de l'objet - $remarr = array("Name" => "books"); - $addarr = array("Name" => "articles"); - $hw_modifyobject($connect, $objid, $remarr, $addarr); - </programlisting> - </example> -Afin d'effacer/ajouter une paire nom=valeur aux attributs d'un objet, utilisez simplement les tableaux d'effacement et d'ajout, et laissez le dernier/troisième paramètre vide. Si l'attribut est le premier de ce nom à ajouter, donnez une valeur entière à cet élément. - <example> - <title>Ajouter un nouvel attribut</title> - <programlisting role="php"> - // $connect is an existing connection to the Hyperwave server - // $objid is the ID of the object to modify - $remarr = array("Name" => 0); - $addarr = array("Name" => "articles"); - $hw_modifyobject($connect, $objid, $remarr, $addarr); - </programlisting> - </example></para> - <para> - <note> - <simpara> -Les attributs multilingues, (tels que 'Title'), peuvent être modifiés de deux manières : soit en fournissant la valeur de ces attributs de manière native (langue :valeur), soit en fournissant un tableau avec les éléments de chaque langue, comme décrit ci-dessus. L'exemple deviendrai alors : </simpara> - </note> - <example> - <title>modifying Title attribute</title> - <programlisting role="php"> - $remarr = array("Title" => "en:Books"); - $addarr = array("Title" => "en:Articles"); - $hw_modifyobject($connect, $objid, $remarr, $addarr); - </programlisting> - </example> - ou - <example> - <title>Modifier l'attribut Title</title> - <programlisting role="php"> - $remarr = array("Title" => array("en" => "Books")); - $addarr = array("Title" => array("en" => "Articles", "ge"=>"Artikel")); - $hw_modifyobject($connect, $objid, $remarr, $addarr); - </programlisting> - </example> -Pour supprimer l'entrée française 'Livres' et ajouter l'entrée 'Articles' et l'entrée allemande 'Artikel'. - <example> - <title>Suppression d'un attribut</title> - <programlisting role="php"> - $remarr = array("Title" => ""); - $addarr = array("Title" => "en:Articles"); - $hw_modifyobject($connect, $objid, $remarr, $addarr); - </programlisting> - </example> - <note><simpara> -Cet exemple va effacer tous les attributs avec le nom 'Title' et ajouter un nouvel attribut 'Title'. Cela peut être pratique pour effacer des attributs récursivement. - </simpara></note> - <note> - <simpara> -Si vous devez effacer tous les attributs avec un certains nom, vous devez passer une chaîne vide comme valeur. -</simpara> - </note> - <note><simpara> -Seul les attributs 'Title', 'Description' et 'Keyword' gère correctement le préfixe de langue. Pour les autres attributs qui ne portent pas de préfixe de language, le préfixe 'xx' sera assigné. - </simpara></note> - <note><simpara> -L'attribut 'Name' est un peu particuluer. Dans certains cas, il ne peut pas être complétement effacé. Vous aurez alors le message 'Change of base attribute' (l'apparition de cette erreur n'est pas très claire). Ainsi, vous aurez à ajouter une nouvelle entrée pour Name puis, effacer l'ancien. - </simpara></note> - <note><simpara> -Il ne faut pas encadrer cette fonction par des appels à <function>hw_getandlock</function> et <function>hw_unlock</function>. - <function>hw_modifyobject</function> le fait de manière interne. - </simpara></note></para> - <para> - Retourne TRUE si aucune erreur ne survient, et FALSE sinon.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-new-document"> - <refnamediv> - <refname>hw_New_Document</refname> - <refpurpose>Crée un nouveau document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_new_document</function></funcdef> - <paramdef>string <parameter>object_record</parameter></paramdef> - <paramdef>string <parameter>document_data</parameter></paramdef> - <paramdef>int <parameter>document_size</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un nouveau document Hyperwave avec comme données <parameter>document_data</parameter> et comme -attributs <parameter>object_record</parameter>. La longueur de <parameter>document_data</parameter> doit être données dans -<parameter>document_size</parameter>. Cette fonction n'insère pas l'objet dans le serveur Hyperwave. -</para> - <para> - Voir aussi <function>hw_free_document</function>, - <function>hw_DocumentSize</function>, - <function>hw_DocumentBodyTag</function>, - <function>hw_OutputDocument</function>, - <function>hw_InsertDocument</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-objrec2array"> - <refnamediv> - <refname>hw_Objrec2Array</refname> - <refpurpose>Converti les attributs d'un objet en tableau.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>array <function>hw_objrec2array</function></funcdef> - <paramdef>string <parameter>object_record</parameter></paramdef> - </funcsynopsis> - <para> -Convertir les attributs <parameter>object_record</parameter> d'un objet en un tableau. -Les clés du tableau seront les noms des attributs. Les attributs multiples comme par exemple 'Title', dans différentes langues, seront rassemblées dans un autre tableau. Une clé est la partie gauche d'un attribut. Actuellement, seuls les attributs 'Title', 'Description' et 'Keyword' sont traités correctement. -</para> - <para> - Voir aussi <function>hw_array2objrec</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-outputdocument"> - <refnamediv> - <refname>hw_OutputDocument</refname> - <refpurpose>Affiche hw_document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_outputdocument</function></funcdef> - <paramdef>int <parameter>hw_document</parameter></paramdef> - </funcsynopsis> - <para> - Affiche hw_document sans la balise BODY.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-pconnect"> - <refnamediv> - <refname>hw_pConnect</refname> - <refpurpose>Crée une connexion persistante.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_pconnect</function></funcdef> - <paramdef>string <parameter>host</parameter></paramdef> - <paramdef>int <parameter>port</parameter></paramdef> - <paramdef>string <parameter>username</parameter></paramdef> - <paramdef>string <parameter>password</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un index de connexion en cas de succès, et false si la connexion n'a pas pu -être créée. Ouvre une connexion persistante à un serveur Hyperwave. Tous les arguments -doivent être entre guillemets, hormis le numéro de port (port). Les arguments -<parameter>username</parameter> - et <parameter>password</parameter> sont optionnels, et peuvent être ignorés. Dans ce cas, aucune authentification ne sera faites, (connexion anonyme). Cette fonction retourne un index de connexion qui sera utilisée par les autres fonctions Hyperwave. Vous pouvez ouvrir plusieurs connexions simultanées. -</para> - <para> - Voir aussi <function>hw_Connect</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-pipedocument"> - <refnamediv> - <refname>hw_PipeDocument</refname> - <refpurpose>Retourne un document.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_pipedocument</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> -Retourne le document Hyperwave d'objet id <parameter>objectID</parameter>. -Si le document a des ancrages, ils seront insérés. Le document sera transmis via -une connexion de données spéciale, qui ne bloque pas la connexion de contrôle (ie, le serveur n'attend pas la fin du transfert pour rendre la main). -</para> - <para> - Voir aussi <function>hw_GetText</function> (insertions), - <function>hw_free_document</function>, - <function>hw_DocumentSize</function>, - <function>hw_DocumentBodyTag</function>, - <function>hw_OutputDocument</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-root"> - <refnamediv> - <refname>hw_Root</refname> - <refpurpose>Object id de la racine.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_root</function></funcdef> - <paramdef><parameter></parameter></paramdef> - </funcsynopsis> - <para> -Retour l' Object id de la racine. Actuellement, cette identifiant est toujours 0. L'ensemble des fils de la racine est celui du serveur courant. -</para> - </refsect1> - </refentry> - - <refentry id="function.hw-unlock"> - <refnamediv> - <refname>hw_Unlock</refname> - <refpurpose>Déverrouille un objet.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_unlock</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - <paramdef>int <parameter>objectID</parameter></paramdef> - </funcsynopsis> - <para> - Déverrouille un document, et laisse l'accès aux autres utilisateurs.</para> - <para> - Voir aussi <function>hw_GetAndLock</function>.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-who"> - <refnamediv> - <refname>hw_Who</refname> - <refpurpose>Liste des utilisateurs actuellement identifiés.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>int <function>hw_who</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> -Retourne un tableau contenant la liste des utilisateurs actuellement connectés au serveur Hyperwave. Chaque élément du tableau est lui même un tableau, qui contient l'identifiant de l'élément, le nom, le système, la date de connexion (onSinceDate), l'heure de connexion (onSinceTime), la durée de connexion (TotalTime ) et self. 'self' contient 1 l'élément est l'utilisateur qui a appelé la fonction. -</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getusername"> - <refnamediv> - <refname>hw_Username</refname> - <refpurpose>Nom de l'utilisateur actuellement identifié.</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <funcsynopsis> - <funcdef>string <function>hw_getusername</function></funcdef> - <paramdef>int <parameter>connection</parameter></paramdef> - </funcsynopsis> - <para> - Retourne le nom d'utilisateur utilisé par la connexion.</para> - </refsect1> - </refentry> - - </reference> - -<!-- Keep this comment at the end of the file -Local variables: -mode: sgml -sgml-omittag:t -sgml-shorttag:t -sgml-minimize-attributes:nil -sgml-always-quote-attributes:t -sgml-indent-step:1 -sgml-indent-data:t -sgml-parent-document:nil -sgml-default-dtd-file:"../manual.ced" -sgml-exposed-tags:nil -sgml-local-catalogs:nil -sgml-local-ecat-files:nil -End: ---> + <reference id="ref.hyperwave"> + <title>Fonctions Hyperwave</title> + <titleabbrev>Hyperwave</titleabbrev> + <partintro> + <sect1 id="hw-intro"> + <title>Introduction</title> + <para> + <productname>Hyperwave</productname> a été developpé par + <ulink url="http://www.iicm.edu">IICM</ulink> à Graz. Son nom + original était <acronym>Hyper-G</acronym> et il a pris le nom de + Hyperwave lors de sa commercialisation (en 1996, si mes souvenirs sont bons). + </para> + <para> + Hyperwave n'est pas gratuit. La version actuelle est la 4.1, disponible à + <ulink url="http://www.hyperwave.com/">www.hyperwave.com</ulink>. Une version + limitée à 30 jours peut être demandée. + </para> + <para> + <acronym>HIS</acronym> est un système d'information similaire à + une base de données, (HIS, Hyperwave Information Server). HIS se + concentre sur l'enregistrement et la gestion des documents. Un document peut + être n'importe quelle donnée, qui peut être stockée + dans un fichier. Chaque document est accompagné par un enregistrement. + Cet enregistrement contient des méta données à propos + du document. Ces méta données sont des listes d'attributs qui + peuvent être étendues par l'utilisateur. Un attribut est une paire + clé/valeur de la forme : clé =valeur. L'enregistrement complet + contient autant de paire que le désire l'utilisateur. Le nom d'un + attribut n'a pas besoin d'être unique, c'est à dire qu'une + même clé peut apparaître plusieurs fois dans un + enregistrement. Cela peut être utile si vous devez donner un + titre à votre document en plusieurs langues, par exemple. Dans un + cas pareil, la convention est que chaque valeur de titre est + précédée par deux lettres et deux points, tel que : + 'fr:Titre en français' ou 'ge:Titel in deutsch'. D'autres attributs + comme une description ou des mots clés sont aussi suceptibles de + recourir à ce genre de procédé. Vous pouvez aussi + remplacer l'abréviation de langage par une autre chaîne, + tant qu'elle est séparée de la valeur par les deux points. + </para> + <para> + Chaque enregistrement a une représentation native qui contient toutes + les paires clé/valeur, séparées par un retour à + la ligne. L'extension Hyperwave reconnaît une autre représentation + qui est un tableau associatif, oú les attributs servent de clés. + Les attributs multilingues étant géré sous la forme d'un + autre tableau associatif, dont les clés sont les chaînes de + langue. En fait, tous les attributs multiformes sont gérés + sous la forme de tableau associatif. (Cela n'est pas encore complètement + codé. Uniquement les attributs de titre, description et mot clés + sont traités correctement). + </para> + <para> + En dehors des documents, tous les hyper liens contenus dans un documents sont + enregistrés dans un autre enregistrement. Les hyperliens qui sont + à l'intérieur d'un document en seront supprimés, et + enregistrés dans des objets particuliers, au moment de l'insertion + dans la base de données. L'enregistrement des hyper-liens + contient les informations d'origine et d'objectif. Afin d'accéder + au document original, vous devre lire le document sans les liens, puis lire + les liens, et les réinsérer (les + <function>hw_pipedocument</function> et <function>hw_gettext</function> le + font pour vous. L'avantage de séparer les liens du document est + évident : une fois qu'un document, cible d'un hyperlien, a + été renommé, le liens peut facilement être + modifié. Le document contenant le lien n'est pas modifié + pour autant. Vous pouvez même ajouter un lien à un document sans + le modifier. + </para> + <para> + Dire que <function>hw_pipedocument</function> et <function>hw_gettext</function> + font l'insertion automatiquement n'est pas aussi simple qu'il n'y paraît. + L'insertion implique une certaine hiérarchie de document. Sur un serveur + web, la hiérarchie est fournie par le système de fichiers, mais + Hyperwave dispose de sa propre hiérarchie et les noms de fichiers ne + reflètent pas la position d'un objet dans cette hiérarchie. + Ainsi, la création de liens requière en premier lieu + la construction de la hiérarchie et de l'espace des noms dans + une hiérarchie web et un espace de nom web. La différence + fondamentale entre Hyperwave et le web est qu'il y a une distinction claire + en les noms et la hiérarchie dans Hyperwave. Le nom ne contient aucune + information à propos de la position de l'objet dans la hiérarchie. + Sur le web, le nom contient les informations de localisation dans la + hiérarchie. Cela conduit à deux méthodes de d'accès : + soit la hiérarchie Hyperwave et le nom de l'objet sont inscrit dans + l'URL. Pour simplifier les choses, une deuxième approche est + pratiquée. L'objet Hyperwave de nom 'mon_objet' correspond à + l'URL 'http://hote/mon_objet', peu importe alors oú il est rangé + dans la hiérarchie. Un objet dont le nom est 'parent/mon_objet' peut + être le fils de l'objet 'mon_objet' dans la hiérarchie Hyperwave, + bien que ce soit le contraire en convention web, et cela risque de perturber + l'utilisateur. + </para> + <para> + Ayant pris cette décision, un deuxième problème surgit : + comment faire l'interface avec PHP ? L' URL http://hote/mon_objet n'appelera + aucun script PHP à moins que vous ne demandiez à votre serveur + web de le remplacer par autre chose, comme par exemple : + 'http://host/php3_script/mon_objet' et le script 'php3_script' utilise la + variable $PATH_INFO pour rechercher l'objet 'mon_objet' sur le serveur Hyperwave. + Il y a juste un petit inconvénient , qui peut facilement être + corrigé. Réécrire une URL ne vous permettra aucun + accès aux autres documents du serveur web. Un script de recherche + dans le serveur Hyperwave serait impossible. Il vous faudra donc au moins + une autre règle pour exclure certaines URL, comme par exemple celles + qui commencent par http://host/Hyperwave. Voici de manière simple, + la manière de partager un espace de nom entre un serveur web et un + serveur Hyperwave serveur. + </para> + <para> + Basé sur le mécanisme précédent, on trouve + l'insertion dans les documents. + </para> + <para> + Il est plus compliqué d'avoir PHP ne fonctionne pas comme un module + de serveur, ou un scrip CGI, mais comme une application indépendante. + Dans ce cas, il est utile d'inscrire la hiérarchie et le nom de fichier + Hyperwave dans le système de fichier. Mais comme cela risque d'entrer + en conflit avec le séparateur de dossier ('/'), il faut le remplacer + par un autre caractère,. '_'. + </para> + <para> + Le protocole réseau pour communiquer avec un serveur Hyperwave est + appelé <ulink url="http://www.hyperwave.de/7.17-hg-prot">HG-CSP</ulink> + (Hyper-G Client/Server Protocol). Il est basé sur des messages qui + initie des actions, comme par exemple, lire l'entête de fichier. Dans + les premières versions de Hyperwave Server deux clients natifs + (Harmony, Amadeus) étaient fournis pour permettre la communication + avec le serveur. Ils ont disparu lors de la commercialisation de Hyperwave. + En tant qu'ersatz, un client appelé wavemaster est désormais + fourni. wavemaster est un espèce ce convertisseur de protocole de + <abbrev>HTTP</abbrev> en <abbrev>HG-CSP</abbrev>. L'idée est de faire + toute l'administration de la base et la visualisation des documents par une + interface web. Le wavemaster implémente un jeu d'emplacement pour + certaines actions de personnalisation de l'interface. Ce jeu est appelé + <abbrev>PLACE</abbrev> language. <abbrev>PLACE</abbrev> pêche encore par + le manque de nombreuse fonctions de programmations, et le manque + d'évolutivité. Cela a conduit à l'utilisation de + JavaScript ce qui ne rend pas la vie facile. + </para> + <para> + Que PHP supporte Hyperwave permet de combler ces manques. PHP implémente + tous les messages définis par <abbrev>HG-CSP</abbrev> mais fourni + d'autres commandes puissantes, comme par exemple, celle de lire des documents + complets. + </para> + <para> + Hyperwave dispose de sa propre terminologie pour localiser certaines + informations. Cette terminologie a été largement étendue. + Presque toutes les fonctions utilisent l'un des types de données + suivants : + <itemizedlist> + <listitem> + <simpara> + object ID: un entier, unique pour chaque objet sur le serveur Hyperwave. C'est + aussi un des attributs de l'enregistrement de l'objet (ObjectID).Les object ids + sont souvent utilisées comme paramètre d'entrée pour + spécifier un objet. + </simpara> + </listitem> + <listitem> + <simpara> + object record: Une chaîne contenant des paires clé=valeur. Les + paires sont séparées par un retour à la ligne. Un + enregistrement d'objet peut facilement être converti en tableau, avec + la fonction <function>hw_objrec2array</function>. De nombreuses fonctions + retournent un object records. Ces fonctions ont leur nom qui finit par obj. + </simpara> + </listitem> + <listitem> + <simpara> + object array: Un tableau associatif qui contient tous les attributs d'un objet. + La clé est l'attribut. Si un attribut apparaît plusieurs fois, il + sera représenté sous la forme d'un tableau associatif ou + indexé. Les attributs qui dépendent des langues (comme title, + keyword ou description) seront représentés sous la forme d'un + tableau associatif, dont les clés seront les abréviations de + langues. Tous les autres attributs à valeur multiple prendront la + forme d'un tableau indexé. + </simpara> + </listitem> + <listitem> + <simpara> + hw_document: Ce type est un nouveau type de données, qui contient le + document lui même, comme par exemple HTML, PDF etc. Il est + optimisé pour les documents HTML mais peut s'utiliser avec n'importe + quel format. + </simpara> + </listitem> + </itemizedlist> + </para> + <para> + De nombreuses fonctions qui retournent un tableau d'enregistrements, retournent + aussi un tableau associé, avec des informatiosn statistiques. Ce tableau + est le dernier élément du tableau d'enregistrements. Les + statistiques contiennent les entrées suivantes : + <variablelist> + <varlistentry> + <term>Hidden</term> + <listitem> + <simpara> + Nombre d'objets dont l'attribut PresentationHints est Hidden. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>CollectionHead</term> + <listitem> + <simpara> + Nombre d'objet dont l'attribut PresentationHints est CollectionHead. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>FullCollectionHead</term> + <listitem> + <simpara> + Nombre d'objet dont l'attribut PresentationHints est FullCollectionHead. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>CollectionHeadNr</term> + <listitem> + <simpara> + Index du premier objet du tableau d'enregistrement avec l'attribut + PresentationHints à CollectionHead. + </simpara></listitem> + </varlistentry> + <varlistentry> + <term>FullCollectionHeadNr</term> + <listitem> + <simpara> + Index du premier objet du tableau d'enregistrement avec l'attribut + PresentationHints est FullCollectionHead. + </simpara> + </listitem> + </varlistentry> + <varlistentry> + <term>Total</term> + <listitem> + <simpara> + Total: Nombre d'enregistrements. + </simpara> + </listitem> + </varlistentry> + </variablelist> + </para> + </sect1> + <sect1 id="hw-apache"> + <title>Intégration avec Apache</title> + <para> + L'extension Hyperwave est utilisée de manière optimale lorsque + PHP est compilé comme module Apache. Dans ce cas, le serveur Hyperwave + sous jacent peut être caché quasiment totalement aux utilisateurs, + si Apache utilise son moteur d'écriture. Les explications suivantes vous + éclaireront : + </para> + <para> + Etant donné que PHP avec l'extension Hyperwave et Apache tend à + remplacer la solution native basé sur Wavemaster, je vais supposer que + le serveur Apache servira seulement d'interface Hyperwave. Ce n'est pas + nécessaire, mais cela simplifie grandment la configuration. Le + concept est très simple. Premièrement, vous avez besoin d'un + script PHP qui évalue la variable <envar>PATH_INFO</envar> et + considère que cette valeur est un objet Hyperwave. Appelons ce script + 'Hyperwave'. L'URL + <systemitem role="url">http://votre.hote/Hyperwave/nom_objet</systemitem> + retourne alors l'objet Hyperwave dont le nom est 'nom_objet'. Le script doit + alors réagir suivant le type de l'objet. Si c'est un groupe, il devra + probablement retourner une liste de fils. Si c'est un document, il pourra + retourner son type MIME et son contenu. Une amélioration peut + être obtenue en utilisant le moteur de réécriture d'Apache. + D'un point de vue utilisateur, il est plus direct si l'URL + <systemitem role="url">http://votre.hote/nom_objet</systemitem> + retourne l'objet. La règle de réécriture est simple : + <informalexample> + <programlisting role="apache-conf"> +RewriteRule ^/(.*) /usr/local/apache/htdocs/HyperWave/$1 [L] + </programlisting> + </informalexample> + Maintenant toutes les URL pointent sur un objet Hyperwave. Cela conduit à + un problème simple. Il n'y a pas d'autre façon d'exécuter, + c'est à dire rechercher, un autre script que ce script 'Hyperwave'. + Cela pourra être corrigé avec une autre règle telle que: + <informalexample> + <programlisting role="apache-conf"> +RewriteRule ^/hw/(.*) /usr/local/apache/htdocs/hw/$1 [L] + </programlisting> + </informalexample> + Le dossier <filename class="directory">/usr/local/apache/htdocs/hw</filename> + sera ainsi reservé pour d'autres scripts et fichiers. Assurez vous que + cette règle est évaluée avant la première + règle que nous avons définie. Il y a juste un léger + inconvénient : tous les objets Hyperwave qui commencent par 'hw/' seront + cachés. Alors, assurez vous que vous n'utilisez pas de tels noms. Si vous + avez besoin d'autres dossiers, par exemple, un dossier d'images, ajoutez + simplement d'autres règles. N'oubliez pas de lancer le moteur de + réécriture avec + <informalexample> + <programlisting role="apache-conf"> +RewriteEngine on + </programlisting> + </informalexample> + Mon expérience m'a montré que vous aurez besoin + des scripts suivants : + <itemizedlist> + </simpara> + </listitem> + <listitem> + <simpara> + Retourne l'objet lui même + </simpara> + </listitem> + <listitem> + <simpara> + Pour autoriser la recherche + </simpara> + </listitem> + <listitem> + <simpara> + S'identifier + </simpara> + </listitem> + <listitem> + <simpara> + Choisir une configuration + </simpara> + </listitem> + <listitem> + <simpara> + Un script pour chaque fonction supplémentaire, comme afficher + un objet, afficher des informations sur les utilisateurs, afficher + le statut du serveur, etc... + </simpara> + </listitem> + </itemizedlist> + </para> + </sect1> + <sect1 id="hw-todo"> + <title>A faire</title> + <para> + Il reste encore beaucoup à faire : + <itemizedlist> + <listitem> + <simpara> + La fonction hw_InsertDocument doit être séparée + en deux : <function>hw_insertobject</function> et + <function>hw_putdocument</function>. + </simpara> + </listitem> + <listitem> + <simpara> + Les noms de nombreuses fonctions ne sont pas encore fixés. + </simpara> + </listitem> + <listitem> + <simpara> + La plupart des fonctions requièrent la connexion courante + comme premier paramètre. Cela conduit à beaucoup de frappe + clavier, même si il n'y a souvent qu'une seule connexion en jeu. + Une connexion par défaut améliorerait ceci. + </simpara> + </listitem> + </itemizedlist> + </para> + </sect1> + </partintro> + <refentry id="function.hw-array2objrec"> + <refnamediv> + <refname>hw_Array2Objrec</refname> + <refpurpose>converti un tableau en un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_array2objrec</function></funcdef> + <paramdef>array <parameter>object_array</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_array2objrec</function> onvertit un + <parameter>object_array</parameter> en un objet. Les attributs multiples + tels que 'Title' en différentes langues seront traités + correctement. + </para> + <para> + Voir aussi <function>hw_objrec2array</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-children"> + <refnamediv> + <refname>hw_Children</refname> + <refpurpose>Liste des object ids des objets fils.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_children</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_children</function> retourne un tableau avec des object ids. + Chaque object id est celui d'un des fils du groupe dont l'id est + <parameter>objectID</parameter>. Ce tableau contient tous les fils, + documents et groupes. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-childrenobj"> + <refnamediv> + <refname>hw_ChildrenObj</refname> + <refpurpose>Liste des object records des objets fils.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_childrenobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_childrenobj</function> retourne un tableau avec des + object records. Chaque object records est celui d'un des fils du groupe + dont l'id est <parameter>objectID</parameter>. + Ce tableau contient tous les fils, documents et groupes + </para> + </refsect1> + </refentry> + <refentry id="function.hw-close"> + <refnamediv> + <refname>hw_Close</refname> + <refpurpose>Ferme la connexion Hyperwave.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_close</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_close</function> retourne FALSE si la connexion n'est pas valide, + et sinon, true. Ferme la connexion connection à un serveur Hyperwave. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-connect"> + <refnamediv> + <refname>hw_Connect</refname> + <refpurpose>Ouvre une connexion Hyperwave.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_connect</function></funcdef> + <paramdef>string <parameter>host</parameter></paramdef> + <paramdef>int <parameter>port</parameter></paramdef> + <paramdef>string <parameter>username</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_connect</function> ouvre une connexion Hyperwave et retourne + un identifiant de connexion, en cas de succès, ou false, si la + connexion n'a pas pu être créée. Chaque argument + doit être entouré de guillemets, sauf le numéro de + port. Les arguments <parameter>username</parameter> et + <parameter>password</parameter> sont optionnels, et peuvent être + ignorés. Dans ce cas, aucune identification ne sera faite au niveau + du serveur. Cela revient à s'identifier en tant qu'utilisateur anonyme. + Cette fonction retourne un identifiant de connexion qui sera nécessaire + aux autres fonctions Hyperwave. Vous pouvez avoir plusieurs connexions + simultanées. N'oubliez pas que les mots de passe ne sont pas + cryptés. + </para> + <para> + Voir aussi <function>hw_pconnect</function>.</para> + </refsect1> + </refentry> + <refentry id="function.hw-cp"> + <refnamediv> + <refname>hw_Cp</refname> + <refpurpose>Copie des objets.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_cp</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>array <parameter>object_id_array</parameter></paramdef> + <paramdef>int <parameter>destination_id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_cp</function> copie les objet ayant les objects id + <parameter>object_id_array</parameter>, et crée un groupe + ayant l'object id <parameter>destination_id</parameter>. + </para> + <para> + La valeur retournée est le nombre d'objets copiés. + </para> + <para> + Voir aussi <function>hw_mv</function>.</para> + </refsect1> + </refentry> + <refentry id="function.hw-deleteobject"> + <refnamediv> + <refname>hw_Deleteobject</refname> + <refpurpose>Efface des objets.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_deleteobject</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>object_to_delete</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_deleteobject</function> efface l'objet dont l'identifiant est + <parameter>object_to_delete</parameter>. Toutes les instances de l'objets + seront effacées. + </para> + <para> + Retourne TRUE si aucune erreur ne survient, et sinon, FALSE. + </para> + <para> + Voir aussi <function>hw_mv</function>.</para> + </refsect1> + </refentry> + <refentry id="function.hw-docbyanchor"> + <refnamediv> + <refname>hw_DocByAnchor</refname> + <refpurpose>Identifiant d'objet de l'objet dans l'ancrage.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_docbyanchor</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>anchorID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_docbyanchor</function> retourne l'dentifiant d'objet de + l'objet dans l'ancrage <parameter>anchorID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-docbyanchorobj"> + <refnamediv> + <refname>hw_DocByAnchorObj</refname> + <refpurpose>Attributs de l'objet dans l'ancrage.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_docbyanchorobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>anchorID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_docbyanchorobj</function> retourne les attributs du + document qui correspond à <parameter>anchorID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-documentattributes"> + <refnamediv> + <refname>hw_DocumentAttributes</refname> + <refpurpose>Object record de hw_document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_documentattributes</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_documentattributes</function> retourne les attributs du document. + </para> + <para> + Voir aussi <function>hw_documentbodytag</function>, + <function>hw_documentsize</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-documentbodytag"> + <refnamediv> + <refname>hw_DocumentBodyTag</refname> + <refpurpose>Balise de corps d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_documentbodytag</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_documentbodytag</function> retourne la balise BODY du + document.Si le document est un document HTML , la balise BODY doit + être affichée avant le document. + </para> + <para> + Voir aussi <function>hw_documentattributes</function>, + <function>hw_documentsize</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-documentcontent"> + <refnamediv> + <refname>hw_DocumentContent</refname> + <refpurpose>Contenu d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_documentcontent</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_documentcontent</function> retourne la balise BODY du + document.Si le document est un document HTML , la balise BODY doit + être affichée avant le document. + </para> + <para> + Voir aussi <function>hw_documentattributes</function>, + <function>hw_documentsize</function>, + <function>hw_documentsetcontent</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-documentsetcontent"> + <refnamediv> + <refname>hw_DocumentSetContent</refname> + <refpurpose>Modifie/remplace le contenu d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_documentsetcontent</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + <paramdef>string <parameter>content</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_documentsetcontent</function> modifie/remplace le contenu + d'un document. Si le document est un document HTML, le contenu + représente tout qui est placé au dela de la balise BODY. + Les informations de HEAD et de la balise BODY sont enregistrés + dans les attributs. Si vous fournissez aussi ces informations dans le + corps du document, le serveur Hyperwave modifiera les attributs. Cela + n'est cependant pas une bonne idée. Si la fonction échoue, + l'ancien contenu est restauré. + </para> + <para> + Voir aussi <function>hw_documentattributes</function>, + <function>hw_documentsize</function>, + <function>hw_documentcontent</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-documentsize"> + <refnamediv> + <refname>hw_DocumentSize</refname> + <refpurpose>Taille d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_documentsize</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_documentsize</function> retourne la taille du document + en octets. + </para> + <para> + Voir aussi <function>hw_documentbodytag</function>, + <function>hw_documentattributes</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-errormsg"> + <refnamediv> + <refname>hw_ErrorMsg</refname> + <refpurpose>Retourne un message d'erreur.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_errormsg</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_errormsg</function> retourne une chaîne contenant + le dernier message d'erreur, ou 'No Error' (pas d'erreur). Si FALSE + est retourné, cette fonction a échoué. Ce message + est relatif à la dernière commande exécutée. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-edittext"> + <refnamediv> + <refname>hw_EditText</refname> + <refpurpose>Retourne un document texte.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_edittext</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_edittext</function> charge le texte du document sur le + serveur. Les attributs du document ne doivent pas être + modifiés tant que le document est en train d'être + édité. Cette fonction n'est disponible que sur les + documents texte. Elle n'ouvrira pas de canal de transfert, et donc, + bloquera le script durant le transfert. + </para> + <para> + Voir aussi <function>hw_pipedocument</function>, + <function>hw_free_document</function>, + <function>hw_documentbodytag</function>, + <function>hw_documentsize</function>, + <function>hw_outputdocument</function>, + <function>hw_gettext</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-error"> + <refnamediv> + <refname>hw_Error</refname> + <refpurpose>Retourne le code d'erreur.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_error</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_error</function> retourne le code d'erreur de la dernière + erreur. Si la valeur 0 est retournée, c'est qu'il n'y avait pas d'erreur. + L'erreur se rapporte à la dernière commande. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-free-document"> + <refnamediv> + <refname>hw_Free_Document</refname> + <refpurpose>Détruit un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_free_document</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_free_document</function> détruit un document Hyperwave. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getparents"> + <refnamediv> + <refname>hw_GetParents</refname> + <refpurpose>Identifiant d'objet des parents.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getparentsobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getparentsobj</function> retourne un tableau indexé + avec les identifiants des objets parents de <parameter>objectID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getparentsobj"> + <refnamediv> + <refname>hw_GetParentsObj</refname> + <refpurpose>Attributs des parents.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getparentsobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getparentsobj</function> retourne un tableau indexé, + avec les attributs et un tableau associé, d'informations statistiques + à propos des attributs. Ce tableau associé est le dernier + élément du tableau retourné. Chaque attribut + appartient au père de l'objet <parameter>objectID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getchildcoll"> + <refnamediv> + <refname>hw_GetChildColl</refname> + <refpurpose>Identifiant d'objet des groupes fils.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getchildcoll</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getchildcoll</function> retourne un tableau contenant les + identifiants d'objets des groupes fils du groupe + <parameter>objectID</parameter>. Cette fonction ne retournera pas + d'identifiants d'objets des documents fils. + </para> + <para> + Voir aussi <function>hw_getchilddoccoll</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getchildcollobj"> + <refnamediv> + <refname>hw_GetChildCollObj</refname> + <refpurpose>object records d'un groupe d'enfants.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getchildcollobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getchildcollobj</function> retourne un tableau d'object record. + Chaque object records appartient à un groupe d'enfants de la + collection <parameter>objectID</parameter>. La fonction ne retournera pas + de documents enfants. + </para> + <para> + Voir aussi <function>hw_childrenobj</function>, + <function>hw_getchilddoccollobj</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getremote"> + <refnamediv> + <refname>hw_GetRemote</refname> + <refpurpose>Retourne un document distant.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_getremote</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getremote</function> retourne un document distant. Les documents + distants sont , en Hyperwave, des documents lus depuis une source externe. La + plus part des documents éloignés sont des pages web externes, ou + des requêtes sur une base de données. Afin de pouvoir + accéder à des sources externes, grâces aux documents distants, + Hyperwave introduit l'interface HGI (Hyperwave Gateway Interface) qui est + similaire à CGI. Actuellement, seuls les protocoles de ftp, http et + certaines bases de données sont accessibles avec HGI. + <function>hw_getremote</function> retourne le document de la source + distante. Si vous voulez utiliser cette fonction, il vous faut vous + familiariser HGIs. Il est aussi préférable d'utiliser + PHP plutôt que Hyperwave pour accéder aux sources externes. + Le support des bases de données sera plus difficile avec Hyperwave + que PHP. + </para> + <para> + Voir aussi <function>hw_getremotechildren</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getremotechildren"> + <refnamediv> + <refname>hw_GetRemoteChildren</refname> + <refpurpose>Retourne les fils d'un document distant.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_getremotechildren</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>string <parameter>object record</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getremotechildren</function> retourne les fils d'un document + distant. Les fils d'un document distant sont des documents distants eux + mêmes. Cela est cohérent si une requête sur une base + de données doit être rendu plus sélective, comme + expliqué dans Hyperwave Programmers' Guide. Si le nombre de fils + est 1 la fonction va retourner le document lui même, la fonction + retournera le document lui même, formaté Hyperwave Gateway + Interface (HGI). Si le nombre de fils est supérieur 1 la fonction + retournera un tableau d'attributs, qui pourra servir à une nouvelle + requête avec <function>hw_getremotechildren</function>. Ces attributs + sont virtuels et n'existent pas sur le serveur Hyperwave, et ainsi, n'ont pas + d'identifiant d'objet valide. L'ordre exact de ces objets est du ressort de HGI. + Si vous voulez utiliser cette fonction, vous devez être très + familier HGIs. Il vaut mieux PHP plutôt que Hyperwave pour accéder + aux fichiers distants. Le support de base de données y est bien meilleur. + </para> + <para> + Voir aussi <function>hw_getremote</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getsrcbydestobj"> + <refnamediv> + <refname>hw_GetSrcByDestObj</refname> + <refpurpose>Retourne les ancrages qui pointent sur un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getsrcbydestobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getsrcbydestobj</function> retourne les attributs de tous + les ancrages qui pointent sur <parameter>objectID</parameter>. L'objet + peut être un document ou un autre ancrage, de type destination. + </para> + <para> + Voir aussi <function>hw_getanchors</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getobject"> + <refnamediv> + <refname>hw_GetObject</refname> + <refpurpose>Attributs d'un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getobject</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>[int|array] <parameter>objectID</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getobject</function> retourne les attributs de l'objet dont + l'identifiant est <parameter>objectID</parameter>, si le second + paramètre est un entier. Si le second paramètre est un + tableau, la fonction retournera un tableau d'attributs. Dans ce cas, + le dernier paramètre est aussi évalué. + </para> + <para> + <parameter>query</parameter> a la syntaxe suivante : + </para> + <simpara> + <expression> ::= "(" <expression> ")" | + </simpara> + <simpara> + "!" <expression> | /* NOT */ + </simpara> + <simpara> + <expression> "||" <expression> | /* OR */ + </simpara> + <simpara> + <expression> "&&" <expression> | /* AND */ + </simpara> + <simpara> + <attribute> <operator> <value> + </simpara> + <simpara> + <attribute> ::= /* * n'importe quel attribut (Title, Author, DocumentType ...) */ + </simpara> + <simpara> + <operator> ::= "=" | /* égal */ + </simpara> + <simpara> + "<" | /* moins que (comparaison de type chaîne) */ + </simpara> + <simpara> + ">" | /* plus que (comparaison de type chaîne) */ + </simpara> + <simpara> + "~" /* recherche par expression régulière */ + </simpara> + <simpara> + </simpara> + <para> + <parameter>query</parameter> permet de sélectionner une nouvelle fois + certains objets dans la liste des objets donnés. Contrairement aux + autres requêtes, celle ci peut utiliser des attributs non indexés. + Le nombre d'attributs retourné dépend de la requête de la + requête, et des autorisations d'accès aux objets. + </para> + <para> + Voir aussi <function>hw_getandlock</function>, + <function>hw_getobjectbyquery</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getandlock"> + <refnamediv> + <refname>hw_GetAndLock</refname> + <refpurpose>Retourne les attributs, et verrouille l'objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_getandlock</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getandlock</function> retourne les attributs, et verrouille + l'objet <parameter>objectID</parameter>. Le verrouillage empêchera + les autres utilisateurs d'y accéder, jusqu'à ce qu'il soit + deverrouillé. + </para> + <para> + Voir aussi <function>hw_unlock</function>, + <function>hw_getobject</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-gettext"> + <refnamediv> + <refname>hw_GetText</refname> + <refpurpose>Retourne un document texte.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_gettext</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + <paramdef>mixed + <parameter> + <optional>rootID/prefix</optional> + </parameter> + </paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_gettext</function> retourne le document de l'objet + <parameter>objectID</parameter>. Si le document possède des ancrages + qui peuvent être insérés, ils seront déjà + insérés. L'option rootID/prefix peut être une + chaîne ou un entier. Si c'est un entier, il détermine la + méthode d'insertion des liens dans le document. Par défaut, + il vaut 0 et les liens seront construits en fonction du nom de l'objet cible. + Cela sert beaucoup dans les applications web. Si un lien pointe sur un objet + avec le nom 'film_internet' le lien HTML sera <A HREF="/internet_movie">. + La position réelle de la source et de la cible dans la hiérarchie + seront ignorés. Vous devrez modificer votre site web pour qu'il + réécrive les URL, comme par exemple + '/mon_script.php3/film_internet'. 'mon_script.php3' devra analyser + $PATH_INFO et savoir recherche le document '/mon_script.php3/film_internet'. + Si vous ne voulez pas de ce comportement, vous pouvez affecter à + rootID/prefix n'importe quel prefixe. Dans ce cas, ce sera une chaîne. + </para> + <para> + Si <parameter>rootID/prefix</parameter> est un entier différent de 0 + le lien sera construit avec tous les noms de la hiérarchie, en + commencant à l'objet d'identifiant rootID/prefix, et séparé + par des slash. Si, par exemple, le document 'film_internet' est situé + à 'a-b-c-internet_movie' et '-' qui sert de séparateur + hiérarchique de niveau sur le serveur Hyperwave et le document + source est situé dans 'a-b-d-source' alors, le lien HTML serait: + <A HREF="../c/internet_movie">. Cela est très pratique si vous + voulez télécharger tout le contenu d'un serveur sur un disque, + et faire une carte du système sur votre disque. + </para> + <para> + <function>hw_gettext</function> n'est opérationnelle qu'avec des + documents de pur texte. Elle n'ouvrira pas de canal spécial de + transfert, et ainsi, bloquera le script le temps du transfert. + </para> + <para> + Voir aussi <function>hw_pipedocument</function>, + <function>hw_free_document</function>, + <function>hw_documentbodytag</function>, + <function>hw_documentsize</function>, + <function>hw_outputdocument</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getobjectbyquery"> + <refnamediv> + <refname>hw_GetObjectByQuery</refname> + <refpurpose>Recherche un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getobjectbyquery</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> + <paramdef>int <parameter>max_hits</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getobjectbyquery</function> recherche un objet sur tout le serveur + et retourne un tableau d' object ids. Le nombre maximum d'objet est limité + par <parameter>max_hits</parameter>. Si <parameter>max_hits</parameter> vaut -1 + il n'y a pas de limite. + </para> + <para> + La requête ne fonctionnera qu'avec des attributs indexés. + </para> + <para> + Voir aussi <function>hw_getobjectbyqueryobj</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getobjectbyqueryobj"> + <refnamediv> + <refname>hw_GetObjectByQueryObj</refname> + <refpurpose>Recherche un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getobjectbyqueryobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> + <paramdef>int <parameter>max_hits</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getobjectbyqueryobj</function> recherche un objet sur tout le + serveur et retourne un tableau d' object records. Le nombre maximum d'objet + est limité par <parameter>max_hits</parameter>. Si + <parameter>max_hits</parameter> vaut -1 il n'y a pas de limite. + </para> + <para> + La requête ne fonctionnera qu'avec des attributs indexés. + </para> + <para> + Voir aussi <function>hw_getobjectbyquery</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getobjectbyquerycoll"> + <refnamediv> + <refname>hw_GetObjectByQueryColl</refname> + <refpurpose>Recherche un objet dans un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getobjectbyquerycoll</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> + <paramdef>int <parameter>max_hits</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getobjectbyquerycoll</function> recherche un objet sur tout + le groupe objectID et retourne un tableau d' object records. Le nombre + maximum d'objet est limité par <parameter>objectID</parameter>. Si + <parameter>objectID</parameter> vaut -1 il n'y a pas de limite. + </para> + <para> + La requête ne fonctionnera qu'avec des attributs indexés. + </para> + <para> + Voir aussi <function>hw_getobjectbyquerycollobj</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getobjectbyquerycollobj"> + <refnamediv> + <refname>hw_GetObjectByQueryCollObj</refname> + <refpurpose>Recherche un objet dans un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getobjectbyquerycollobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + <paramdef>string <parameter>query</parameter></paramdef> + <paramdef>int <parameter>max_hits</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getobjectbyquerycollobj</function> recherche un objet sur tout + le groupe objectID et retourne un tableau d' object records. Le nombre maximum + d'objet est limité par <parameter>objectID</parameter>. Si + <parameter>objectID</parameter> vaut -1 il n'y a pas de limite. + </para> + <para> + La requête ne fonctionnera qu'avec des attributs indexés. + </para> + <para> + Voir aussi <function>hw_getobjectbyquerycoll</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getchilddoccoll"> + <refnamediv> + <refname>hw_GetChildDocColl</refname> + <refpurpose>ids des documents fils d'un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getchilddoccoll</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getchilddoccoll</function> retourne un tableau avec les id + des documents fils d'une collection. + </para> + <para> + Voir aussi <function>hw_getchildcoll</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getchilddoccollobj"> + <refnamediv> + <refname>hw_GetChildDocCollObj</refname> + <refpurpose>Attributs des documents fils d'un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getchilddoccollobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getchilddoccollobj</function> retourne un tableau contenant + les attributs des documents fils du groupe <parameter>objectID</parameter>. + </para> + <para> + Voir aussi <function>hw_childrenobj</function>, + <function>hw_getchildcollobj</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getanchors"> + <refnamediv> + <refname>hw_GetAnchors</refname> + <refpurpose>Identifiants des ancrages d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getanchors</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getanchors</function> retourne un tableau contenant les + identifiants des ancrages du document <parameter>objectID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getanchorsobj"> + <refnamediv> + <refname>hw_GetAnchorsObj</refname> + <refpurpose>Attributs des ancrages d'un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_getanchorsobj</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getanchorsobj</function> retourne un tableau d'attributs + des ancrages du document <parameter>objectID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-mv"> + <refnamediv> + <refname>hw_Mv</refname> + <refpurpose>Déplace un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_mv</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>array <parameter>object id array</parameter></paramdef> + <paramdef>int <parameter>source id</parameter></paramdef> + <paramdef>int <parameter>destination id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_mv</function> déplaces les objets dont les identifiants + sont passés dans le tableau <parameter>source id</parameter>, depuis + le <parameter>source id</parameter> dans le + <parameter>destination id</parameter>. Si destination id vaut 0, les objets + ne seront plus insérés dans le groupe (ni dans le serveur). + Dans ce cas, si une instance était la dernière instance d'un + objet, l'objet sera effacé. Si vous voulez effacer toutes les instances + d'un coup, utilisez <function>hw_deleteobject</function>. + </para> + <para> + La valeur retournée est le nombre d'objet déplacés. + </para> + <para> + Voir aussi <function>hw_cp</function>, + <function>hw_deleteobject</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-identify"> + <refnamediv> + <refname>hw_Identify</refname> + <refpurpose>Identifie un utilisateur.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_identify</function></funcdef> + <paramdef>string <parameter>username</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_identify</function> identifie un utilisateur, dont le nom + d'utilisateur est <parameter>username</parameter> et le mot de passe + <parameter>password</parameter>. L'identification n'est valide + que pour la session en cours. Je ne pense pas que cette fonction serve + souvent. Dans la plus part des cas, il est plus simple de s'identifier lors + de l'ouverture de la connexion. + </para> + <para> + Voir aussi <function>hw_connect</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-incollections"> + <refnamediv> + <refname>hw_InCollections</refname> + <refpurpose> + Vérifie qu'un identifiant d'objet est dans un groupe. + </refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_incollections</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>array <parameter>object_id_array</parameter></paramdef> + <paramdef>array <parameter>collection_id_array</parameter></paramdef> + <paramdef>int <parameter>return_collections</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_incollections</function> vérifie qu'un ensemble d'objets + (documents ou groupes) donnés par <parameter>object_id_array</parameter> + fait partie des groupe listés par <parameter>object_id_array</parameter>. + Lorsque le quatrième paramètre + <parameter>return_collections</parameter> vaut 0, le sous ensemble + d'identifiants qui font partie d'un groupe (i.e. les documents ou groupes + qui sont fils d'un ou plusieurs groupe, ou leurs fils, récurusivement) + est retourné sous la forme d'un tableau. Cette option permet de mettre + en valeur la partie de l'arborescence qui contient le résultat d'une + requête, dans un sens graphique. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-info"> + <refnamediv> + <refname>hw_Info</refname> + <refpurpose>Informations à propos d'une connexion.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_info</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_info</function> retourne les informations de la connexion + courante. La chaîne retournée a le format suivant : + <Serverstring>, <Host>, <Port>, <Username>, + <Port of Client>, <Byte swapping> + </para> + </refsect1> + </refentry> + <refentry id="function.hw-inscoll"> + <refnamediv> + <refname>hw_InsColl</refname> + <refpurpose>Insère un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_inscoll</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + <paramdef>array <parameter>object_array</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_inscoll</function> insère un nouveau groupe, avec + les attributs <parameter>object_array</parameter> dans le groupe + <parameter>objectID</parameter>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-insdoc"> + <refnamediv> + <refname>hw_InsDoc</refname> + <refpurpose>Insère un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_insdoc</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>parentID</parameter></paramdef> + <paramdef>string <parameter>object_record</parameter></paramdef> + <paramdef>string <parameter>text</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_insdoc</function> insère un nouveau document avec + les attributs <parameter>object_record</parameter>, dans le groupe + <parameter>parentID</parameter>. Cette fonction insère soit un objet + avec ses seuls attributs, soit pur objet ascii, avec + <parameter>text</parameter> si il est fourni. Si vous voulez insérer + un document de type général, utilisez plutôt + <function>hw_insertdocument</function>. + </para> + <para> + Voir aussi <function>hw_insertdocument</function>, + <function>hw_inscoll</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-insertdocument"> + <refnamediv> + <refname>hw_InsertDocument</refname> + <refpurpose>Insère un document dans un groupe.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_insertdocument</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>parent_id</parameter></paramdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_insertdocument</function> insère un document dans le + groupe <parameter>parent_id</parameter>. Le document doit avoir + été créé auparavant avec + <function>hw_new_document</function>. Assurez vous que les attributs du + nouveau document contiennent au moins les attributs suivants : + Type, DocumentType, Title et Name. Vous aurez aussi parfois besoin de + MimeType. La fonction retourne l'identifiant de l'objet inséré, + ou bien false. + </para> + <para> + Voir aussi <function>hw_pipedocument</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-insertobject"> + <refnamediv> + <refname>hw_InsertObject</refname> + <refpurpose>Insère un object record.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_insertobject</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>string <parameter>object rec</parameter></paramdef> + <paramdef>string <parameter>parameter</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_insertobject</function> insère un objet dans + le serveur. L'objet peut être n'importe quel objet Hyperwave + valide. Reportez vous à la documentation HG-CSP pour plus + de détails sur les paramètres. + </para> + <para> + Note: Si vous voulez insérer un ancre, l'attribut Position + doit être mis à la valeur start/end (début ou + fin) ou encore 'invisible'. Les positions invisibles sont nécessaire + si l'annotation n'a pas de liens correspondant dans le texte de + l'annotation. + </para> + <para> + Voir aussi <function>hw_pipedocument</function>, + <function>hw_insertdocument</function>, + <function>hw_insdoc</function>, + <function>hw_inscoll</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-mapid"> + <refnamediv> + <refname>hw_mapid</refname> + <refpurpose>Représente un id globale en un id virtuel local.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_mapid</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>server id</parameter></paramdef> + <paramdef>int <parameter>object id</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_mapid</function> représente l'id d'un objet global de n'importe + quel serveur Hyperwave, même si vous ne vous y êtes pas + connecté avec <function>hw_connect</function>, avec un id d'objet + local virtuel. Cet id d'objet local peut alors être utilisé + comme n'importe quel id d'objet : par exemple on peut obtenir l'enregistrement + d'objet avec la fonction <function>hw_getobject</function>. L'id du serveur + est la première partie de l'id global (GOid) de l'objet, qui est en + fait une adresse IP. + </para> + <para> + Note: Afin d'utiliser cette fonction, vous devez lever le flag F_DISTRIBUTED, + ce qui ne peut être fait qu'à la compilation. Par défaut, + il n'est pas levé. Lisez les commentaires dans le fichier hg_comm.c + </para> + </refsect1> + </refentry> + <refentry id="function.hw-modifyobject"> + <refnamediv> + <refname>hw_Modifyobject</refname> + <refpurpose>Modifie les attributs d'objet record.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_modifyobject</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>object_to_change</parameter></paramdef> + <paramdef>array <parameter>remove</parameter></paramdef> + <paramdef>array <parameter>add</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_modifyobject</function> permet d'effacer, d'ajouter ou de + modifier les attributs d'un objet. L'objet est reperé par son + identifiant <parameter>object_to_change</parameter>. Le premier tableau, + <parameter>remove</parameter>, est la liste des attributs à effacer. + Le deuxième tableau <parameter>add</parameter> est la liste des + attributs à ajouter. Afin de modifier un attribut, il vous faudra + dont l'effacer, puis l'ajouter à nouveau. + <function>hw_modifyobject</function> effacera toujours les attributs avant + de les ajouter, à moins que la valeur de l'attribut à effacer + ne soit pas une chaîne, ou un tableau. + </para> + <para> + Le dernier paramètre détermine si la modification est + récursive ou pas. 1 signigie que la modification est récursive. + Si un objet ne peut pas être modifié, il sera ignoré. + <function>hw_error</function> n'indiquera alors pas toujours d'erreur, + même si certains objets n'ont pas pu être modifié. + </para> + <para> + Les clés des deux tableaux sont les noms des attributs. La valeurs + de chaque élément peut être un tableau, ou une chaîne + ou n'importe quoi d'autre. Dans le cas du tableau, la valeur de l'attribut + est construite en séparant chaque élément par un + point virgule. Dans le cas de la chaîne, elle sert directement de + valeur. Une chaîne vide provoquera un effacement de l'attribut. + Dans le cas oú la valeur n'est ni un tableau, ni une chaîne, + aucune opération ne sera effectuée. Cela est nécessaire + si vous voulez ajouter un attribut complètement une nouvelle valeur pour + un attribut existant. Si le tableau d'effacement contenait une chaîne + vide comme attribut, le serveur tenterait d'effacer l'attribut, ce qui + échouerai de toute manière, car cet attribut n'existe pas. + L'ajout de cet attribut échouerai aussi. Affecter la valeur de 0 + à cet attribut ne l'effacerait pas, et l'ajout fonctionnerait. + </para> + <para> + Si vous voulez changer l'attribut 'Nom' de valeur courante 'livres' en + 'articles' vous devrez faire deux tableaux, et appeler + <function>hw_modifyobject</function>. + <example> + <title>Modification d'un attribut</title> + <programlisting role="php"> + // $connect est une connexion valide + // $objid est l'identifiant de l'objet + $remarr = array("Name" => "books"); + $addarr = array("Name" => "articles"); + $hw_modifyobject($connect, $objid, $remarr, $addarr); + </programlisting> + </example> + Afin d'effacer/ajouter une paire nom=valeur aux attributs d'un objet, + utilisez simplement les tableaux d'effacement et d'ajout, et laissez + le dernier/troisième paramètre vide. Si l'attribut est + le premier de ce nom à ajouter, donnez une valeur entière + à cet élément. + <example> + <title>Ajouter un nouvel attribut</title> + <programlisting role="php"> + // $connect st une connexion Hyperwave valide + // $objid est l'identifiant de l'objet à modifier + $remarr = array("Name" => 0); + $addarr = array("Name" => "articles"); + $hw_modifyobject($connect, $objid, $remarr, $addarr); + </programlisting> + </example> + </para> + <para> + <note> + <simpara> + Les attributs multilingues, (tels que 'Title'), peuvent être + modifiés de deux manières : soit en fournissant la + valeur de ces attributs de manière native (langue :valeur), + soit en fournissant un tableau avec les éléments de + chaque langue, comme décrit ci-dessus. L'exemple deviendrai + alors : + </simpara> + </note> + <example> + <title>Modifier l'attribut de Titre (Title)</title> + <programlisting role="php"> + $remarr = array("Title" => "en:Books"); + $addarr = array("Title" => "en:Articles"); + $hw_modifyobject($connect, $objid, $remarr, $addarr); + </programlisting> + </example> + ou + <example> + <title>Modifier l'attribut Title</title> + <programlisting role="php"> + $remarr = array("Title" => array("en" => "Books")); + $addarr = array("Title" => array("en" => "Articles", "ge"=>"Artikel")); + $hw_modifyobject($connect, $objid, $remarr, $addarr); + </programlisting> + </example> + Pour supprimer l'entrée française 'Livres' et ajouter + l'entrée 'Articles' et l'entrée allemande 'Artikel'. + <example> + <title>Suppression d'un attribut</title> + <programlisting role="php"> + $remarr = array("Title" => ""); + $addarr = array("Title" => "en:Articles"); + $hw_modifyobject($connect, $objid, $remarr, $addarr); + </programlisting> + </example> + <note> + <simpara> + Cet exemple va effacer tous les attributs avec le nom 'Title' et ajouter + un nouvel attribut 'Title'. Cela peut être pratique pour effacer des + attributs récursivement. + </simpara> + </note> + <note> + <simpara> + Si vous devez effacer tous les attributs avec un certains nom, vous devez + passer une chaîne vide comme valeur. + </simpara> + </note> + <note> + <simpara> + Seuls les attributs 'Title', 'Description' et 'Keyword' gère + correctement le préfixe de langue. Pour les autres attributs qui + ne portent pas de préfixe de language, le préfixe 'xx' sera + assigné. + </simpara> + </note> + <note> + <simpara> + L'attribut 'Name' est un peu particuluer. Dans certains cas, il ne peut pas + être complétement effacé. Vous aurez alors le message + 'Change of base attribute' (l'apparition de cette erreur n'est pas très + claire). Ainsi, vous aurez à ajouter une nouvelle entrée pour + Name puis, effacer l'ancien. + </simpara> + </note> + <note> + <simpara> + Il ne faut pas encadrer cette fonction par des appels à + <function>hw_getandlock</function> et <function>hw_unlock</function>. + <function>hw_modifyobject</function> le fait de manière interne. + </simpara> + </note> + </para> + <para> + Retourne TRUE si aucune erreur ne survient, et FALSE sinon. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-new-document"> + <refnamediv> + <refname>hw_New_Document</refname> + <refpurpose>Crée un nouveau document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_new_document</function></funcdef> + <paramdef>string <parameter>object_record</parameter></paramdef> + <paramdef>string <parameter>document_data</parameter></paramdef> + <paramdef>int <parameter>document_size</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_new_document</function> retourne un nouveau document Hyperwave + avec comme données <parameter>document_data</parameter> et comme + attributs <parameter>object_record</parameter>. La longueur de + <parameter>document_data</parameter> doit être données dans + <parameter>document_size</parameter>. Cette fonction n'insère pas + l'objet dans le serveur Hyperwave. + </para> + <para> + Voir aussi <function>hw_free_document</function>, + <function>hw_documentsize</function>, + <function>hw_documentbodytag</function>, + <function>hw_outputdocument</function>, + <function>hw_insertdocument</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-objrec2array"> + <refnamediv> + <refname>hw_Objrec2Array</refname> + <refpurpose>Converti les attributs d'un objet en tableau.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>array <function>hw_objrec2array</function></funcdef> + <paramdef>string <parameter>object_record</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_objrec2array</function> convertit les attributs + <parameter>object_record</parameter> d'un objet en un tableau. Les + clés du tableau seront les noms des attributs. Les attributs + multiples comme par exemple 'Title', dans différentes langues, + seront rassemblées dans un autre tableau. Une clé est la + partie gauche d'un attribut. Actuellement, seuls les attributs 'Title', + 'Description' et 'Keyword' sont traités correctement. + </para> + <para> + Voir aussi <function>hw_array2objrec</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-outputdocument"> + <refnamediv> + <refname>hw_OutputDocument</refname> + <refpurpose>Affiche hw_document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_outputdocument</function></funcdef> + <paramdef>int <parameter>hw_document</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_outputdocument</function> affiche <parameter>hw_document</parameter> + sans la balise BODY. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-pconnect"> + <refnamediv> + <refname>hw_pConnect</refname> + <refpurpose>Crée une connexion persistante.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_pconnect</function></funcdef> + <paramdef>string <parameter>host</parameter></paramdef> + <paramdef>int <parameter>port</parameter></paramdef> + <paramdef>string <parameter>username</parameter></paramdef> + <paramdef>string <parameter>password</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_pconnect</function> retourne un index de connexion en cas de + succès, et FALSE si la connexion n'a pas pu être créée. + Ouvre une connexion persistante à un serveur Hyperwave. Tous les + arguments doivent être entre guillemets, hormis le numéro + de port (port). Les arguments <parameter>username</parameter> et + <parameter>password</parameter> sont optionnels, et peuvent être + ignorés. Dans ce cas, aucune authentification ne sera faites, + (connexion anonyme). Cette fonction retourne un index de connexion qui + sera utilisée par les autres fonctions Hyperwave. Vous pouvez + ouvrir plusieurs connexions simultanées. + </para> + <para> + Voir aussi <function>hw_connect</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-pipedocument"> + <refnamediv> + <refname>hw_PipeDocument</refname> + <refpurpose>Retourne un document.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_pipedocument</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_pipedocument</function> retourne le document Hyperwave d'objet + id <parameter>objectID</parameter>. Si le document a des ancrages, ils seront + insérés. Le document sera transmis via une connexion de + données spéciale, qui ne bloque pas la connexion de + contrôle (ie, le serveur n'attend pas la fin du transfert pour + rendre la main). + </para> + <para> + Voir aussi <function>hw_gettext</function> (insertions), + <function>hw_free_document</function>, + <function>hw_documentsize</function>, + <function>hw_documentbodytag</function>, + <function>hw_outputdocument</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-root"> + <refnamediv> + <refname>hw_Root</refname> + <refpurpose>Object id de la racine.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_root</function></funcdef> + <paramdef><parameter></parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_root</function> retourne l' object id de la racine. + Actuellement, cette identifiant est toujours 0. L'ensemble des fils + de la racine est celui du serveur courant. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-unlock"> + <refnamediv> + <refname>hw_Unlock</refname> + <refpurpose>Déverrouille un objet.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_unlock</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + <paramdef>int <parameter>objectID</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_unlock</function> déverrouille un document, et laisse + l'accès aux autres utilisateurs. + </para> + <para> + Voir aussi <function>hw_getandlock</function>. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-who"> + <refnamediv> + <refname>hw_Who</refname> + <refpurpose>Liste des utilisateurs actuellement identifiés.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>int <function>hw_who</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_who</function> retourne un tableau contenant la liste des + utilisateurs actuellement connectés au serveur Hyperwave. Chaque + élément du tableau est lui même un tableau, qui contient + l'identifiant de l'élément, le nom, le système, la date + de connexion (onSinceDate), l'heure de connexion (onSinceTime), la + durée de connexion (TotalTime ) et self. 'self' contient + l'élément est l'utilisateur qui a appelé la fonction. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getusername"> + <refnamediv> + <refname>hw_Username</refname> + <refpurpose>Nom de l'utilisateur actuellement identifié.</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <funcsynopsis> + <funcprototype> + <funcdef>string <function>hw_getusername</function></funcdef> + <paramdef>int <parameter>connection</parameter></paramdef> + </funcprototype> + </funcsynopsis> + <para> + <function>hw_getusername</function> retourne le nom d'utilisateur + utilisé par la connexion. + </para> + </refsect1> + </refentry> + </reference> +<!-- Keep this comment at the end of the file +Local variables: +mode: sgml +sgml-omittag:t +sgml-shorttag:t +sgml-minimize-attributes:nil +sgml-always-quote-attributes:t +sgml-indent-step:1 +sgml-indent-data:t +sgml-parent-document:nil +sgml-default-dtd-file:"../manual.ced" +sgml-exposed-tags:nil +sgml-local-catalogs:nil +sgml-local-ecat-files:nil +End: +-->