cvs: phpdoc /fr/functions hw.xml

From: 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 &eacute;t&eacute; developp&eacute; par - <ulink url="http://www.iicm.edu">IICM</ulink> &agrave; Graz. Son nom original &eacute;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 &agrave; - <ulink url="http://www.hyperwave.com/">www.hyperwave.com</ulink>. Une version - limit&eacute;e &agrave; 30 jours peut &ecirc;tre demand&eacute;e. - </para> - <para> - <acronym>HIS</acronym> est un syst&egrave;me d'information similaire &agrave; une base de - donn&eacute;es, (HIS, Hyperwave Information Server). HIS se concentre sur l'enregistrement - et la gestion des documents. Un document peut &ecirc;tre n'importe quelle donn&eacute;e, qui - peut &ecirc;tre stock&eacute;e dans un fichier. Chaque document est accompagn&eacute; par un - enregistrement. Cet enregistrement contient des m&eacute;ta donn&eacute;es &agrave; propos du document. - Ces m&eacute;ta donn&eacute;es sont des listes d'attributs qui peuvent &ecirc;tre &eacute;tendues par - l'utilisateur. Un attribut est une paire cl&eacute;/valeur de la forme : cl&eacute; =valeur. - L'enregistrement complet contient autant de paire que le d&eacute;sire l'utilisateur. - Le nom d'un attribut n'a pas besoin d'&ecirc;tre unique, c'est &agrave; dire qu'une m&ecirc;me cl&eacute; - peut appara&icirc;tre plusieurs fois dans un enregistrement. Cela peut &ecirc;tre utile si - vous devez donner un titre &agrave; votre document en plusieurs langues, par exemple. - Dans un cas pareil, la convention est que chaque valeur de titre est pr&eacute;c&eacute;d&eacute;e - par deux lettres et deux points, tel que : 'fr:Titre en fran&ccedil;ais' ou 'ge:Titel - in deutsch'. D'autres attributs comme une description ou des mots cl&eacute;s sont - aussi suceptibles de recourir &agrave; ce genre de proc&eacute;d&eacute;. Vous pouvez aussi remplacer - l'abr&eacute;viation de langage par une autre cha&icirc;ne, tant qu'elle est s&eacute;par&eacute;e de la - valeur par les deux points. - </para> - <para> - Chaque enregistrement a une repr&eacute;sentation native qui contient toutes les paires - cl&eacute;/valeur, s&eacute;par&eacute;es par un retour &agrave; la ligne. L'extension Hyperwave reconna&icirc;t une - autre repr&eacute;sentation qui est un tableau associatif, o&uacute; les attributs servent de - cl&eacute;s. Les attributs multilingues &eacute;tant g&eacute;r&eacute; sous la forme d'un autre tableau - associatif, dont les cl&eacute;s sont les cha&icirc;nes de langue. En fait, tous les attributs - multiformes sont g&eacute;r&eacute;s sous la forme de tableau associatif. (Cela n'est pas encore - compl&egrave;tement cod&eacute;. Uniquement les attributs de titre, description et mot cl&eacute;s - sont trait&eacute;s correctement). - </para> - <para> - En dehors des documents, tous les hyper liens contenus dans un documents sont - enregistr&eacute;s dans un autre enregistrement. Les hyperliens qui sont &agrave; l'int&eacute;rieur - d'un document en seront supprim&eacute;s, et enregistr&eacute;s dans des objets particuliers, - au moment de l'insertion dans la base de donn&eacute;es. L'enregistrement des hyper-liens - contient les informations d'origine et d'objectif. Afin d'acc&eacute;der au document - original, vous devre lire le document sans les liens, puis lire les liens, et - les r&eacute;ins&eacute;rer (les <function>hw_pipedocument</function> et - <function>hw_gettext</function> le font pour vous. L'avantage de s&eacute;parer les - liens du document est &eacute;vident : une fois qu'un document, cible d'un hyperlien, a - &eacute;t&eacute; renomm&eacute;, le liens peut facilement &ecirc;tre modifi&eacute;. Le document contenant le lien - n'est pas modifi&eacute; pour autant. Vous pouvez m&ecirc;me ajouter un lien &agrave; 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&icirc;t. - L'insertion implique une certaine hi&eacute;rarchie de document. Sur un serveur web, - la hi&eacute;rarchie est fournie par le syst&egrave;me de fichiers, mais Hyperwave dispose de - sa propre hi&eacute;rarchie et les noms de fichiers ne refl&egrave;tent pas la position d'un - objet dans cette hi&eacute;rarchie. Ainsi, la cr&eacute;ation de liens requi&egrave;re en premier lieu - la construction de la hi&eacute;rarchie et de l'espace des noms dans une hi&eacute;rarchie web - et un espace de nom web. La diff&eacute;rence fondamentale entre Hyperwave et le web est - qu'il y a une distinction claire en les noms et la hi&eacute;rarchie dans Hyperwave. Le - nom ne contient aucune information &agrave; propos de la position de l'objet dans la - hi&eacute;rarchie. Sur le web, le nom contient les informations de localisation dans la - hi&eacute;rarchie. Cela conduit &agrave; deux m&eacute;thodes de d'acc&egrave;s : soit la hi&eacute;rarchie Hyperwave - et le nom de l'objet sont inscrit dans l'URL. Pour simplifier les choses, une - deuxi&egrave;me approche est pratiqu&eacute;e. L'objet Hyperwave de nom 'mon_objet' correspond &agrave; - l'URL 'http://hote/mon_objet', peu importe alors o&uacute; il est rang&eacute; dans la hi&eacute;rarchie. - Un objet dont le nom est 'parent/mon_objet' peut &ecirc;tre le fils de l'objet 'mon_objet' - dans la hi&eacute;rarchie Hyperwave, bien que ce soit le contraire en convention web, et - cela risque de perturber l'utilisateur. - </para> - <para> - Ayant pris cette d&eacute;cision, un deuxi&egrave;me probl&egrave;me surgit : comment faire l'interface - avec PHP ? L' URL http://hote/mon_objet n'appelera aucun script PHP &agrave; moins que - vous ne demandiez &agrave; 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&eacute;nient , qui peut facilement &ecirc;tre corrig&eacute;. R&eacute;&eacute;crire - un URL ne vous permettra aucun acc&egrave;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&egrave;gle pour exclure certaines URL, comme par exemple celles - qui commencent par http://host/Hyperwave. Voici de mani&egrave;re simple, la mani&egrave;re de - partager un espace de nom entre un serveur web et un serveur Hyperwave serveur. - </para> - <para> - Bas&eacute; sur le m&eacute;canisme pr&eacute;c&eacute;dent, on trouve l'insertion dans les documents. - </para> - <para> - Il est plus compliqu&eacute; d'avoir PHP ne fonctionne pas comme un module de serveur, ou - un scrip CGI, mais comme une application ind&eacute;pendante. Dans ce cas, il est utile - d'inscrire la hi&eacute;rarchie et le nom de fichier Hyperwave dans le syst&egrave;me de - fichier. Mais comme cela risque d'entrer en conflit avec le s&eacute;parateur de dossier - ('/'), il faut le remplacer par un autre caract&egrave;re,. '_'. - </para> - <para> - Le protocole r&eacute;seau pour communiquer avec un serveur Hyperwave est appel&eacute; - <ulink url="http://www.hyperwave.de/7.17-hg-prot">HG-CSP</ulink> - (Hyper-G Client/Server Protocol). Il est bas&eacute; sur des messages qui initie des - actions, comme par exemple, lire l'ent&ecirc;te de fichier. Dans les premi&egrave;res versions - de Hyperwave Server deux clients natifs (Harmony, Amadeus) &eacute;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&eacute; wavemaster est - d&eacute;sormais fourni. - wavemaster est un esp&egrave;ce ce convertisseur de protocole de - <abbrev>HTTP</abbrev> en <abbrev>HG-CSP</abbrev>. L'id&eacute;e est de faire toute - l'administration de la base et la visualisation des documents par une interface - web. Le wavemaster impl&eacute;mente un jeu d'emplacement pour certaines actions de - personnalisation de l'interface. Ce jeu est appel&eacute; <abbrev>PLACE</abbrev> - language. <abbrev>PLACE</abbrev> p&ecirc;che encore par le manque de nombreuse fonctions - de programmations, et le manque d'&eacute;volutivit&eacute;. Cela a conduit &agrave; 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&eacute;mente tous - les messages d&eacute;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 &eacute;t&eacute; largement &eacute;tendue. Presque toutes les fonctions utilisent - l'un des types de donn&eacute;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&eacute;es comme param&egrave;tre d'entr&eacute;e pour sp&eacute;cifier un objet. - </simpara></listitem> - <listitem><simpara> - object record: Une cha&icirc;ne contenant des paires cl&eacute;=valeur. Les paires sont - s&eacute;par&eacute;es par un retour &agrave; la ligne. Un enregistrement d'objet peut facilement - &ecirc;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&eacute; est l'attribut. Si un attribut appara&icirc;t plusieurs fois, il sera - repr&eacute;sent&eacute; sous la forme d'un tableau associatif ou index&eacute;. Les attributs qui - d&eacute;pendent des langues (comme title, keyword ou description) seront repr&eacute;sent&eacute;s sous la - forme d'un tableau associatif, dont les cl&eacute;s seront les abr&eacute;viations de langues. - Tous les autres attributs &agrave; valeur multiple prendront la forme d'un tableau - index&eacute;. - </simpara></listitem> - <listitem><simpara> - hw_document: Ce type est un nouveau type de donn&eacute;es, qui contient le document - lui m&ecirc;me, comme par exemple HTML, PDF etc. Il est optimis&eacute; 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&eacute;, avec des informatiosn statistiques. Ce tableau est le dernier - &eacute;l&eacute;ment du tableau d'enregistrements. Les statistiques contiennent les entr&eacute;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 &agrave; 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&eacute;gration avec Apache</title> - <para> - L'extension Hyperwave est utilis&eacute;e de mani&egrave;re optimale lorsqu PHP est compil&eacute; - comme module Apache. Dans ce cas, le serveur Hyperwave sous jacent peut &ecirc;tre - cach&eacute; quasiment totalement aux utilisateurs, si Apache utilise son moteur d'&eacute;criture. - Les explications suivantes vous &eacute;claireront : - </para> - <para> - Etant donn&eacute; que PHP avec l'extension Hyperwave et Apache tend &agrave; remplacer - la solution native bas&eacute; sur Wavemaster, je vais supposer que le serveur Apache - servira seulement d'interface Hyperwave. Ce n'est pas n&eacute;cessaire, mais cela - simplifie grandment la configuration. Le concept est tr&egrave;s simple. Premi&egrave;rement, - vous avez besoin d'un script PHP qui &eacute;value la variable <envar>PATH_INFO</envar> et - consid&egrave;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&eacute;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&eacute;lioration peut &ecirc;tre obtenue en utilisant le moteur - de r&eacute;&eacute;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&egrave;gle de r&eacute;&eacute;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 &agrave; un - probl&egrave;me simple. Il n'y a pas d'autre fa&ccedil;on d'ex&eacute;cuter, c'est &agrave; dire rechercher, - un autre script que ce script 'Hyperwave'. Cela pourra &ecirc;tre corrig&eacute; avec une autre - r&egrave;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&eacute; pour d'autres scripts et fichiers. Assurez vous que cette - r&egrave;gle est &eacute;valu&eacute;e avant la premi&egrave;re r&egrave;gle que nous avons d&eacute;finie. Il y a juste - un l&eacute;ger inconv&eacute;nient : tous les objets Hyperwave qui commencent par 'hw/' seront - cach&eacute;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&egrave;gles. N'oubliez pas de lancer le moteur de r&eacute;&eacute;criture avec - - <informalexample><programlisting role="apache-conf"> -RewriteEngine on -</programlisting></informalexample> - - Mon exp&eacute;rience m'a montr&eacute; que vous aurez besoin des scripts suivants : - - <itemizedlist> - <listitem><simpara> - Retourne l'objet lui m&ecirc;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&eacute;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 &agrave; faire : - <itemizedlist> - <listitem><simpara>La fonction hw_InsertDocument doit &ecirc;tre s&eacute;par&eacute;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&eacute;s. - </simpara></listitem> - <listitem><simpara> - La plupart des fonctions requi&egrave;rent la connexion courante - comme premier param&egrave;tre. Cela conduit &agrave; beaucoup de frappe clavier, - m&ecirc;me si il n'y a souvent qu'une seule connexion en jeu. Une connexion par - d&eacute;faut am&eacute;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&eacute;rentes langues seront trait&eacute;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 &agrave; 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&egrave;s, - ou false, si la connexion n'a pas pu &ecirc;tre cr&eacute;&eacute;e. Chaque argument doit &ecirc;tre entour&eacute; de -guillemets, sauf le num&eacute;ro de port. Les arguments <parameter>username</parameter> et - <parameter>password</parameter> sont optionnels, et peuvent &ecirc;tre ignor&eacute;s. Dans ce - cas, aucune identification ne sera faite au niveau du serveur. Cela revient &agrave; s'identifier en tant qu'utilisateur anonyme. Cette fonction retourne un identifiant de connexion qui sera n&eacute;cessaire aux autres fonctions Hyperwave. Vous pouvez avoir plusieurs connexions simultan&eacute;es. N'oubliez pas que les mots de passe ne sont pas crypt&eacute;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&eacute;e un groupe ayant l'object id <parameter>destination id</parameter>.</para> - <para> -La valeur retourn&eacute;e est le nombre d'objets copi&eacute;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&eacute;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 &agrave; <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 &ecirc;tre affich&eacute;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 &ecirc;tre affich&eacute;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&eacute;sente tout qui est plac&eacute; au dela de la balise BODY. Les informations de HEAD et de la balise BODY sont enregistr&eacute;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&eacute;e. Si la fonction &eacute;choue, l'ancien contenu est restaur&eacute;. -</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&icirc;ne contenant le dernier message d'erreur, ou 'No Error' (pas d'erreur). Si false est retourn&eacute;, cette fonction a &eacute;chou&eacute;. Ce message est relatif &agrave; la derni&egrave;re commande ex&eacute;cut&eacute;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 &ecirc;tre modifi&eacute;s tant que le document est en train d'&ecirc;tre &eacute;dit&eacute;. 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&egrave;re erreur. Si la valeur 0 est retourn&eacute;e, c'est qu'il n'y avait pas d'erreur. L'erreur se rapporte &agrave; la derni&egrave;re commande.</para> - </refsect1> - </refentry> - - <refentry id="function.hw-free-document"> - <refnamediv> - <refname>hw_Free_Document</refname> - <refpurpose>D&eacute;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&eacute;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&eacute; 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&eacute;, avec les attributs et un tableau associ&eacute;, d'informations statistiques &agrave; propos des attributs. Ce tableau associ&eacute; est le dernier &eacute;l&eacute;ment du tableau retourn&eacute;. Chaque -attribut appartient au p&egrave;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 &agrave; 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 &eacute;loign&eacute;s sont des pages web -externes, ou des requ&ecirc;tes sur une base de donn&eacute;es. Afin de pouvoir acc&eacute;der &agrave; des sources - externes, grâces aux documents distants, Hyperwave introduit l'interface HGI (Hyperwave - Gateway Interface) qui est similaire &agrave; CGI. Actuellement, seuls les protocoles de ftp, -http et certaines bases de donn&eacute;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&eacute;f&eacute;rable d'utiliser PHP plut&ocirc;t que Hyperwave pour acc&eacute;der aux sources externes. Le support des bases de donn&eacute;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&ecirc;mes. Cela est coh&eacute;rent si une requ&ecirc;te sur une base de donn&eacute;es -doit &ecirc;tre rendu plus s&eacute;lective, comme expliqu&eacute; dans Hyperwave Programmers' Guide. -Si le nombre de fils est 1 la fonction va retourner le document lui m&ecirc;me, la fonction -retournera le document lui m&ecirc;me, format&eacute; Hyperwave Gateway Interface (HGI). Si -le nombre de fils est sup&eacute;rieur 1 la fonction retournera un tableau d'attributs, -qui pourra servir &agrave; une nouvelle requ&ecirc;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 &ecirc;tre tr&egrave;s familier HGIs. Il vaut mieux PHP plut&ocirc;t que Hyperwave pour acc&eacute;der aux fichiers distants. Le support de base de donn&eacute;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 &ecirc;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&egrave;tre est un entier. Si le second param&egrave;tre est un tableau, la fonction retournera un tableau d'attributs. Dans ce cas, le dernier param&egrave;tre est aussi &eacute;valu&eacute;. -</para> - <para> - <parameter>query</parameter> a la syntaxe suivante :</para> - <simpara> - &lt;expression> ::= "(" &lt;expression> ")" |</simpara> <simpara> - "!" &lt;expression> | /* NOT */</simpara><simpara> - &lt;expression> "||" &lt;expression> | /* OR */</simpara><simpara> - &lt;expression> "&amp;&amp;" &lt;expression> | /* AND */</simpara><simpara> - &lt;attribute> &lt;operator> &lt;value></simpara><simpara> - - &lt;attribute> ::= /* * n'importe quel attribut (Title, Author, DocumentType ...) */</simpara><simpara> - - &lt;operator> ::= "=" | /* &eacute;gal */</simpara><simpara> - "&lt;" | /* moins que (comparaison de type cha&icirc;ne) */</simpara><simpara> - ">" | /* plus que (comparaison de type cha&icirc;ne) */</simpara><simpara> - "~" /* recherche par expression r&eacute;guli&egrave;re */</simpara><simpara></simpara> - <para> - <parameter>query</parameter> permet de s&eacute;lectionner une nouvelle fois certains objets dans la liste des objets donn&eacute;s. Contrairement aux autres requ&ecirc;tes, celle ci peut utiliser des attributs non index&eacute;s. Le nombre d'attributs retourn&eacute; d&eacute;pend de la requ&ecirc;te de la requ&ecirc;te, et des autorisations d'acc&egrave;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&ecirc;chera les autres utilisateurs d'y acc&eacute;der, jusqu'&agrave; ce qu'il soit deverrouill&eacute;. -</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&egrave;de -des ancrages qui peuvent &ecirc;tre ins&eacute;r&eacute;s, ils seront d&eacute;j&agrave; ins&eacute;r&eacute;s. -L'option rootID/prefix peut &ecirc;tre une cha&icirc;ne ou un entier. Si c'est un entier, il -d&eacute;termine la m&eacute;thode d'insertion des liens dans le document. Par d&eacute;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 &lt;A HREF="/internet_movie">. -La position r&eacute;elle de la source et de la cible dans la hi&eacute;rarchie seront ignor&eacute;s. Vous devrez modificer votre site web pour qu'il r&eacute;&eacute;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 &agrave; rootID/prefix n'importe quel prefixe. Dans ce cas, ce sera une cha&icirc;ne. -</para> - <para> -Si <parameter>rootID/prefix</parameter> est un entier diff&eacute;rent de 0 le lien sera -construit avec tous les noms de la hi&eacute;rarchie, en commencant &agrave; l'objet d'identifiant rootID/prefix, -et s&eacute;par&eacute; par des slash. Si, par exemple, le document 'film_internet' est situ&eacute; &agrave; -'a-b-c-internet_movie' et '-' qui sert de s&eacute;parateur hi&eacute;rarchique de niveau sur -le serveur Hyperwave et le document source est situ&eacute; dans 'a-b-d-source' alors, le lien HTML -serait: &lt;A HREF="../c/internet_movie">. Cela est tr&egrave;s pratique si vous voulez t&eacute;l&eacute;charger tout le contenu d'un serveur sur un disque, et faire une carte du syst&egrave;me sur votre disque. -</para> - <para> -Cette fonction n'est op&eacute;rationnelle qu'avec des document de pur texte. Elle n'ouvrira pas de canal sp&eacute;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&eacute; par <parameter>max_hits</parameter>. - Si <parameter>max_hits</parameter> vaut -1 il n'y a pas de limite.</para> - <para> - La requ&ecirc;te ne fonctionnera qu'avec des attributs index&eacute;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&eacute; par <parameter>max_hits</parameter>. Si <parameter>max_hits</parameter> -vaut -1 il n'y a pas de limite. -</para> - <para> - La requ&ecirc;te ne fonctionnera qu'avec des attributs index&eacute;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&eacute; par <parameter>objectID</parameter>. Si <parameter>objectID</parameter> - vaut -1 il n'y a pas de limite. -</para> - <para> -La requ&ecirc;te ne fonctionnera qu'avec des attributs index&eacute;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&eacute; par <parameter>objectID</parameter>. Si <parameter>objectID</parameter> - vaut -1 il n'y a pas de limite.</para> - <para> - La requ&ecirc;te ne fonctionnera qu'avec des attributs index&eacute;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&eacute;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&eacute;places les objets dont les identifiants sont pass&eacute;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&eacute;r&eacute;s dans le groupe (ni dans le serveur). Dans ce cas, si une instance &eacute;tait la derni&egrave;re instance d'un objet, l'objet sera effac&eacute;. Si vous voulez effacer toutes les instances d'un coup, utilisez <function>hw_deleteobject</function>. -</para> - <para> - La valeur retourn&eacute;e est le nombre d'objet d&eacute;plac&eacute;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&eacute;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&eacute;rifie qu'un ensemble d'objet (documents ou groupes) donn&eacute;s par <parameter>object_id_array</parameter> - fait partie des groupe list&eacute;s par <parameter>object_id_array</parameter>. -Lorsque le quatri&egrave;me param&egrave;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&eacute;curusivement) est retourn&eacute; sous la forme d'un tableau. Cette option permet de mettre en valeur la partie de l'arborescence qui contient le r&eacute;sultat d'une requ&ecirc;te, dans un sens graphique. -</para> - <para></para> - </refsect1> - </refentry> - - <refentry id="function.hw-info"> - <refnamediv> - <refname>hw_Info</refname> - <refpurpose>Informations &agrave; 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&icirc;ne retourn&eacute;e a le format suivant : &lt;Serverstring&gt;, &lt;Host&gt;, - &lt;Port&gt;, &lt;Username&gt;, &lt;Port of Client&gt;, - &lt;Byte swapping&gt;</para> - </refsect1> - </refentry> - - <refentry id="function.hw-inscoll"> - <refnamediv> - <refname>hw_InsColl</refname> - <refpurpose>Ins&egrave;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&egrave;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&egrave;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&egrave;re un nouveau document avec les attributs <parameter>object_record</parameter>, -dans le groupe <parameter>parentID</parameter>. Cette fonction ins&egrave;re soit un objet -avec ses seuls attributs, soit pur objet ascii, avec <parameter>text</parameter> si il est fourni. -Si vous voulez ins&eacute;rer un document de type g&eacute;n&eacute;ral, utilisez plut&ocirc;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&egrave;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&egrave;re un document dans le groupe <parameter>parent_id</parameter>. Le document doit -avoir &eacute;t&eacute; cr&eacute;&eacute; 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&eacute;r&eacute;, 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&egrave;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&egrave;re un objet dans le serveur. L'objet peut &ecirc;tre n'importe quel objet Hyperwave valide. Reportez vous &agrave; la documentation HG-CSP pour plus de d&eacute;tails sur les param&egrave;tres.</para> - <para> - Note: Si vous voulez ins&eacute;rer un ancre, l'attribut Position doit &ecirc;tre mis &agrave; la valeur start/end (d&eacute;but ou fin) ou encore 'invisible'. Les positions invisibles sont n&eacute;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&eacute;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&ecirc;me si -vous ne vous y &ecirc;tes pas connect&eacute; avec <function>hw_connect</function>, -avec un id d'objet local virtuel. Cet id d'objet local peut alors &ecirc;tre utilis&eacute; 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&egrave;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 &ecirc;tre fait qu'&agrave; la compilation. Par d&eacute;faut, il n'est pas lev&eacute;. -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&eacute; par son identifiant <parameter>object_to_change</parameter>. -Le premier tableau, <parameter>remove</parameter>, est la liste des attributs &agrave; effacer. Le deuxi&egrave;me tableau <parameter>add</parameter> est la -liste des attributs &agrave; ajouter. Afin de modifier un attribut, il vous faudra dont l'effacer, -puis l'ajouter &agrave; nouveau. <function>hw_modifyobject</function> effacera toujours les -attributs avant de les ajouter, &agrave; moins que la valeur de l'attribut &agrave; effacer ne -soit pas une cha&icirc;ne, ou un tableau.</para> - - <para> -Le dernier param&egrave;tre d&eacute;termine si la modification est r&eacute;cursive ou pas. - 1 signigie que la modification est r&eacute;cursive. Si un objet ne peut pas &ecirc;tre modifi&eacute;, -il sera ignor&eacute;. <function>hw_error</function> n'indiquera alors pas toujours d'erreur, -m&ecirc;me si certains objets n'ont pas pu &ecirc;tre modifi&eacute;. -</para> - - <para> -Les cl&eacute;s des deux tableaux sont les noms des attributs. La valeurs de chaque &eacute;l&eacute;ment peut &ecirc;tre un tableau, ou une cha&icirc;ne ou n'importe quoi d'autre. Dans le cas du tableau, la valeur de l'attribut est construite en s&eacute;parant chaque &eacute;l&eacute;ment par un point virgule. Dans le cas de la cha&icirc;ne, elle sert directement de valeur. Une cha&icirc;ne vide provoquera un effacement de l'attribut. Dans le cas o&uacute; la valeur n'est ni un tableau, ni une cha&icirc;ne, aucune op&eacute;ration ne sera effectu&eacute;e. Cela est n&eacute;cessaire si vous voulez ajouter un attribut compl&egrave;tement une nouvelle valeur pour un attribut existant. Si le tableau d'effacement contenait une cha&icirc;ne vide comme attribut, le serveur tenterait d'effacer l'attribut, ce qui &eacute;chouerai de toute mani&egrave;re, car cet attribut n'existe pas. L'ajout de cet attribut &eacute;chouerai aussi. Affecter la valeur de 0 &agrave; 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&egrave;me param&egrave;tre vide. Si l'attribut est le premier de ce nom &agrave; ajouter, donnez une valeur enti&egrave;re &agrave; cet &eacute;l&eacute;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 &ecirc;tre modifi&eacute;s de deux mani&egrave;res : soit en fournissant la valeur de ces attributs de mani&egrave;re native (langue :valeur), soit en fournissant un tableau avec les &eacute;l&eacute;ments de chaque langue, comme d&eacute;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&eacute;e fran&ccedil;aise 'Livres' et ajouter l'entr&eacute;e 'Articles' et l'entr&eacute;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 &ecirc;tre pratique pour effacer des attributs r&eacute;cursivement. - </simpara></note> - <note> - <simpara> -Si vous devez effacer tous les attributs avec un certains nom, vous devez passer une cha&icirc;ne vide comme valeur. -</simpara> - </note> - <note><simpara> -Seul les attributs 'Title', 'Description' et 'Keyword' g&egrave;re correctement le pr&eacute;fixe de langue. Pour les autres attributs qui ne portent pas de pr&eacute;fixe de language, le pr&eacute;fixe 'xx' sera assign&eacute;. - </simpara></note> - <note><simpara> -L'attribut 'Name' est un peu particuluer. Dans certains cas, il ne peut pas &ecirc;tre compl&eacute;tement effac&eacute;. Vous aurez alors le message 'Change of base attribute' (l'apparition de cette erreur n'est pas tr&egrave;s claire). Ainsi, vous aurez &agrave; ajouter une nouvelle entr&eacute;e pour Name puis, effacer l'ancien. - </simpara></note> - <note><simpara> -Il ne faut pas encadrer cette fonction par des appels &agrave; <function>hw_getandlock</function> et <function>hw_unlock</function>. - <function>hw_modifyobject</function> le fait de mani&egrave;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&eacute;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&eacute;es <parameter>document_data</parameter> et comme -attributs <parameter>object_record</parameter>. La longueur de <parameter>document_data</parameter> doit &ecirc;tre donn&eacute;es dans -<parameter>document_size</parameter>. Cette fonction n'ins&egrave;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&eacute;s du tableau seront les noms des attributs. Les attributs multiples comme par exemple 'Title', dans diff&eacute;rentes langues, seront rassembl&eacute;es dans un autre tableau. Une cl&eacute; est la partie gauche d'un attribut. Actuellement, seuls les attributs 'Title', 'Description' et 'Keyword' sont trait&eacute;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&eacute;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&egrave;s, et false si la connexion n'a pas pu -&ecirc;tre cr&eacute;&eacute;e. Ouvre une connexion persistante &agrave; un serveur Hyperwave. Tous les arguments -doivent &ecirc;tre entre guillemets, hormis le num&eacute;ro de port (port). Les arguments -<parameter>username</parameter> - et <parameter>password</parameter> sont optionnels, et peuvent &ecirc;tre ignor&eacute;s. Dans ce cas, aucune authentification ne sera faites, (connexion anonyme). Cette fonction retourne un index de connexion qui sera utilis&eacute;e par les autres fonctions Hyperwave. Vous pouvez ouvrir plusieurs connexions simultan&eacute;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&eacute;r&eacute;s. Le document sera transmis via -une connexion de donn&eacute;es sp&eacute;ciale, qui ne bloque pas la connexion de contr&ocirc;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&eacute;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&eacute;verrouille un document, et laisse l'acc&egrave;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&eacute;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&eacute;s au serveur Hyperwave. Chaque &eacute;l&eacute;ment du tableau est lui m&ecirc;me un tableau, qui contient l'identifiant de l'&eacute;l&eacute;ment, le nom, le syst&egrave;me, la date de connexion (onSinceDate), l'heure de connexion (onSinceTime), la dur&eacute;e de connexion (TotalTime ) et self. 'self' contient 1 l'&eacute;l&eacute;ment est l'utilisateur qui a appel&eacute; la fonction. -</para> - </refsect1> - </refentry> - - <refentry id="function.hw-getusername"> - <refnamediv> - <refname>hw_Username</refname> - <refpurpose>Nom de l'utilisateur actuellement identifi&eacute;.</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&eacute; 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 &eacute;t&eacute; developp&eacute; par + <ulink url="http://www.iicm.edu">IICM</ulink> &agrave; Graz. Son nom + original &eacute;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 &agrave; + <ulink url="http://www.hyperwave.com/">www.hyperwave.com</ulink>. Une version + limit&eacute;e &agrave; 30 jours peut &ecirc;tre demand&eacute;e. + </para> + <para> + <acronym>HIS</acronym> est un syst&egrave;me d'information similaire &agrave; + une base de donn&eacute;es, (HIS, Hyperwave Information Server). HIS se + concentre sur l'enregistrement et la gestion des documents. Un document peut + &ecirc;tre n'importe quelle donn&eacute;e, qui peut &ecirc;tre stock&eacute;e + dans un fichier. Chaque document est accompagn&eacute; par un enregistrement. + Cet enregistrement contient des m&eacute;ta donn&eacute;es &agrave; propos + du document. Ces m&eacute;ta donn&eacute;es sont des listes d'attributs qui + peuvent &ecirc;tre &eacute;tendues par l'utilisateur. Un attribut est une paire + cl&eacute;/valeur de la forme : cl&eacute; =valeur. L'enregistrement complet + contient autant de paire que le d&eacute;sire l'utilisateur. Le nom d'un + attribut n'a pas besoin d'&ecirc;tre unique, c'est &agrave; dire qu'une + m&ecirc;me cl&eacute; peut appara&icirc;tre plusieurs fois dans un + enregistrement. Cela peut &ecirc;tre utile si vous devez donner un + titre &agrave; votre document en plusieurs langues, par exemple. Dans un + cas pareil, la convention est que chaque valeur de titre est + pr&eacute;c&eacute;d&eacute;e par deux lettres et deux points, tel que : + 'fr:Titre en fran&ccedil;ais' ou 'ge:Titel in deutsch'. D'autres attributs + comme une description ou des mots cl&eacute;s sont aussi suceptibles de + recourir &agrave; ce genre de proc&eacute;d&eacute;. Vous pouvez aussi + remplacer l'abr&eacute;viation de langage par une autre cha&icirc;ne, + tant qu'elle est s&eacute;par&eacute;e de la valeur par les deux points. + </para> + <para> + Chaque enregistrement a une repr&eacute;sentation native qui contient toutes + les paires cl&eacute;/valeur, s&eacute;par&eacute;es par un retour &agrave; + la ligne. L'extension Hyperwave reconna&icirc;t une autre repr&eacute;sentation + qui est un tableau associatif, o&uacute; les attributs servent de cl&eacute;s. + Les attributs multilingues &eacute;tant g&eacute;r&eacute; sous la forme d'un + autre tableau associatif, dont les cl&eacute;s sont les cha&icirc;nes de + langue. En fait, tous les attributs multiformes sont g&eacute;r&eacute;s + sous la forme de tableau associatif. (Cela n'est pas encore compl&egrave;tement + cod&eacute;. Uniquement les attributs de titre, description et mot cl&eacute;s + sont trait&eacute;s correctement). + </para> + <para> + En dehors des documents, tous les hyper liens contenus dans un documents sont + enregistr&eacute;s dans un autre enregistrement. Les hyperliens qui sont + &agrave; l'int&eacute;rieur d'un document en seront supprim&eacute;s, et + enregistr&eacute;s dans des objets particuliers, au moment de l'insertion + dans la base de donn&eacute;es. L'enregistrement des hyper-liens + contient les informations d'origine et d'objectif. Afin d'acc&eacute;der + au document original, vous devre lire le document sans les liens, puis lire + les liens, et les r&eacute;ins&eacute;rer (les + <function>hw_pipedocument</function> et <function>hw_gettext</function> le + font pour vous. L'avantage de s&eacute;parer les liens du document est + &eacute;vident : une fois qu'un document, cible d'un hyperlien, a + &eacute;t&eacute; renomm&eacute;, le liens peut facilement &ecirc;tre + modifi&eacute;. Le document contenant le lien n'est pas modifi&eacute; + pour autant. Vous pouvez m&ecirc;me ajouter un lien &agrave; 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&icirc;t. + L'insertion implique une certaine hi&eacute;rarchie de document. Sur un serveur + web, la hi&eacute;rarchie est fournie par le syst&egrave;me de fichiers, mais + Hyperwave dispose de sa propre hi&eacute;rarchie et les noms de fichiers ne + refl&egrave;tent pas la position d'un objet dans cette hi&eacute;rarchie. + Ainsi, la cr&eacute;ation de liens requi&egrave;re en premier lieu + la construction de la hi&eacute;rarchie et de l'espace des noms dans + une hi&eacute;rarchie web et un espace de nom web. La diff&eacute;rence + fondamentale entre Hyperwave et le web est qu'il y a une distinction claire + en les noms et la hi&eacute;rarchie dans Hyperwave. Le nom ne contient aucune + information &agrave; propos de la position de l'objet dans la hi&eacute;rarchie. + Sur le web, le nom contient les informations de localisation dans la + hi&eacute;rarchie. Cela conduit &agrave; deux m&eacute;thodes de d'acc&egrave;s : + soit la hi&eacute;rarchie Hyperwave et le nom de l'objet sont inscrit dans + l'URL. Pour simplifier les choses, une deuxi&egrave;me approche est + pratiqu&eacute;e. L'objet Hyperwave de nom 'mon_objet' correspond &agrave; + l'URL 'http://hote/mon_objet', peu importe alors o&uacute; il est rang&eacute; + dans la hi&eacute;rarchie. Un objet dont le nom est 'parent/mon_objet' peut + &ecirc;tre le fils de l'objet 'mon_objet' dans la hi&eacute;rarchie Hyperwave, + bien que ce soit le contraire en convention web, et cela risque de perturber + l'utilisateur. + </para> + <para> + Ayant pris cette d&eacute;cision, un deuxi&egrave;me probl&egrave;me surgit : + comment faire l'interface avec PHP ? L' URL http://hote/mon_objet n'appelera + aucun script PHP &agrave; moins que vous ne demandiez &agrave; 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&eacute;nient , qui peut facilement &ecirc;tre + corrig&eacute;. R&eacute;&eacute;crire une URL ne vous permettra aucun + acc&egrave;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&egrave;gle pour exclure certaines URL, comme par exemple celles + qui commencent par http://host/Hyperwave. Voici de mani&egrave;re simple, + la mani&egrave;re de partager un espace de nom entre un serveur web et un + serveur Hyperwave serveur. + </para> + <para> + Bas&eacute; sur le m&eacute;canisme pr&eacute;c&eacute;dent, on trouve + l'insertion dans les documents. + </para> + <para> + Il est plus compliqu&eacute; d'avoir PHP ne fonctionne pas comme un module + de serveur, ou un scrip CGI, mais comme une application ind&eacute;pendante. + Dans ce cas, il est utile d'inscrire la hi&eacute;rarchie et le nom de fichier + Hyperwave dans le syst&egrave;me de fichier. Mais comme cela risque d'entrer + en conflit avec le s&eacute;parateur de dossier ('/'), il faut le remplacer + par un autre caract&egrave;re,. '_'. + </para> + <para> + Le protocole r&eacute;seau pour communiquer avec un serveur Hyperwave est + appel&eacute; <ulink url="http://www.hyperwave.de/7.17-hg-prot">HG-CSP</ulink> + (Hyper-G Client/Server Protocol). Il est bas&eacute; sur des messages qui + initie des actions, comme par exemple, lire l'ent&ecirc;te de fichier. Dans + les premi&egrave;res versions de Hyperwave Server deux clients natifs + (Harmony, Amadeus) &eacute;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&eacute; wavemaster est d&eacute;sormais + fourni. wavemaster est un esp&egrave;ce ce convertisseur de protocole de + <abbrev>HTTP</abbrev> en <abbrev>HG-CSP</abbrev>. L'id&eacute;e est de faire + toute l'administration de la base et la visualisation des documents par une + interface web. Le wavemaster impl&eacute;mente un jeu d'emplacement pour + certaines actions de personnalisation de l'interface. Ce jeu est appel&eacute; + <abbrev>PLACE</abbrev> language. <abbrev>PLACE</abbrev> p&ecirc;che encore par + le manque de nombreuse fonctions de programmations, et le manque + d'&eacute;volutivit&eacute;. Cela a conduit &agrave; 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&eacute;mente + tous les messages d&eacute;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 &eacute;t&eacute; largement &eacute;tendue. + Presque toutes les fonctions utilisent l'un des types de donn&eacute;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&eacute;es comme param&egrave;tre d'entr&eacute;e pour + sp&eacute;cifier un objet. + </simpara> + </listitem> + <listitem> + <simpara> + object record: Une cha&icirc;ne contenant des paires cl&eacute;=valeur. Les + paires sont s&eacute;par&eacute;es par un retour &agrave; la ligne. Un + enregistrement d'objet peut facilement &ecirc;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&eacute; est l'attribut. Si un attribut appara&icirc;t plusieurs fois, il + sera repr&eacute;sent&eacute; sous la forme d'un tableau associatif ou + index&eacute;. Les attributs qui d&eacute;pendent des langues (comme title, + keyword ou description) seront repr&eacute;sent&eacute;s sous la forme d'un + tableau associatif, dont les cl&eacute;s seront les abr&eacute;viations de + langues. Tous les autres attributs &agrave; valeur multiple prendront la + forme d'un tableau index&eacute;. + </simpara> + </listitem> + <listitem> + <simpara> + hw_document: Ce type est un nouveau type de donn&eacute;es, qui contient le + document lui m&ecirc;me, comme par exemple HTML, PDF etc. Il est + optimis&eacute; 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&eacute;, avec des informatiosn statistiques. Ce tableau + est le dernier &eacute;l&eacute;ment du tableau d'enregistrements. Les + statistiques contiennent les entr&eacute;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 &agrave; 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&eacute;gration avec Apache</title> + <para> + L'extension Hyperwave est utilis&eacute;e de mani&egrave;re optimale lorsque + PHP est compil&eacute; comme module Apache. Dans ce cas, le serveur Hyperwave + sous jacent peut &ecirc;tre cach&eacute; quasiment totalement aux utilisateurs, + si Apache utilise son moteur d'&eacute;criture. Les explications suivantes vous + &eacute;claireront : + </para> + <para> + Etant donn&eacute; que PHP avec l'extension Hyperwave et Apache tend &agrave; + remplacer la solution native bas&eacute; sur Wavemaster, je vais supposer que + le serveur Apache servira seulement d'interface Hyperwave. Ce n'est pas + n&eacute;cessaire, mais cela simplifie grandment la configuration. Le + concept est tr&egrave;s simple. Premi&egrave;rement, vous avez besoin d'un + script PHP qui &eacute;value la variable <envar>PATH_INFO</envar> et + consid&egrave;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&eacute;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&eacute;lioration peut + &ecirc;tre obtenue en utilisant le moteur de r&eacute;&eacute;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&egrave;gle de r&eacute;&eacute;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 &agrave; + un probl&egrave;me simple. Il n'y a pas d'autre fa&ccedil;on d'ex&eacute;cuter, + c'est &agrave; dire rechercher, un autre script que ce script 'Hyperwave'. + Cela pourra &ecirc;tre corrig&eacute; avec une autre r&egrave;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&eacute; pour d'autres scripts et fichiers. Assurez vous que + cette r&egrave;gle est &eacute;valu&eacute;e avant la premi&egrave;re + r&egrave;gle que nous avons d&eacute;finie. Il y a juste un l&eacute;ger + inconv&eacute;nient : tous les objets Hyperwave qui commencent par 'hw/' seront + cach&eacute;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&egrave;gles. N'oubliez pas de lancer le moteur de + r&eacute;&eacute;criture avec + <informalexample> + <programlisting role="apache-conf"> +RewriteEngine on + </programlisting> + </informalexample> + Mon exp&eacute;rience m'a montr&eacute; que vous aurez besoin + des scripts suivants : + <itemizedlist> + </simpara> + </listitem> + <listitem> + <simpara> + Retourne l'objet lui m&ecirc;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&eacute;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 &agrave; faire : + <itemizedlist> + <listitem> + <simpara> + La fonction hw_InsertDocument doit &ecirc;tre s&eacute;par&eacute;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&eacute;s. + </simpara> + </listitem> + <listitem> + <simpara> + La plupart des fonctions requi&egrave;rent la connexion courante + comme premier param&egrave;tre. Cela conduit &agrave; beaucoup de frappe + clavier, m&ecirc;me si il n'y a souvent qu'une seule connexion en jeu. + Une connexion par d&eacute;faut am&eacute;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&eacute;rentes langues seront trait&eacute;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 &agrave; 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&egrave;s, ou false, si la + connexion n'a pas pu &ecirc;tre cr&eacute;&eacute;e. Chaque argument + doit &ecirc;tre entour&eacute; de guillemets, sauf le num&eacute;ro de + port. Les arguments <parameter>username</parameter> et + <parameter>password</parameter> sont optionnels, et peuvent &ecirc;tre + ignor&eacute;s. Dans ce cas, aucune identification ne sera faite au niveau + du serveur. Cela revient &agrave; s'identifier en tant qu'utilisateur anonyme. + Cette fonction retourne un identifiant de connexion qui sera n&eacute;cessaire + aux autres fonctions Hyperwave. Vous pouvez avoir plusieurs connexions + simultan&eacute;es. N'oubliez pas que les mots de passe ne sont pas + crypt&eacute;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&eacute;e un groupe + ayant l'object id <parameter>destination_id</parameter>. + </para> + <para> + La valeur retourn&eacute;e est le nombre d'objets copi&eacute;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&eacute;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 &agrave; <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 + &ecirc;tre affich&eacute;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 + &ecirc;tre affich&eacute;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&eacute;sente tout qui est plac&eacute; au dela de la balise BODY. + Les informations de HEAD et de la balise BODY sont enregistr&eacute;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&eacute;e. Si la fonction &eacute;choue, + l'ancien contenu est restaur&eacute;. + </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&icirc;ne contenant + le dernier message d'erreur, ou 'No Error' (pas d'erreur). Si FALSE + est retourn&eacute;, cette fonction a &eacute;chou&eacute;. Ce message + est relatif &agrave; la derni&egrave;re commande ex&eacute;cut&eacute;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 &ecirc;tre + modifi&eacute;s tant que le document est en train d'&ecirc;tre + &eacute;dit&eacute;. 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&egrave;re + erreur. Si la valeur 0 est retourn&eacute;e, c'est qu'il n'y avait pas d'erreur. + L'erreur se rapporte &agrave; la derni&egrave;re commande. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-free-document"> + <refnamediv> + <refname>hw_Free_Document</refname> + <refpurpose>D&eacute;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&eacute;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&eacute; + 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&eacute;, + avec les attributs et un tableau associ&eacute;, d'informations statistiques + &agrave; propos des attributs. Ce tableau associ&eacute; est le dernier + &eacute;l&eacute;ment du tableau retourn&eacute;. Chaque attribut + appartient au p&egrave;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 &agrave; 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 &eacute;loign&eacute;s sont des pages web externes, ou + des requ&ecirc;tes sur une base de donn&eacute;es. Afin de pouvoir + acc&eacute;der &agrave; des sources externes, grâces aux documents distants, + Hyperwave introduit l'interface HGI (Hyperwave Gateway Interface) qui est + similaire &agrave; CGI. Actuellement, seuls les protocoles de ftp, http et + certaines bases de donn&eacute;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&eacute;f&eacute;rable d'utiliser + PHP plut&ocirc;t que Hyperwave pour acc&eacute;der aux sources externes. + Le support des bases de donn&eacute;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&ecirc;mes. Cela est coh&eacute;rent si une requ&ecirc;te sur une base + de donn&eacute;es doit &ecirc;tre rendu plus s&eacute;lective, comme + expliqu&eacute; dans Hyperwave Programmers' Guide. Si le nombre de fils + est 1 la fonction va retourner le document lui m&ecirc;me, la fonction + retournera le document lui m&ecirc;me, format&eacute; Hyperwave Gateway + Interface (HGI). Si le nombre de fils est sup&eacute;rieur 1 la fonction + retournera un tableau d'attributs, qui pourra servir &agrave; une nouvelle + requ&ecirc;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 &ecirc;tre tr&egrave;s + familier HGIs. Il vaut mieux PHP plut&ocirc;t que Hyperwave pour acc&eacute;der + aux fichiers distants. Le support de base de donn&eacute;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 &ecirc;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&egrave;tre est un entier. Si le second param&egrave;tre est un + tableau, la fonction retournera un tableau d'attributs. Dans ce cas, + le dernier param&egrave;tre est aussi &eacute;valu&eacute;. + </para> + <para> + <parameter>query</parameter> a la syntaxe suivante : + </para> + <simpara> + &lt;expression> ::= "(" &lt;expression> ")" | + </simpara> + <simpara> + "!" &lt;expression> | /* NOT */ + </simpara> + <simpara> + &lt;expression> "||" &lt;expression> | /* OR */ + </simpara> + <simpara> + &lt;expression> "&amp;&amp;" &lt;expression> | /* AND */ + </simpara> + <simpara> + &lt;attribute> &lt;operator> &lt;value> + </simpara> + <simpara> + &lt;attribute> ::= /* * n'importe quel attribut (Title, Author, DocumentType ...) */ + </simpara> + <simpara> + &lt;operator> ::= "=" | /* &eacute;gal */ + </simpara> + <simpara> + "&lt;" | /* moins que (comparaison de type cha&icirc;ne) */ + </simpara> + <simpara> + ">" | /* plus que (comparaison de type cha&icirc;ne) */ + </simpara> + <simpara> + "~" /* recherche par expression r&eacute;guli&egrave;re */ + </simpara> + <simpara> + </simpara> + <para> + <parameter>query</parameter> permet de s&eacute;lectionner une nouvelle fois + certains objets dans la liste des objets donn&eacute;s. Contrairement aux + autres requ&ecirc;tes, celle ci peut utiliser des attributs non index&eacute;s. + Le nombre d'attributs retourn&eacute; d&eacute;pend de la requ&ecirc;te de la + requ&ecirc;te, et des autorisations d'acc&egrave;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&ecirc;chera + les autres utilisateurs d'y acc&eacute;der, jusqu'&agrave; ce qu'il soit + deverrouill&eacute;. + </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&egrave;de des ancrages + qui peuvent &ecirc;tre ins&eacute;r&eacute;s, ils seront d&eacute;j&agrave; + ins&eacute;r&eacute;s. L'option rootID/prefix peut &ecirc;tre une + cha&icirc;ne ou un entier. Si c'est un entier, il d&eacute;termine la + m&eacute;thode d'insertion des liens dans le document. Par d&eacute;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 &lt;A HREF="/internet_movie">. + La position r&eacute;elle de la source et de la cible dans la hi&eacute;rarchie + seront ignor&eacute;s. Vous devrez modificer votre site web pour qu'il + r&eacute;&eacute;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 &agrave; + rootID/prefix n'importe quel prefixe. Dans ce cas, ce sera une cha&icirc;ne. + </para> + <para> + Si <parameter>rootID/prefix</parameter> est un entier diff&eacute;rent de 0 + le lien sera construit avec tous les noms de la hi&eacute;rarchie, en + commencant &agrave; l'objet d'identifiant rootID/prefix, et s&eacute;par&eacute; + par des slash. Si, par exemple, le document 'film_internet' est situ&eacute; + &agrave; 'a-b-c-internet_movie' et '-' qui sert de s&eacute;parateur + hi&eacute;rarchique de niveau sur le serveur Hyperwave et le document + source est situ&eacute; dans 'a-b-d-source' alors, le lien HTML serait: + &lt;A HREF="../c/internet_movie">. Cela est tr&egrave;s pratique si vous + voulez t&eacute;l&eacute;charger tout le contenu d'un serveur sur un disque, + et faire une carte du syst&egrave;me sur votre disque. + </para> + <para> + <function>hw_gettext</function> n'est op&eacute;rationnelle qu'avec des + documents de pur texte. Elle n'ouvrira pas de canal sp&eacute;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&eacute; + par <parameter>max_hits</parameter>. Si <parameter>max_hits</parameter> vaut -1 + il n'y a pas de limite. + </para> + <para> + La requ&ecirc;te ne fonctionnera qu'avec des attributs index&eacute;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&eacute; par <parameter>max_hits</parameter>. Si + <parameter>max_hits</parameter> vaut -1 il n'y a pas de limite. + </para> + <para> + La requ&ecirc;te ne fonctionnera qu'avec des attributs index&eacute;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&eacute; par <parameter>objectID</parameter>. Si + <parameter>objectID</parameter> vaut -1 il n'y a pas de limite. + </para> + <para> + La requ&ecirc;te ne fonctionnera qu'avec des attributs index&eacute;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&eacute; par <parameter>objectID</parameter>. Si + <parameter>objectID</parameter> vaut -1 il n'y a pas de limite. + </para> + <para> + La requ&ecirc;te ne fonctionnera qu'avec des attributs index&eacute;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&eacute;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&eacute;places les objets dont les identifiants + sont pass&eacute;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&eacute;r&eacute;s dans le groupe (ni dans le serveur). + Dans ce cas, si une instance &eacute;tait la derni&egrave;re instance d'un + objet, l'objet sera effac&eacute;. Si vous voulez effacer toutes les instances + d'un coup, utilisez <function>hw_deleteobject</function>. + </para> + <para> + La valeur retourn&eacute;e est le nombre d'objet d&eacute;plac&eacute;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&eacute;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&eacute;rifie qu'un ensemble d'objets + (documents ou groupes) donn&eacute;s par <parameter>object_id_array</parameter> + fait partie des groupe list&eacute;s par <parameter>object_id_array</parameter>. + Lorsque le quatri&egrave;me param&egrave;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&eacute;curusivement) + est retourn&eacute; sous la forme d'un tableau. Cette option permet de mettre + en valeur la partie de l'arborescence qui contient le r&eacute;sultat d'une + requ&ecirc;te, dans un sens graphique. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-info"> + <refnamediv> + <refname>hw_Info</refname> + <refpurpose>Informations &agrave; 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&icirc;ne retourn&eacute;e a le format suivant : + &lt;Serverstring&gt;, &lt;Host&gt;, &lt;Port&gt;, &lt;Username&gt;, + &lt;Port of Client&gt;, &lt;Byte swapping&gt; + </para> + </refsect1> + </refentry> + <refentry id="function.hw-inscoll"> + <refnamediv> + <refname>hw_InsColl</refname> + <refpurpose>Ins&egrave;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&egrave;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&egrave;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&egrave;re un nouveau document avec + les attributs <parameter>object_record</parameter>, dans le groupe + <parameter>parentID</parameter>. Cette fonction ins&egrave;re soit un objet + avec ses seuls attributs, soit pur objet ascii, avec + <parameter>text</parameter> si il est fourni. Si vous voulez ins&eacute;rer + un document de type g&eacute;n&eacute;ral, utilisez plut&ocirc;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&egrave;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&egrave;re un document dans le + groupe <parameter>parent_id</parameter>. Le document doit avoir + &eacute;t&eacute; cr&eacute;&eacute; 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&eacute;r&eacute;, + 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&egrave;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&egrave;re un objet dans + le serveur. L'objet peut &ecirc;tre n'importe quel objet Hyperwave + valide. Reportez vous &agrave; la documentation HG-CSP pour plus + de d&eacute;tails sur les param&egrave;tres. + </para> + <para> + Note: Si vous voulez ins&eacute;rer un ancre, l'attribut Position + doit &ecirc;tre mis &agrave; la valeur start/end (d&eacute;but ou + fin) ou encore 'invisible'. Les positions invisibles sont n&eacute;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&eacute;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&eacute;sente l'id d'un objet global de n'importe + quel serveur Hyperwave, m&ecirc;me si vous ne vous y &ecirc;tes pas + connect&eacute; avec <function>hw_connect</function>, avec un id d'objet + local virtuel. Cet id d'objet local peut alors &ecirc;tre utilis&eacute; + 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&egrave;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 &ecirc;tre fait qu'&agrave; la compilation. Par d&eacute;faut, + il n'est pas lev&eacute;. 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&eacute; par son + identifiant <parameter>object_to_change</parameter>. Le premier tableau, + <parameter>remove</parameter>, est la liste des attributs &agrave; effacer. + Le deuxi&egrave;me tableau <parameter>add</parameter> est la liste des + attributs &agrave; ajouter. Afin de modifier un attribut, il vous faudra + dont l'effacer, puis l'ajouter &agrave; nouveau. + <function>hw_modifyobject</function> effacera toujours les attributs avant + de les ajouter, &agrave; moins que la valeur de l'attribut &agrave; effacer + ne soit pas une cha&icirc;ne, ou un tableau. + </para> + <para> + Le dernier param&egrave;tre d&eacute;termine si la modification est + r&eacute;cursive ou pas. 1 signigie que la modification est r&eacute;cursive. + Si un objet ne peut pas &ecirc;tre modifi&eacute;, il sera ignor&eacute;. + <function>hw_error</function> n'indiquera alors pas toujours d'erreur, + m&ecirc;me si certains objets n'ont pas pu &ecirc;tre modifi&eacute;. + </para> + <para> + Les cl&eacute;s des deux tableaux sont les noms des attributs. La valeurs + de chaque &eacute;l&eacute;ment peut &ecirc;tre un tableau, ou une cha&icirc;ne + ou n'importe quoi d'autre. Dans le cas du tableau, la valeur de l'attribut + est construite en s&eacute;parant chaque &eacute;l&eacute;ment par un + point virgule. Dans le cas de la cha&icirc;ne, elle sert directement de + valeur. Une cha&icirc;ne vide provoquera un effacement de l'attribut. + Dans le cas o&uacute; la valeur n'est ni un tableau, ni une cha&icirc;ne, + aucune op&eacute;ration ne sera effectu&eacute;e. Cela est n&eacute;cessaire + si vous voulez ajouter un attribut compl&egrave;tement une nouvelle valeur pour + un attribut existant. Si le tableau d'effacement contenait une cha&icirc;ne + vide comme attribut, le serveur tenterait d'effacer l'attribut, ce qui + &eacute;chouerai de toute mani&egrave;re, car cet attribut n'existe pas. + L'ajout de cet attribut &eacute;chouerai aussi. Affecter la valeur de 0 + &agrave; 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&egrave;me param&egrave;tre vide. Si l'attribut est + le premier de ce nom &agrave; ajouter, donnez une valeur enti&egrave;re + &agrave; cet &eacute;l&eacute;ment. + <example> + <title>Ajouter un nouvel attribut</title> + <programlisting role="php"> + // $connect st une connexion Hyperwave valide + // $objid est l'identifiant de l'objet &agrave; 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 &ecirc;tre + modifi&eacute;s de deux mani&egrave;res : soit en fournissant la + valeur de ces attributs de mani&egrave;re native (langue :valeur), + soit en fournissant un tableau avec les &eacute;l&eacute;ments de + chaque langue, comme d&eacute;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&eacute;e fran&ccedil;aise 'Livres' et ajouter + l'entr&eacute;e 'Articles' et l'entr&eacute;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 &ecirc;tre pratique pour effacer des + attributs r&eacute;cursivement. + </simpara> + </note> + <note> + <simpara> + Si vous devez effacer tous les attributs avec un certains nom, vous devez + passer une cha&icirc;ne vide comme valeur. + </simpara> + </note> + <note> + <simpara> + Seuls les attributs 'Title', 'Description' et 'Keyword' g&egrave;re + correctement le pr&eacute;fixe de langue. Pour les autres attributs qui + ne portent pas de pr&eacute;fixe de language, le pr&eacute;fixe 'xx' sera + assign&eacute;. + </simpara> + </note> + <note> + <simpara> + L'attribut 'Name' est un peu particuluer. Dans certains cas, il ne peut pas + &ecirc;tre compl&eacute;tement effac&eacute;. Vous aurez alors le message + 'Change of base attribute' (l'apparition de cette erreur n'est pas tr&egrave;s + claire). Ainsi, vous aurez &agrave; ajouter une nouvelle entr&eacute;e pour + Name puis, effacer l'ancien. + </simpara> + </note> + <note> + <simpara> + Il ne faut pas encadrer cette fonction par des appels &agrave; + <function>hw_getandlock</function> et <function>hw_unlock</function>. + <function>hw_modifyobject</function> le fait de mani&egrave;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&eacute;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&eacute;es <parameter>document_data</parameter> et comme + attributs <parameter>object_record</parameter>. La longueur de + <parameter>document_data</parameter> doit &ecirc;tre donn&eacute;es dans + <parameter>document_size</parameter>. Cette fonction n'ins&egrave;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&eacute;s du tableau seront les noms des attributs. Les attributs + multiples comme par exemple 'Title', dans diff&eacute;rentes langues, + seront rassembl&eacute;es dans un autre tableau. Une cl&eacute; est la + partie gauche d'un attribut. Actuellement, seuls les attributs 'Title', + 'Description' et 'Keyword' sont trait&eacute;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&eacute;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&egrave;s, et FALSE si la connexion n'a pas pu &ecirc;tre cr&eacute;&eacute;e. + Ouvre une connexion persistante &agrave; un serveur Hyperwave. Tous les + arguments doivent &ecirc;tre entre guillemets, hormis le num&eacute;ro + de port (port). Les arguments <parameter>username</parameter> et + <parameter>password</parameter> sont optionnels, et peuvent &ecirc;tre + ignor&eacute;s. Dans ce cas, aucune authentification ne sera faites, + (connexion anonyme). Cette fonction retourne un index de connexion qui + sera utilis&eacute;e par les autres fonctions Hyperwave. Vous pouvez + ouvrir plusieurs connexions simultan&eacute;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&eacute;r&eacute;s. Le document sera transmis via une connexion de + donn&eacute;es sp&eacute;ciale, qui ne bloque pas la connexion de + contr&ocirc;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&eacute;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&eacute;verrouille un document, et laisse + l'acc&egrave;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&eacute;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&eacute;s au serveur Hyperwave. Chaque + &eacute;l&eacute;ment du tableau est lui m&ecirc;me un tableau, qui contient + l'identifiant de l'&eacute;l&eacute;ment, le nom, le syst&egrave;me, la date + de connexion (onSinceDate), l'heure de connexion (onSinceTime), la + dur&eacute;e de connexion (TotalTime ) et self. 'self' contient + l'&eacute;l&eacute;ment est l'utilisateur qui a appel&eacute; la fonction. + </para> + </refsect1> + </refentry> + <refentry id="function.hw-getusername"> + <refnamediv> + <refname>hw_Username</refname> + <refpurpose>Nom de l'utilisateur actuellement identifi&eacute;.</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&eacute; 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: +-->
« previous php.doc (#969333125) next »