php-doc-en/reference/hwapi/reference.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.8 $ -->
 <reference id="ref.hwapi">
  <title>Hyperwave API</title>
  <titleabbrev>Hyperwave API</titleabbrev>

  <partintro>

   <section id="hwapi.intro">
    &reftitle.intro;
    <para>
     <productname>Hyperwave</productname> a &eacute;t&eacute; d&eacute;velopp&eacute; &agrave; 
     l'<ulink url="&url.iicm;">IICM</ulink> &agrave; Graz. Le projet a commenc&eacute;
     avec le nom de <acronym>Hyper-G</acronym>, puis il est devenu
     Hyperwave, lors de sa commercialisation en 1996.
    </para>
    <para>
     Hyperwave n'est pas un logiciel libre. Sa version courante, la 5.5,
     est disponible &agrave; <ulink url="&url.hyperwave;">&url.hyperwave;</ulink>.  
     Une version limit&eacute;e dans le temps est commandable gratuitement (30 jours).
    </para>
    <para>
     Voir aussi le module <link linkend="ref.hyperwave">Hyperwave</link>.
    </para>
    <para>
     Hyperwave est un syst&egrave;me d'information comparable &agrave; une base de donn&eacute;es
     (<acronym>HIS</acronym>, Hyperwave Information Server). Il se
     concentre sur le stockage et la gestion de documents. Un document
     peut &ecirc;tre n'importe quelle pi&egrave;ce de donn&eacute;es qui soit stockable dans
     un fichier. Chaque document est accompagn&eacute; de son propre enregistrement.
     L'enregistrement contient les m&eacute;ta-donn&eacute;es du document. Les m&eacute;tas donn&eacute;es
     sont des listes d'attributs qui peuvent &ecirc;tre manipul&eacute;s par l'utilisateur.
     Certains attributs sont g&eacute;r&eacute;s par le serveur Hyperwave, les autres
     peuvent &ecirc;tre modifi&eacute;s par l'utilisateur.
    </para>
   </section>

   <section id="hwapi.requirements">
    &reftitle.required;
    <para>
     Depuis 2001, il y a un SDK Hyperwave disponible. Il supporte Java,
     JavaScript et C++. Cette extension PHP est bas&eacute;e sur l'interface C++.
     Pour activer le support hwapi de PHP, vous devez installer le
     SDK d'abord.
    </para>
   </section>

&reference.hwapi.configure;

   <section id="hwapi.apache">
    <title>int&eacute;gration dans Apache</title>
    <para>
     L'int&eacute;gration dans Apache et &eacute;ventuellement d'autres serveurs est
     d&eacute;j&agrave; d&eacute;crite dans le <link linkend="ref.hyperwave">module Hyperwave</link>,
     qui a &eacute;t&eacute; la premi&egrave;re extension &agrave; se connecter au serveur Hyperwave.
    </para>
   </section>

   &reference.hwapi.ini;

   <section id="hwapi.resources">
    &reftitle.resources;
    &no.resource;
   </section>

   <section id="hwapi.constants">
    &reftitle.constants;
    &no.constants;
   </section>

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

&reference.hwapi.functions;

 </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
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->