cvs: phpdoc-fr /reference/yaz configure.xml ini.xml reference.xml /reference/yaz/functions yaz-addinfo.xml yaz-ccl-conf.xml yaz-ccl-parse.xml
yaz-close.xml yaz-connect.xml yaz-database.xml yaz-element.xml yaz-errno.xml yaz-error.xml yaz-get-option.xml yaz-hits.xml yaz-itemorder.xml
yaz-present.xml yaz-range.xml yaz-record.xml yaz-scan-result.xml yaz-scan.xml yaz-schema.xml yaz-search.xml yaz-set-option.xml yaz-sort.xml
yaz-syntax.xml yaz-wait.xml
| From: | Damien Seguy | Date: | Thu, 08 May 2003 19:59:52 +0000 |
| Subject: | cvs: phpdoc-fr /reference/yaz configure.xml ini.xml reference.xml /reference/yaz/functions yaz-addinfo.xml yaz-ccl-conf.xml yaz-ccl-parse.xml yaz-close.xml yaz-connect.xml yaz-database.xml yaz-element.xml yaz-errno.xml yaz-error.xml yaz-get-option.xml yaz-hits.xml yaz-itemorder.xml yaz-present.xml yaz-range.xml yaz-record.xml yaz-scan-result.xml yaz-scan.xml yaz-schema.xml yaz-search.xml yaz-set-option.xml yaz-sort.xml yaz-syntax.xml yaz-wait.xml |
||
| Groups: | php.doc.fr | ||
| Request: | Send a blank email to doc-fr+get-355@lists.php.net to get a copy of this message | ||
dams Thu May 8 15:59:52 2003 EDT
Added files:
/phpdoc-fr/reference/yaz configure.xml ini.xml
/phpdoc-fr/reference/yaz/functions yaz-get-option.xml
yaz-schema.xml
yaz-set-option.xml yaz-sort.xml
Modified files:
/phpdoc-fr/reference/yaz reference.xml
/phpdoc-fr/reference/yaz/functions yaz-addinfo.xml yaz-ccl-conf.xml
yaz-ccl-parse.xml yaz-close.xml
yaz-connect.xml yaz-database.xml
yaz-element.xml yaz-errno.xml
yaz-error.xml yaz-hits.xml
yaz-itemorder.xml
yaz-present.xml yaz-range.xml
yaz-record.xml
yaz-scan-result.xml yaz-scan.xml
yaz-search.xml yaz-syntax.xml
yaz-wait.xml
Log:
spring commit
Index: phpdoc-fr/reference/yaz/reference.xml diff -u phpdoc-fr/reference/yaz/reference.xml:1.2 phpdoc-fr/reference/yaz/reference.xml:1.3 --- phpdoc-fr/reference/yaz/reference.xml:1.2 Mon Apr 15 20:55:33 2002 +++ phpdoc-fr/reference/yaz/reference.xml Thu May 8 15:59:52 2003 @@ -4,53 +4,45 @@ <titleabbrev>YAZ</titleabbrev> <partintro> <section id="yaz.intro"> - <title>Introduction</title> - <para> - Cette extension offre à PHP l'interface avec les produits - <productname>YAZ</productname>, qui implémentent le protocole - Z39.50. Avec cette extension, vous pouvez facilement implémenter - un client Z39.50 qui analyse ou scanne des serveurs Z39.50 en paralléle. - </para> - <para> - <productname>YAZ</productname> est disponible à <ulink - url="&url.yaz;">&url.yaz;</ulink>. Vous pouvez trouvez des informations, - des scripts d'exemples, etc... pour cette extension à <ulink - url="&url.yaz-phpyaz;">&url.yaz-phpyaz;</ulink>. - </para> - <para> - Le module masque l'essentiel de la complexité de Z39.50, ce qui le rend - très facile à utiliser. Il supporte les connexions peristantes de - manière similaire à celle supportés par les serveurs SQL : - cela signifie qu'une connexion est partagée entre plusieurs scripts PHP, - ce qui évite les opérations de connexions. - </para> + &reftitle.intro; + <para> + Cette extension offre à PHP l'interface avec les produits + <productname>YAZ</productname>, qui implémentent le + <ulink url="&url.yaz-loc;">protocole Z39.50</ulink>. + Avec cette extension, vous pouvez facilement implémenter + un client Z39.50 qui analyse ou scanne des serveurs Z39.50 en paralléle. + </para> + <para> + Le module masque l'essentiel de la complexité de Z39.50, ce qui le rend + très facile à utiliser. Il supporte les connexions peristantes de + manière similaire à celle supportés par les serveurs SQL : + cela signifie qu'une connexion est partagée entre plusieurs scripts PHP, + ce qui évite les opérations de connexions. + </para> + <para> + <productname>YAZ</productname> est disponible à <ulink + url="&url.yaz;">&url.yaz;</ulink>. Vous pouvez trouvez des informations, + des scripts d'exemples, etc... pour cette extension à <ulink + url="&url.yaz-phpyaz;">&url.yaz-phpyaz;</ulink>. + </para> </section> - <section id="yaz.install"> - <title>Installation</title> - <para> - Compilez YAZ et installez le. Compilez PHP avec vos modules et ajoutez l'option - <link linkend="install.configure.with-yaz"><option role="configure">--with-yaz</option></link>. - Les instructions sont : - </para> - <para> - <informalexample> - <programlisting> -gunzip -c yaz-1.6.tar.gz|tar xf - -gunzip -c php-4.0.X.tar.gz|tar xf - -cd yaz-1.6 -./configure --prefix=/usr -make -make install -cd ../php-4.0.X -./configure --with-yaz=/usr/bin -make -make install - </programlisting> - </informalexample> - </para> + + &reference.yaz.configure; + + &reference.yaz.ini; + + <section id="yaz.resources"> + &reftitle.resources; + &no.resource; </section> - <section id="yaz.example"> - <title>Exemple</title> + + <section id="yaz.constants"> + &reftitle.constants; + &no.constants; + </section> + + <section id="yaz.examples"> + &reftitle.examples; <para> PHP/YAZ conserve les connexions aux serveurs. Un entier positif représente l'ID d'une connexion particulière. @@ -62,34 +54,35 @@ <example> <title>Recherche paralléle utilisant YAZ</title> <programlisting role="php"> -<?php +<![CDATA[ +<?php $num_hosts = count ($host); if (empty($term) || count($host) == 0) { - echo '<form method="get"> - <input type="checkbox" - name="host[]" value="bagel.indexdata.dk/gils"> + echo '<form method="get"> + <input type="checkbox" + name="host[]" value="bagel.indexdata.dk/gils"> GILS test - <input type="checkbox" - name="host[]" value="localhost:9999/Default"> + <input type="checkbox" + name="host[]" value="localhost:9999/Default"> local test - <input type="checkbox" checked="1" - name="host[]" value="z3950.bell-labs.com/books"> + <input type="checkbox" checked="1" + name="host[]" value="z3950.bell-labs.com/books"> BELL Labs Library - <br> + <br> RPN Query: - <input type="text" size="30" name="term"> - <input type="submit" name="action" value="Search"> + <input type="text" size="30" name="term"> + <input type="submit" name="action" value="Search"> '; } else { - echo 'Vous avez recherché '.htmlspecialchars($term).'<br>'; - for ($i = 0; $i > $num_hosts; $i++) { + echo 'Vous avez recherché '.htmlspecialchars($term).'<br>'; + for ($i = 0; $i > $num_hosts; $i++) { $id[] = yaz_connect($host[$i]); yaz_syntax($id[$i],"sutrs"); yaz_search($id[$i],"rpn",$term); } yaz_wait(); - for ($i = 0; $i < $num_hosts; $i++) { - echo '<hr>'.$host[$i].":"; + for ($i = 0; $i < $num_hosts; $i++) { + echo '<hr>'.$host[$i].":"; $error = yaz_error($id[$i]); if (!empty($error)) { echo "Erreur: $error"; @@ -97,22 +90,23 @@ $hits = yaz_hits($id[$i]); echo "Nombre de résultats : $hits"; } - echo '<dl>'; - for ($p = 1; $p <= 10; $p++) { + echo '<dl>'; + for ($p = 1; $p <= 10; $p++) { $rec = yaz_record($id[$i],$p,"string"); if (empty($rec)) continue; - echo "<dt><B>$p</B></dt><dd>"; - echo ereg_replace("\n", "<br>\n",$rec); - echo "</dd>"; + echo "<dt><B>$p</B></dt><dd>"; + echo ereg_replace("\n", "<br>\n",$rec); + echo "</dd>"; } - echo '</dl>'; + echo '</dl>'; } } -?> - </programlisting> - </example> - </para> - </section> +?> +]]> + </programlisting> + </example> + </para> + </section> </partintro> &reference.yaz.functions; Index: phpdoc-fr/reference/yaz/functions/yaz-addinfo.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-addinfo.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-addinfo.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-addinfo.xml:1.1 Sun Apr 14 20:40:21 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-addinfo.xml Thu May 8 15:59:52 2003 @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_addinfo</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <type>string</type><methodname>yaz_addinfo</methodname> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_addinfo</function> retourne plus de détails après Index: phpdoc-fr/reference/yaz/functions/yaz-ccl-conf.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-ccl-conf.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-ccl-conf.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-ccl-conf.xml:1.2 Sun Apr 13 09:30:59 2003 +++ phpdoc-fr/reference/yaz/functions/yaz-ccl-conf.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_ccl_conf</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>array</type><parameter>config</parameter></methodparam> </methodsynopsis> <para> @@ -28,21 +28,23 @@ </para> <para> <example> - <title>Exemple de configuration CCL</title> - <simpara> - Dans l'exemple ci-dessous, l'analyseur CCL est configuré pour - supporter trois champs CCL : <literal>ti</literal>, <literal>au</literal> et - <literal>isbn</literal>. Chaque champs correspond à leur équivalent - équivalent BIB-1. On suppose que chaque variable <literal>$id</literal> est - un hôte de destination. - </simpara> - <programlisting role="php"> -<?php - $field["ti"] = "1=4"; - $field["au"] = "1=1"; - $field["isbn"] = "1=7"; - yaz_ccl_conf($id,$field); -?< + <title>Exemple de configuration CCL</title> + <simpara> + Dans l'exemple ci-dessous, l'analyseur CCL est configuré pour + supporter trois champs CCL : <literal>ti</literal>, <literal>au</literal> et + <literal>isbn</literal>. Chaque champs correspond à leur équivalent + équivalent BIB-1. On suppose que chaque variable <literal>$id</literal> est + un hôte de destination. + </simpara> + <programlisting role="php"> +<![CDATA[ +<?php + $field["ti"] = "1=4"; + $field["au"] = "1=1"; + $field["isbn"] = "1=7"; + yaz_ccl_conf($id,$field); +?> +]]> </programlisting> </example> </para> Index: phpdoc-fr/reference/yaz/functions/yaz-ccl-parse.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-ccl-parse.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-ccl-parse.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-ccl-parse.xml:1.2 Tue Aug 13 22:19:35 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-ccl-parse.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_ccl_parse</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam><type>array &</type><parameter>result</parameter></methodparam> </methodsynopsis> @@ -25,13 +25,33 @@ et l'index <literal>rpn</literal> du tableau <parameter>result</parameter> contient une requête RPN valide. Si la requête n'a pas pu être convertie, (pour n'importe quelle raison, comme syntaxe invalide, champs inconnu...), - <function>yaz_ccl_parse</function> retourne <literal>FALSE</literal>. + <function>yaz_ccl_parse</function> retourne &false;. Trois index sont alors créés dans le tableau de résultat : <literal>errorcode</literal> (code d'erreur CCL, un entier), <literal>errorstring</literal> (message d'erreur CCL), et <literal>errorpos</literal> position estimée de l'erreur dans la requête (entier, position en nombre de caractères). </para> + <example> + <title>Configuration CCL</title> + <para> + Dans l'exemple ci-dessous, l'analyseur CCL est configuré pour supporter + trois champs CCL : <literal>ti</literal>, <literal>au</literal> et + <literal>isbn</literal>. Chaque champs correspond à son équivalent + BIB-1. On suppose que la variable <literal>$id</literal> est la resource de + connexion. + <programlisting> +<![CDATA[ +<?php + $fields["ti"] = "1=4"; + $fields["au"] = "1=1"; + $fields["isbn"] = "1=7"; + yaz_ccl_conf($id,$fields); +?> +]]> + </programlisting> + </para> + </example> </refsect1> </refentry> Index: phpdoc-fr/reference/yaz/functions/yaz-close.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-close.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-close.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-close.xml:1.1 Sun Apr 14 20:40:22 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-close.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_close</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_close</function> ferme une connexion à un Index: phpdoc-fr/reference/yaz/functions/yaz-connect.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-connect.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-connect.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-connect.xml:1.2 Tue Aug 13 22:19:35 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-connect.xml Thu May 8 15:59:52 2003 @@ -11,10 +11,10 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_connect</methodname> + <type>resource</type><methodname>yaz_connect</methodname> <methodparam><type>string</type><parameter>zurl</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>authentication</parameter></methodparam> - </methodsynopsis> + <methodparam choice="opt"><type>mixed</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> <function>yaz_connect</function> retourne un identifiant positif en cas de succès, et &false;sinon. @@ -29,6 +29,63 @@ préparer la connexion pour exécution ultérieure par <function>yaz_wait</function>. </para> + <para> + Si le second argument <parameter>options</parameter> est fourni sous la + forme d'une chaîne, il est traité comme une chaîne d'authentification + Z39.50 V2 (OpenAuth). + </para> + <para> + Si <parameter>options</parameter> est fourni sous la forme d'un tableau, + le contenu du tableau servira d'options. Notez que ce tableau d'options est + supporté depuis &php; 4.1.0. + + <variablelist> + <title>Options <function>yaz_connect</function></title> + <varlistentry><term>user</term><listitem> + <simpara>Nom d'utilisateur pour l'authentification. + </simpara></listitem> + </varlistentry> + <varlistentry><term>group</term><listitem> + <simpara>Groupe d'authentification. + </simpara></listitem> + </varlistentry> + <varlistentry><term>password</term><listitem> + <simpara>Mot de passe d'authentification. + </simpara></listitem> + </varlistentry> + <varlistentry><term>cookie</term><listitem> + <simpara>Cookie de session (proxy YAZ). + </simpara></listitem> + </varlistentry> + <varlistentry><term>proxy</term><listitem> + <simpara>Proxy de connexion (proxy YAZ). + </simpara></listitem> + </varlistentry> + <varlistentry><term>persistent</term><listitem> + <simpara>Un &boolean;. Si il vaut &true; la connexion sera + persistante; Si il vaut &false;, la connexion ne sera pas persistant. + Par défaut, les connexions sont persistantes. + </simpara></listitem> + </varlistentry> + <varlistentry><term>piggyback</term><listitem> + <simpara>Un &boolean;. Si il vaut &true;, piggyback est activé pour + les recherches. Si il vaut &false;, piggyback est désactivé. + Par défaut, piggyback est activé. Activer piggyback est plus efficace, + et généralement, cela économise des aller-retours sur le réseau pour + les premières lectures de résultat. Mais peut de serveurs + Z39.50 supporte piggyback, ou bien ils ignorent ce jeu de noms. + Pour ceux la, il faut que piggyback soit désactivé. + </simpara></listitem> + </varlistentry> + </variablelist> + </para> + <note> + <para> + L'utilisation d'un proxy améliore souvent les performances. Un + proxy Z39.50 fait partie du package libre + <ulink url="&url.yaz-proxy;">YAZ++</ulink>. + </para> + </note> </refsect1> </refentry> Index: phpdoc-fr/reference/yaz/functions/yaz-database.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-database.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-database.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-database.xml:1.2 Tue Aug 13 22:19:35 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-database.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_database</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>databases</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc-fr/reference/yaz/functions/yaz-element.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-element.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-element.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-element.xml:1.2 Tue Aug 13 22:19:35 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-element.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_element</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>elementset</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc-fr/reference/yaz/functions/yaz-errno.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-errno.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-errno.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-errno.xml:1.1 Sun Apr 14 20:40:22 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-errno.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_errno</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_errno</function> retourne le numéro d'erreur de la Index: phpdoc-fr/reference/yaz/functions/yaz-error.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-error.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-error.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-error.xml:1.1 Sun Apr 14 20:40:22 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-error.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>string</type><methodname>yaz_error</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_error</function> retourne un message d'erreur pour la Index: phpdoc-fr/reference/yaz/functions/yaz-hits.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-hits.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-hits.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-hits.xml:1.1 Sun Apr 14 20:40:22 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-hits.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_hits</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_hits</function> retourne le nombre de résultat de Index: phpdoc-fr/reference/yaz/functions/yaz-itemorder.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-itemorder.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-itemorder.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-itemorder.xml:1.1 Sun Apr 14 20:40:22 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-itemorder.xml Thu May 8 15:59:52 2003 @@ -12,18 +12,18 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_itemorder</methodname> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>array</type><parameter>args</parameter></methodparam> </methodsynopsis> <para> - <function>yaz_itemorder</function> prépare une requête de type "Extended Services" - en utilisant le "Profile" avec "Use of Z39.50 Item Order Extended Service to - Transport ILL (Profile/1)" (Note du Traducteur : mailez moi de l'aide!). Reportez-vous - <ulink url="&url.yaz.ill;">ici</ulink> - ou aux - <ulink url="&url.yaz.specs;">spécification</ulink>. + <function>yaz_itemorder</function> prépare une requête + de type "Extended Services" en utilisant le "Profile" avec + "Use of Z39.50 Item Order Extended Service to Transport ILL (Profile/1)". + Reportez-vous <ulink url="&url.yaz.ill;">ici</ulink> ou aux + <ulink url="&url.yaz.specs;">spécifications</ulink>. Le paramètre <parameter>args</parameter> doit être un tableau associatif, contenant les informations "Item Order" à envoyer. L'index du tableau est - le nom ASN.1 correspondant au tag path. Par exemple, le numéro ISBN sous + le nom ASN.1 correspondant au "tag path". Par exemple, le numéro ISBN sous l'Item-ID est la clé item-id,ISBN. </para> <para> Index: phpdoc-fr/reference/yaz/functions/yaz-present.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-present.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-present.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-present.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-present.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_present</methodname> - <void/> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_present</function> prépare PHP à la lecture des Index: phpdoc-fr/reference/yaz/functions/yaz-range.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-range.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-range.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-range.xml:1.2 Tue Aug 13 22:19:35 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-range.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_range</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>int</type><parameter>start</parameter></methodparam> <methodparam><type>int</type><parameter>number</parameter></methodparam> </methodsynopsis> Index: phpdoc-fr/reference/yaz/functions/yaz-record.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-record.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-record.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-record.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-record.xml Thu May 8 15:59:52 2003 @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_record</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <type>string</type><methodname>yaz_record</methodname> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>int</type><parameter>pos</parameter></methodparam> <methodparam><type>string</type><parameter>type</parameter></methodparam> </methodsynopsis> Index: phpdoc-fr/reference/yaz/functions/yaz-scan-result.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-scan-result.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-scan-result.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-scan-result.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-scan-result.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>yaz_scan_result</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam choice="opt"><type>array &</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc-fr/reference/yaz/functions/yaz-scan.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-scan.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-scan.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-scan.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-scan.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_scan</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>type</parameter></methodparam> <methodparam><type>string</type><parameter>startterm</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>flags</parameter></methodparam> @@ -40,31 +40,35 @@ </para> <para> <example> - <title>Fonction PHP qui scanne les titres</title> + <title>Fonction PHP qui scanne les titres sur un serveur YAZ</title> <programlisting> - function scan_titles($id, $starterm) { - yaz_scan($id,"rpn", "@attr 1=4 " . $starterm); - yaz_wait(); - $errno = yaz_errno($id); - if ($errno == 0) { - $ar = yaz_scan_result($id,&$options); - echo 'Scan ok; '; - $ar = yaz_scan_result($id, &$options); - while(list($key,$val)=each($options)) { - echo "$key = $val "; - } - echo '<br><table><tr><td>'; - while(list($key,list($k, $term, $tcount))=each($ar)) { - if (empty($k)) continue; - echo "<tr><td>$term</td><td>"; - echo $tcount; - echo "</td></tr>"; - } - echo '</table>'; - } else { - echo "Echec du scan. Erreur: " . yaz_error($id) . "<br>"; - } - } +<![CDATA[ +<?php + function scan_titles($id, $starterm) { + yaz_scan($id,"rpn", "@attr 1=4 " . $starterm); + yaz_wait(); + $errno = yaz_errno($id); + if ($errno == 0) { + $ar = yaz_scan_result($id,&$options); + echo 'Scan réussi; '; + $ar = yaz_scan_result($id, &$options); + while(list($key,$val)=each($options)) { + echo "$key = $val "; + } + echo '<br><table><tr><td>'; + while(list($key,list($k, $term, $tcount))=each($ar)) { + if (empty($k)) continue; + echo "<tr><td>$term</td><td>"; + echo $tcount; + echo "</td></tr>"; + } + echo '</table>'; + } else { + echo "Echec du scan. Erreur: " . yaz_error($id) . "<br>"; + } + } +?> +]]> </programlisting> </example> </para> Index: phpdoc-fr/reference/yaz/functions/yaz-search.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-search.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-search.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-search.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-search.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_search</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>type</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> </methodsynopsis> @@ -81,36 +81,55 @@ </tbody> </tgroup> </table> + <example> + <title>Exemples de requêtes</title> <para> - Les requêtes suivantes illustrent des requêtes valides : - <informalexample> - <screen>ordinateur</screen> - </informalexample> - Recherche les documents qui contiennent le mot "ordinateur". Aucun attribut - n'est spécifié. - </para> - <para> - <informalexample> - <screen>"serveur rapide"</screen> - </informalexample> - Recherche les documents qui contiennent les mots "serveur rapide" - </para> - <para> - <informalexample> - <screen>@attr 1=4 php</screen> - </informalexample> - L'attribut est de type 1 (Bib-1 use), sa valeur est 4 (Title, titre) : - cette requête recherche les documents où le mot "php" - est dans le titre. - </para> - <para> - <informalexample> - <screen>@attrset gils @and @attr 1=4 php @attr 1=1003 "Rasmus Lerdorf"</screen> - </informalexample> - Cette requête utilise tout le jeu d'attributs GILS. Elle recherche - les documents dont le titre contient "php", et qui contiennent le - nom "Rasmus Lerdorf" comme auteur. - </para> + Vous pouvez rechercher des termes simples comme + <screen>ordinateur</screen> + qui identifieront les documents où "ordinateur" apparait. + Aucun attribut n'est spécifié. + </para> + <para> + La requête <screen>"knuth donald"</screen> + recherche les documents où "knuth donald" apparait (en + supposant que le serveur supporte la recherche par phrase). + </para> + <para> + Cette requête applique deux attributs à la phrase recherchée : + <screen>@attr 1=1003 @attr 4=1 "knuth donald"</screen> + Le premier attribut est de type 1 (Bib-1), et sa valeur est 1003 + (Auteur). + Le second attribut est de type 4 (structure), valeur 1 (phrase), + ce qui fait que la requête recherche les documents dont + Donald Knuth est l'auteur. + </para> + <para> + Cette requête + <screen>@and @or a b @not @or c d e</screen> + sera traduite en notation infix comme ceci : + <literal>(a or b) and ((c or d) not e)</literal>. + </para> + <para> + Un autre exemple plus complexe : +<screen>@attrset gils @and @attr 1=4 art @attr 1=2000 company</screen> + La requête utilise l'ensemble de sous attributs GILS. La requête + recherche les documents où le mot <literal>art</literal> apparait dans le + titre (GILS,BIB-1) et dont la société (<literal>company</literal>) apparait + comme distributeur (GILS). + </para> + </example> + <para> + Vous pouvez trouvers plus d'informations sur les requêtes et attributs + sur le site de + <ulink url="&url.yaz-loc-bib1;">Z39.50 Maintenance Agency</ulink>. + </para> + <note> + <para> + Si vous préférez une notation plus conviviale, utilisez l'analyseur + CCL : <function>yaz_ccl_conf</function> et <function>yaz_ccl_parse</function>. + </para> + </note> + </refsect1> </refentry> Index: phpdoc-fr/reference/yaz/functions/yaz-syntax.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-syntax.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-syntax.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-syntax.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-syntax.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_syntax</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>syntax</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc-fr/reference/yaz/functions/yaz-wait.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-wait.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-wait.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-wait.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-wait.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_wait</methodname> - <void/> + <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> <function>yaz_wait</function> exécute les requêtes @@ -20,6 +20,20 @@ <function>yaz_wait</function> se termine lorsque tous les hôtes ont terminé leurs requêtes (éventuellement en cas d'erreur). </para> + <para> + Si le paramètre <parameter>options</parameter> est fourni, il doit + contenir les options suivantes, + pour modifier le comportement de <function>yaz_wait</function>. + </para> + <variablelist> + <varlistentry><term><literal>timeout</literal></term><listitem> + <para>Configure le délais maximal d'attente, en secondes. Si le serveur + n'a pas répondu dans ce délai, la connexion est considérée comme + morte et <function>yaz_wait</function> se termine. Par défaut, + ce délai est de 15 secondes. + </para></listitem> + </varlistentry> + </variablelist> </refsect1> </refentry> Index: phpdoc-fr/reference/yaz/configure.xml +++ phpdoc-fr/reference/yaz/configure.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="yaz.installation"> &reftitle.install; <para> Compilez YAZ (ANSI/NISO Z39.50 support) et installez-le. Compilez &php; avec vos modules et ajoutez l'option <option role="configure">--with-yaz[=DIR]</option>. Les instructions sont : </para> <para> <example> <title>Installation de YAZ</title> <programlisting role="shell"> <![CDATA[ gunzip -c php-4.3.X.tar.gz|tar xf - gunzip -c yaz-1.9.Y.tar.gz|tar xf - cd yaz-1.9.Y /configure --prefix=/usr make make install cd ../php-4.3.X. /configure --with-yaz=/usr/bin make make install ]]> </programlisting> </example> </para> &warn.imaprecodeyaz; </section> <!-- 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 --> Index: phpdoc-fr/reference/yaz/ini.xml +++ phpdoc-fr/reference/yaz/ini.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="yaz.configuration"> &reftitle.runtime; &extension.runtime; <para> <table> &ini.table.title; <tgroup cols="3"> <thead> &ini.table.top; </thead> <tbody> <row> <entry>yaz.max_links</entry> <entry>"100"</entry> <entry>PHP_INI_ALL</entry> </row> <row> <entry>yaz.log_file</entry> <entry>""</entry> <entry>PHP_INI_ALL</entry> </row> </tbody> </tgroup> </table> &ini.table.bottom; </para> </section> <!-- 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 --> Index: phpdoc-fr/reference/yaz/functions/yaz-get-option.xml +++ phpdoc-fr/reference/yaz/functions/yaz-get-option.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.yaz-get-option"> <refnamediv> <refname>yaz_get_option</refname> <refpurpose>Retourne la valeur d'une option de connexion YAZ</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>yaz_get_option</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> <methodname>yaz_get_option</methodname> retourne la valeur de l'option <parameter>name</parameter> pour la connexion YAZ <parameter>name</parameter>. Si cette option n'est pas définie, une chaîne vide est retournée. </para> <para> Voyez la description de <function>yaz_set_option</function> pour connaître les options disponibles. </para> </refsect1> </refentry> <!-- 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 --> Index: phpdoc-fr/reference/yaz/functions/yaz-schema.xml +++ phpdoc-fr/reference/yaz/functions/yaz-schema.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.yaz-schema"> <refnamediv> <refname>yaz_schema</refname> <refpurpose>Spécifie le schema de lecture</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_schema</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>schema</parameter></methodparam> </methodsynopsis> <para> <methodname>yaz_schema</methodname> spécifie le schema de lecture <parameter>schema</parameter> pour la connexion <parameter>id</parameter>. Le schéma doit être spécifié sous la forme d'un OID (Object Identifier), au format points (comme par exemple <literal>1.2.840.10003.13.4</literal>) ou sous la forme d'un schéma enregistré : <literal>GILS-schema</literal>, <literal>Holdings</literal>, <literal>Zthes</literal>, ... Cette fonction doit être appelée avant <function>yaz_search</function> et <function>yaz_present</function>. </para> </refsect1> </refentry> <!-- 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 --> Index: phpdoc-fr/reference/yaz/functions/yaz-set-option.xml +++ phpdoc-fr/reference/yaz/functions/yaz-set-option.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.yaz-set-option"> <refnamediv> <refname>yaz_set_option</refname> <refpurpose>Modifie une ou plusieurs options de connexion YAZ</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>yaz_set_option</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>string</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> <methodname>yaz_set_option</methodname> modifiel l'option <parameter>name</parameter>, en lui affectant la nouvelle valeur <parameter>value</parameter>, pour la connexion au serveur représentée par <parameter>id</parameter>. </para> <table> <title>Options de connexion PYP/YAZ</title> <tgroup cols="2"> <colspec colwidth="2*" colname="name"/> <colspec colwidth="5*" colname="description"/> <thead> <row> <entry>Nom</entry> <entry>Description</entry> </row> </thead> <tbody> <row> <entry>implementationName</entry> <entry>nom de l'implementation du serveur</entry> </row> <row> <entry>implementationVersion</entry> <entry>version de l'implementation du serveur</entry> </row> <row> <entry>implementationId</entry> <entry>ID de l'implementation du serveur</entry> </row> <row> <entry>schema</entry> <entry>schema de lecture. Par défaut, aucun schéma n'est utilisé. Modifier cette option est l'équivalent de l'utilisation de la fonction <function>yaz_schema</function></entry> </row> <row> <entry>preferredRecordSyntax</entry> <entry>Syntaxe des enregistrement en lecture. Par défaut, il n'y a pas de syntaxe. Modifier cette option est l'équivalent de l'utilisation de la fonction <function>yaz_syntax</function></entry> </row> <row> <entry>start</entry> <entry>Décalage du premier enregistrement à lire, via la fonction <function>yaz_search</function> ou <function>yaz_present</function>. Les enregistrements sont numérotés à partir de 0. Modifier cette option, en combinaison avec l'option <literal>count</literal>, est l'équivalent de l'utilisation de la fonction <function>yaz_range</function>, hormis le fait que les enregistrements sont numérotés à partir de 1 avec <function>yaz_range</function> </entry> </row> <row> <entry>count</entry> <entry>Nombre maximal d'enregistrements à lire via <function>yaz_search</function> et <function>yaz_present</function>. </entry> </row> <row> <entry>elementSetName</entry> <entry>element-set-name en lecture. Modifier cette option est l'équivalent de l'utilisation de la fonction <function>yaz_element</function>. </entry> </row> </tbody> </tgroup> </table> </refsect1> </refentry> <!-- 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 --> Index: phpdoc-fr/reference/yaz/functions/yaz-sort.xml +++ phpdoc-fr/reference/yaz/functions/yaz-sort.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-sort"> <refnamediv> <refname>yaz_sort</refname> <refpurpose>Configure les critères de tri</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_sort</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>criteria</parameter></methodparam> </methodsynopsis> <para> <methodname>yaz_sort</methodname> permet de configurer les critères de tri, et d'activer le tri Z39.50. Utilisez cette fonction conjointement avec <function>yaz_search</function> ou <function>yaz_present</function>. Utiliser cette fonction seule n'a aucun effet. Si elle est utilisée conjointement avec <function>yaz_search</function>, une commande Z39.50 Sort ser envoyée après chaque retour de recherche, et avant que les résultats ne soient lus avec Z39.50 Present. Le paramètre <parameter>criteria</parameter> prend la forme suivante : </para> <para> <replaceable>field1 flags1 field2 flags2</replaceable> ... </para> <para> où field1 spécifie l'attribut primaire de tri, field2 le second, etc... Le champs spécifie soit une combinaison d'attributs numériques, constituée de paire type=valeur, séparée par des virgules (e.g. <literal>1=4,2=1</literal>) , soit le champs spécifie un critère en chaîne de caractère (e.g. <literal>title</literal>). Les options (flags) sont des séquences de caractères, choisis parmi les valeurs suivantes. Ces caractères ne peuvent être séparé par des espaces : </para> <variablelist> <title>Options de tri</title> <varlistentry><term><literal>a</literal></term><listitem> <simpara>Tri ascendant</simpara></listitem> </varlistentry> <varlistentry><term><literal>d</literal></term><listitem> <simpara>Tri descendant</simpara></listitem> </varlistentry> <varlistentry><term><literal>i</literal></term><listitem> <simpara>Tri insensible à la casse</simpara></listitem> </varlistentry> <varlistentry><term><literal>s</literal></term><listitem> <simpara>Tri sensible à la casse</simpara></listitem> </varlistentry> </variablelist> <example> <title>Critères de tri</title> <para> Pour effectuer des tris avec l'attribut Bib1 du champ title, de manière insensible à la casse, vous pouvez utiliser le critère suivant : <screen> 1=4 ia </screen> </para> <para> Si le second critère de tri doit être l'auteur, en tenant compte de la casse, et dans l'ordre alphabétique, vous pouvez utiliser : <screen> 1=4 ia 1=1003 sa </screen> </para> </example> </refsect1> </refentry> <!-- 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 -->
Index: phpdoc-fr/reference/yaz/reference.xml diff -u phpdoc-fr/reference/yaz/reference.xml:1.2 phpdoc-fr/reference/yaz/reference.xml:1.3 --- phpdoc-fr/reference/yaz/reference.xml:1.2 Mon Apr 15 20:55:33 2002 +++ phpdoc-fr/reference/yaz/reference.xml Thu May 8 15:59:52 2003 @@ -4,53 +4,45 @@ <titleabbrev>YAZ</titleabbrev> <partintro> <section id="yaz.intro"> - <title>Introduction</title> - <para> - Cette extension offre à PHP l'interface avec les produits - <productname>YAZ</productname>, qui implémentent le protocole - Z39.50. Avec cette extension, vous pouvez facilement implémenter - un client Z39.50 qui analyse ou scanne des serveurs Z39.50 en paralléle. - </para> - <para> - <productname>YAZ</productname> est disponible à <ulink - url="&url.yaz;">&url.yaz;</ulink>. Vous pouvez trouvez des informations, - des scripts d'exemples, etc... pour cette extension à <ulink - url="&url.yaz-phpyaz;">&url.yaz-phpyaz;</ulink>. - </para> - <para> - Le module masque l'essentiel de la complexité de Z39.50, ce qui le rend - très facile à utiliser. Il supporte les connexions peristantes de - manière similaire à celle supportés par les serveurs SQL : - cela signifie qu'une connexion est partagée entre plusieurs scripts PHP, - ce qui évite les opérations de connexions. - </para> + &reftitle.intro; + <para> + Cette extension offre à PHP l'interface avec les produits + <productname>YAZ</productname>, qui implémentent le + <ulink url="&url.yaz-loc;">protocole Z39.50</ulink>. + Avec cette extension, vous pouvez facilement implémenter + un client Z39.50 qui analyse ou scanne des serveurs Z39.50 en paralléle. + </para> + <para> + Le module masque l'essentiel de la complexité de Z39.50, ce qui le rend + très facile à utiliser. Il supporte les connexions peristantes de + manière similaire à celle supportés par les serveurs SQL : + cela signifie qu'une connexion est partagée entre plusieurs scripts PHP, + ce qui évite les opérations de connexions. + </para> + <para> + <productname>YAZ</productname> est disponible à <ulink + url="&url.yaz;">&url.yaz;</ulink>. Vous pouvez trouvez des informations, + des scripts d'exemples, etc... pour cette extension à <ulink + url="&url.yaz-phpyaz;">&url.yaz-phpyaz;</ulink>. + </para> </section> - <section id="yaz.install"> - <title>Installation</title> - <para> - Compilez YAZ et installez le. Compilez PHP avec vos modules et ajoutez l'option - <link linkend="install.configure.with-yaz"><option role="configure">--with-yaz</option></link>. - Les instructions sont : - </para> - <para> - <informalexample> - <programlisting> -gunzip -c yaz-1.6.tar.gz|tar xf - -gunzip -c php-4.0.X.tar.gz|tar xf - -cd yaz-1.6 -./configure --prefix=/usr -make -make install -cd ../php-4.0.X -./configure --with-yaz=/usr/bin -make -make install - </programlisting> - </informalexample> - </para> + + &reference.yaz.configure; + + &reference.yaz.ini; + + <section id="yaz.resources"> + &reftitle.resources; + &no.resource; </section> - <section id="yaz.example"> - <title>Exemple</title> + + <section id="yaz.constants"> + &reftitle.constants; + &no.constants; + </section> + + <section id="yaz.examples"> + &reftitle.examples; <para> PHP/YAZ conserve les connexions aux serveurs. Un entier positif représente l'ID d'une connexion particulière. @@ -62,34 +54,35 @@ <example> <title>Recherche paralléle utilisant YAZ</title> <programlisting role="php"> -<?php +<![CDATA[ +<?php $num_hosts = count ($host); if (empty($term) || count($host) == 0) { - echo '<form method="get"> - <input type="checkbox" - name="host[]" value="bagel.indexdata.dk/gils"> + echo '<form method="get"> + <input type="checkbox" + name="host[]" value="bagel.indexdata.dk/gils"> GILS test - <input type="checkbox" - name="host[]" value="localhost:9999/Default"> + <input type="checkbox" + name="host[]" value="localhost:9999/Default"> local test - <input type="checkbox" checked="1" - name="host[]" value="z3950.bell-labs.com/books"> + <input type="checkbox" checked="1" + name="host[]" value="z3950.bell-labs.com/books"> BELL Labs Library - <br> + <br> RPN Query: - <input type="text" size="30" name="term"> - <input type="submit" name="action" value="Search"> + <input type="text" size="30" name="term"> + <input type="submit" name="action" value="Search"> '; } else { - echo 'Vous avez recherché '.htmlspecialchars($term).'<br>'; - for ($i = 0; $i > $num_hosts; $i++) { + echo 'Vous avez recherché '.htmlspecialchars($term).'<br>'; + for ($i = 0; $i > $num_hosts; $i++) { $id[] = yaz_connect($host[$i]); yaz_syntax($id[$i],"sutrs"); yaz_search($id[$i],"rpn",$term); } yaz_wait(); - for ($i = 0; $i < $num_hosts; $i++) { - echo '<hr>'.$host[$i].":"; + for ($i = 0; $i < $num_hosts; $i++) { + echo '<hr>'.$host[$i].":"; $error = yaz_error($id[$i]); if (!empty($error)) { echo "Erreur: $error"; @@ -97,22 +90,23 @@ $hits = yaz_hits($id[$i]); echo "Nombre de résultats : $hits"; } - echo '<dl>'; - for ($p = 1; $p <= 10; $p++) { + echo '<dl>'; + for ($p = 1; $p <= 10; $p++) { $rec = yaz_record($id[$i],$p,"string"); if (empty($rec)) continue; - echo "<dt><B>$p</B></dt><dd>"; - echo ereg_replace("\n", "<br>\n",$rec); - echo "</dd>"; + echo "<dt><B>$p</B></dt><dd>"; + echo ereg_replace("\n", "<br>\n",$rec); + echo "</dd>"; } - echo '</dl>'; + echo '</dl>'; } } -?> - </programlisting> - </example> - </para> - </section> +?> +]]> + </programlisting> + </example> + </para> + </section> </partintro> &reference.yaz.functions; Index: phpdoc-fr/reference/yaz/functions/yaz-addinfo.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-addinfo.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-addinfo.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-addinfo.xml:1.1 Sun Apr 14 20:40:21 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-addinfo.xml Thu May 8 15:59:52 2003 @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_addinfo</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <type>string</type><methodname>yaz_addinfo</methodname> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_addinfo</function> retourne plus de détails après Index: phpdoc-fr/reference/yaz/functions/yaz-ccl-conf.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-ccl-conf.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-ccl-conf.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-ccl-conf.xml:1.2 Sun Apr 13 09:30:59 2003 +++ phpdoc-fr/reference/yaz/functions/yaz-ccl-conf.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_ccl_conf</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>array</type><parameter>config</parameter></methodparam> </methodsynopsis> <para> @@ -28,21 +28,23 @@ </para> <para> <example> - <title>Exemple de configuration CCL</title> - <simpara> - Dans l'exemple ci-dessous, l'analyseur CCL est configuré pour - supporter trois champs CCL : <literal>ti</literal>, <literal>au</literal> et - <literal>isbn</literal>. Chaque champs correspond à leur équivalent - équivalent BIB-1. On suppose que chaque variable <literal>$id</literal> est - un hôte de destination. - </simpara> - <programlisting role="php"> -<?php - $field["ti"] = "1=4"; - $field["au"] = "1=1"; - $field["isbn"] = "1=7"; - yaz_ccl_conf($id,$field); -?< + <title>Exemple de configuration CCL</title> + <simpara> + Dans l'exemple ci-dessous, l'analyseur CCL est configuré pour + supporter trois champs CCL : <literal>ti</literal>, <literal>au</literal> et + <literal>isbn</literal>. Chaque champs correspond à leur équivalent + équivalent BIB-1. On suppose que chaque variable <literal>$id</literal> est + un hôte de destination. + </simpara> + <programlisting role="php"> +<![CDATA[ +<?php + $field["ti"] = "1=4"; + $field["au"] = "1=1"; + $field["isbn"] = "1=7"; + yaz_ccl_conf($id,$field); +?> +]]> </programlisting> </example> </para> Index: phpdoc-fr/reference/yaz/functions/yaz-ccl-parse.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-ccl-parse.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-ccl-parse.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-ccl-parse.xml:1.2 Tue Aug 13 22:19:35 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-ccl-parse.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_ccl_parse</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> <methodparam><type>array &</type><parameter>result</parameter></methodparam> </methodsynopsis> @@ -25,13 +25,33 @@ et l'index <literal>rpn</literal> du tableau <parameter>result</parameter> contient une requête RPN valide. Si la requête n'a pas pu être convertie, (pour n'importe quelle raison, comme syntaxe invalide, champs inconnu...), - <function>yaz_ccl_parse</function> retourne <literal>FALSE</literal>. + <function>yaz_ccl_parse</function> retourne &false;. Trois index sont alors créés dans le tableau de résultat : <literal>errorcode</literal> (code d'erreur CCL, un entier), <literal>errorstring</literal> (message d'erreur CCL), et <literal>errorpos</literal> position estimée de l'erreur dans la requête (entier, position en nombre de caractères). </para> + <example> + <title>Configuration CCL</title> + <para> + Dans l'exemple ci-dessous, l'analyseur CCL est configuré pour supporter + trois champs CCL : <literal>ti</literal>, <literal>au</literal> et + <literal>isbn</literal>. Chaque champs correspond à son équivalent + BIB-1. On suppose que la variable <literal>$id</literal> est la resource de + connexion. + <programlisting> +<![CDATA[ +<?php + $fields["ti"] = "1=4"; + $fields["au"] = "1=1"; + $fields["isbn"] = "1=7"; + yaz_ccl_conf($id,$fields); +?> +]]> + </programlisting> + </para> + </example> </refsect1> </refentry> Index: phpdoc-fr/reference/yaz/functions/yaz-close.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-close.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-close.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-close.xml:1.1 Sun Apr 14 20:40:22 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-close.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_close</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_close</function> ferme une connexion à un Index: phpdoc-fr/reference/yaz/functions/yaz-connect.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-connect.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-connect.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-connect.xml:1.2 Tue Aug 13 22:19:35 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-connect.xml Thu May 8 15:59:52 2003 @@ -11,10 +11,10 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_connect</methodname> + <type>resource</type><methodname>yaz_connect</methodname> <methodparam><type>string</type><parameter>zurl</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>authentication</parameter></methodparam> - </methodsynopsis> + <methodparam choice="opt"><type>mixed</type><parameter>options</parameter></methodparam> + </methodsynopsis> <para> <function>yaz_connect</function> retourne un identifiant positif en cas de succès, et &false;sinon. @@ -29,6 +29,63 @@ préparer la connexion pour exécution ultérieure par <function>yaz_wait</function>. </para> + <para> + Si le second argument <parameter>options</parameter> est fourni sous la + forme d'une chaîne, il est traité comme une chaîne d'authentification + Z39.50 V2 (OpenAuth). + </para> + <para> + Si <parameter>options</parameter> est fourni sous la forme d'un tableau, + le contenu du tableau servira d'options. Notez que ce tableau d'options est + supporté depuis &php; 4.1.0. + + <variablelist> + <title>Options <function>yaz_connect</function></title> + <varlistentry><term>user</term><listitem> + <simpara>Nom d'utilisateur pour l'authentification. + </simpara></listitem> + </varlistentry> + <varlistentry><term>group</term><listitem> + <simpara>Groupe d'authentification. + </simpara></listitem> + </varlistentry> + <varlistentry><term>password</term><listitem> + <simpara>Mot de passe d'authentification. + </simpara></listitem> + </varlistentry> + <varlistentry><term>cookie</term><listitem> + <simpara>Cookie de session (proxy YAZ). + </simpara></listitem> + </varlistentry> + <varlistentry><term>proxy</term><listitem> + <simpara>Proxy de connexion (proxy YAZ). + </simpara></listitem> + </varlistentry> + <varlistentry><term>persistent</term><listitem> + <simpara>Un &boolean;. Si il vaut &true; la connexion sera + persistante; Si il vaut &false;, la connexion ne sera pas persistant. + Par défaut, les connexions sont persistantes. + </simpara></listitem> + </varlistentry> + <varlistentry><term>piggyback</term><listitem> + <simpara>Un &boolean;. Si il vaut &true;, piggyback est activé pour + les recherches. Si il vaut &false;, piggyback est désactivé. + Par défaut, piggyback est activé. Activer piggyback est plus efficace, + et généralement, cela économise des aller-retours sur le réseau pour + les premières lectures de résultat. Mais peut de serveurs + Z39.50 supporte piggyback, ou bien ils ignorent ce jeu de noms. + Pour ceux la, il faut que piggyback soit désactivé. + </simpara></listitem> + </varlistentry> + </variablelist> + </para> + <note> + <para> + L'utilisation d'un proxy améliore souvent les performances. Un + proxy Z39.50 fait partie du package libre + <ulink url="&url.yaz-proxy;">YAZ++</ulink>. + </para> + </note> </refsect1> </refentry> Index: phpdoc-fr/reference/yaz/functions/yaz-database.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-database.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-database.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-database.xml:1.2 Tue Aug 13 22:19:35 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-database.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_database</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>databases</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc-fr/reference/yaz/functions/yaz-element.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-element.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-element.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-element.xml:1.2 Tue Aug 13 22:19:35 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-element.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_element</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>elementset</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc-fr/reference/yaz/functions/yaz-errno.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-errno.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-errno.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-errno.xml:1.1 Sun Apr 14 20:40:22 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-errno.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_errno</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_errno</function> retourne le numéro d'erreur de la Index: phpdoc-fr/reference/yaz/functions/yaz-error.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-error.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-error.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-error.xml:1.1 Sun Apr 14 20:40:22 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-error.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>string</type><methodname>yaz_error</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_error</function> retourne un message d'erreur pour la Index: phpdoc-fr/reference/yaz/functions/yaz-hits.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-hits.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-hits.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-hits.xml:1.1 Sun Apr 14 20:40:22 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-hits.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_hits</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_hits</function> retourne le nombre de résultat de Index: phpdoc-fr/reference/yaz/functions/yaz-itemorder.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-itemorder.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-itemorder.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-itemorder.xml:1.1 Sun Apr 14 20:40:22 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-itemorder.xml Thu May 8 15:59:52 2003 @@ -12,18 +12,18 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_itemorder</methodname> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>array</type><parameter>args</parameter></methodparam> </methodsynopsis> <para> - <function>yaz_itemorder</function> prépare une requête de type "Extended Services" - en utilisant le "Profile" avec "Use of Z39.50 Item Order Extended Service to - Transport ILL (Profile/1)" (Note du Traducteur : mailez moi de l'aide!). Reportez-vous - <ulink url="&url.yaz.ill;">ici</ulink> - ou aux - <ulink url="&url.yaz.specs;">spécification</ulink>. + <function>yaz_itemorder</function> prépare une requête + de type "Extended Services" en utilisant le "Profile" avec + "Use of Z39.50 Item Order Extended Service to Transport ILL (Profile/1)". + Reportez-vous <ulink url="&url.yaz.ill;">ici</ulink> ou aux + <ulink url="&url.yaz.specs;">spécifications</ulink>. Le paramètre <parameter>args</parameter> doit être un tableau associatif, contenant les informations "Item Order" à envoyer. L'index du tableau est - le nom ASN.1 correspondant au tag path. Par exemple, le numéro ISBN sous + le nom ASN.1 correspondant au "tag path". Par exemple, le numéro ISBN sous l'Item-ID est la clé item-id,ISBN. </para> <para> Index: phpdoc-fr/reference/yaz/functions/yaz-present.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-present.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-present.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-present.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-present.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_present</methodname> - <void/> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> </methodsynopsis> <para> <function>yaz_present</function> prépare PHP à la lecture des Index: phpdoc-fr/reference/yaz/functions/yaz-range.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-range.xml:1.2 phpdoc-fr/reference/yaz/functions/yaz-range.xml:1.3 --- phpdoc-fr/reference/yaz/functions/yaz-range.xml:1.2 Tue Aug 13 22:19:35 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-range.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_range</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>int</type><parameter>start</parameter></methodparam> <methodparam><type>int</type><parameter>number</parameter></methodparam> </methodsynopsis> Index: phpdoc-fr/reference/yaz/functions/yaz-record.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-record.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-record.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-record.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-record.xml Thu May 8 15:59:52 2003 @@ -9,8 +9,8 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>int</type><methodname>yaz_record</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <type>string</type><methodname>yaz_record</methodname> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>int</type><parameter>pos</parameter></methodparam> <methodparam><type>string</type><parameter>type</parameter></methodparam> </methodsynopsis> Index: phpdoc-fr/reference/yaz/functions/yaz-scan-result.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-scan-result.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-scan-result.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-scan-result.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-scan-result.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>array</type><methodname>yaz_scan_result</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam choice="opt"><type>array &</type><parameter>result</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc-fr/reference/yaz/functions/yaz-scan.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-scan.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-scan.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-scan.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-scan.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_scan</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>type</parameter></methodparam> <methodparam><type>string</type><parameter>startterm</parameter></methodparam> <methodparam choice="opt"><type>array</type><parameter>flags</parameter></methodparam> @@ -40,31 +40,35 @@ </para> <para> <example> - <title>Fonction PHP qui scanne les titres</title> + <title>Fonction PHP qui scanne les titres sur un serveur YAZ</title> <programlisting> - function scan_titles($id, $starterm) { - yaz_scan($id,"rpn", "@attr 1=4 " . $starterm); - yaz_wait(); - $errno = yaz_errno($id); - if ($errno == 0) { - $ar = yaz_scan_result($id,&$options); - echo 'Scan ok; '; - $ar = yaz_scan_result($id, &$options); - while(list($key,$val)=each($options)) { - echo "$key = $val "; - } - echo '<br><table><tr><td>'; - while(list($key,list($k, $term, $tcount))=each($ar)) { - if (empty($k)) continue; - echo "<tr><td>$term</td><td>"; - echo $tcount; - echo "</td></tr>"; - } - echo '</table>'; - } else { - echo "Echec du scan. Erreur: " . yaz_error($id) . "<br>"; - } - } +<![CDATA[ +<?php + function scan_titles($id, $starterm) { + yaz_scan($id,"rpn", "@attr 1=4 " . $starterm); + yaz_wait(); + $errno = yaz_errno($id); + if ($errno == 0) { + $ar = yaz_scan_result($id,&$options); + echo 'Scan réussi; '; + $ar = yaz_scan_result($id, &$options); + while(list($key,$val)=each($options)) { + echo "$key = $val "; + } + echo '<br><table><tr><td>'; + while(list($key,list($k, $term, $tcount))=each($ar)) { + if (empty($k)) continue; + echo "<tr><td>$term</td><td>"; + echo $tcount; + echo "</td></tr>"; + } + echo '</table>'; + } else { + echo "Echec du scan. Erreur: " . yaz_error($id) . "<br>"; + } + } +?> +]]> </programlisting> </example> </para> Index: phpdoc-fr/reference/yaz/functions/yaz-search.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-search.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-search.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-search.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-search.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_search</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>type</parameter></methodparam> <methodparam><type>string</type><parameter>query</parameter></methodparam> </methodsynopsis> @@ -81,36 +81,55 @@ </tbody> </tgroup> </table> + <example> + <title>Exemples de requêtes</title> <para> - Les requêtes suivantes illustrent des requêtes valides : - <informalexample> - <screen>ordinateur</screen> - </informalexample> - Recherche les documents qui contiennent le mot "ordinateur". Aucun attribut - n'est spécifié. - </para> - <para> - <informalexample> - <screen>"serveur rapide"</screen> - </informalexample> - Recherche les documents qui contiennent les mots "serveur rapide" - </para> - <para> - <informalexample> - <screen>@attr 1=4 php</screen> - </informalexample> - L'attribut est de type 1 (Bib-1 use), sa valeur est 4 (Title, titre) : - cette requête recherche les documents où le mot "php" - est dans le titre. - </para> - <para> - <informalexample> - <screen>@attrset gils @and @attr 1=4 php @attr 1=1003 "Rasmus Lerdorf"</screen> - </informalexample> - Cette requête utilise tout le jeu d'attributs GILS. Elle recherche - les documents dont le titre contient "php", et qui contiennent le - nom "Rasmus Lerdorf" comme auteur. - </para> + Vous pouvez rechercher des termes simples comme + <screen>ordinateur</screen> + qui identifieront les documents où "ordinateur" apparait. + Aucun attribut n'est spécifié. + </para> + <para> + La requête <screen>"knuth donald"</screen> + recherche les documents où "knuth donald" apparait (en + supposant que le serveur supporte la recherche par phrase). + </para> + <para> + Cette requête applique deux attributs à la phrase recherchée : + <screen>@attr 1=1003 @attr 4=1 "knuth donald"</screen> + Le premier attribut est de type 1 (Bib-1), et sa valeur est 1003 + (Auteur). + Le second attribut est de type 4 (structure), valeur 1 (phrase), + ce qui fait que la requête recherche les documents dont + Donald Knuth est l'auteur. + </para> + <para> + Cette requête + <screen>@and @or a b @not @or c d e</screen> + sera traduite en notation infix comme ceci : + <literal>(a or b) and ((c or d) not e)</literal>. + </para> + <para> + Un autre exemple plus complexe : +<screen>@attrset gils @and @attr 1=4 art @attr 1=2000 company</screen> + La requête utilise l'ensemble de sous attributs GILS. La requête + recherche les documents où le mot <literal>art</literal> apparait dans le + titre (GILS,BIB-1) et dont la société (<literal>company</literal>) apparait + comme distributeur (GILS). + </para> + </example> + <para> + Vous pouvez trouvers plus d'informations sur les requêtes et attributs + sur le site de + <ulink url="&url.yaz-loc-bib1;">Z39.50 Maintenance Agency</ulink>. + </para> + <note> + <para> + Si vous préférez une notation plus conviviale, utilisez l'analyseur + CCL : <function>yaz_ccl_conf</function> et <function>yaz_ccl_parse</function>. + </para> + </note> + </refsect1> </refentry> Index: phpdoc-fr/reference/yaz/functions/yaz-syntax.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-syntax.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-syntax.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-syntax.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-syntax.xml Thu May 8 15:59:52 2003 @@ -12,7 +12,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_syntax</methodname> - <methodparam><type>int</type><parameter>id</parameter></methodparam> + <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>syntax</parameter></methodparam> </methodsynopsis> <para> Index: phpdoc-fr/reference/yaz/functions/yaz-wait.xml diff -u phpdoc-fr/reference/yaz/functions/yaz-wait.xml:1.1 phpdoc-fr/reference/yaz/functions/yaz-wait.xml:1.2 --- phpdoc-fr/reference/yaz/functions/yaz-wait.xml:1.1 Sun Apr 14 20:40:23 2002 +++ phpdoc-fr/reference/yaz/functions/yaz-wait.xml Thu May 8 15:59:52 2003 @@ -10,7 +10,7 @@ <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_wait</methodname> - <void/> + <methodparam choice="opt"><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> <para> <function>yaz_wait</function> exécute les requêtes @@ -20,6 +20,20 @@ <function>yaz_wait</function> se termine lorsque tous les hôtes ont terminé leurs requêtes (éventuellement en cas d'erreur). </para> + <para> + Si le paramètre <parameter>options</parameter> est fourni, il doit + contenir les options suivantes, + pour modifier le comportement de <function>yaz_wait</function>. + </para> + <variablelist> + <varlistentry><term><literal>timeout</literal></term><listitem> + <para>Configure le délais maximal d'attente, en secondes. Si le serveur + n'a pas répondu dans ce délai, la connexion est considérée comme + morte et <function>yaz_wait</function> se termine. Par défaut, + ce délai est de 15 secondes. + </para></listitem> + </varlistentry> + </variablelist> </refsect1> </refentry> Index: phpdoc-fr/reference/yaz/configure.xml +++ phpdoc-fr/reference/yaz/configure.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="yaz.installation"> &reftitle.install; <para> Compilez YAZ (ANSI/NISO Z39.50 support) et installez-le. Compilez &php; avec vos modules et ajoutez l'option <option role="configure">--with-yaz[=DIR]</option>. Les instructions sont : </para> <para> <example> <title>Installation de YAZ</title> <programlisting role="shell"> <![CDATA[ gunzip -c php-4.3.X.tar.gz|tar xf - gunzip -c yaz-1.9.Y.tar.gz|tar xf - cd yaz-1.9.Y /configure --prefix=/usr make make install cd ../php-4.3.X. /configure --with-yaz=/usr/bin make make install ]]> </programlisting> </example> </para> &warn.imaprecodeyaz; </section> <!-- 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 --> Index: phpdoc-fr/reference/yaz/ini.xml +++ phpdoc-fr/reference/yaz/ini.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <section id="yaz.configuration"> &reftitle.runtime; &extension.runtime; <para> <table> &ini.table.title; <tgroup cols="3"> <thead> &ini.table.top; </thead> <tbody> <row> <entry>yaz.max_links</entry> <entry>"100"</entry> <entry>PHP_INI_ALL</entry> </row> <row> <entry>yaz.log_file</entry> <entry>""</entry> <entry>PHP_INI_ALL</entry> </row> </tbody> </tgroup> </table> &ini.table.bottom; </para> </section> <!-- 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 --> Index: phpdoc-fr/reference/yaz/functions/yaz-get-option.xml +++ phpdoc-fr/reference/yaz/functions/yaz-get-option.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.yaz-get-option"> <refnamediv> <refname>yaz_get_option</refname> <refpurpose>Retourne la valeur d'une option de connexion YAZ</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>yaz_get_option</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> </methodsynopsis> <para> <methodname>yaz_get_option</methodname> retourne la valeur de l'option <parameter>name</parameter> pour la connexion YAZ <parameter>name</parameter>. Si cette option n'est pas définie, une chaîne vide est retournée. </para> <para> Voyez la description de <function>yaz_set_option</function> pour connaître les options disponibles. </para> </refsect1> </refentry> <!-- 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 --> Index: phpdoc-fr/reference/yaz/functions/yaz-schema.xml +++ phpdoc-fr/reference/yaz/functions/yaz-schema.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.yaz-schema"> <refnamediv> <refname>yaz_schema</refname> <refpurpose>Spécifie le schema de lecture</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_schema</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>schema</parameter></methodparam> </methodsynopsis> <para> <methodname>yaz_schema</methodname> spécifie le schema de lecture <parameter>schema</parameter> pour la connexion <parameter>id</parameter>. Le schéma doit être spécifié sous la forme d'un OID (Object Identifier), au format points (comme par exemple <literal>1.2.840.10003.13.4</literal>) ou sous la forme d'un schéma enregistré : <literal>GILS-schema</literal>, <literal>Holdings</literal>, <literal>Zthes</literal>, ... Cette fonction doit être appelée avant <function>yaz_search</function> et <function>yaz_present</function>. </para> </refsect1> </refentry> <!-- 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 --> Index: phpdoc-fr/reference/yaz/functions/yaz-set-option.xml +++ phpdoc-fr/reference/yaz/functions/yaz-set-option.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.yaz-set-option"> <refnamediv> <refname>yaz_set_option</refname> <refpurpose>Modifie une ou plusieurs options de connexion YAZ</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>yaz_set_option</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>name</parameter></methodparam> <methodparam><type>string</type><parameter>value</parameter></methodparam> </methodsynopsis> <para> <methodname>yaz_set_option</methodname> modifiel l'option <parameter>name</parameter>, en lui affectant la nouvelle valeur <parameter>value</parameter>, pour la connexion au serveur représentée par <parameter>id</parameter>. </para> <table> <title>Options de connexion PYP/YAZ</title> <tgroup cols="2"> <colspec colwidth="2*" colname="name"/> <colspec colwidth="5*" colname="description"/> <thead> <row> <entry>Nom</entry> <entry>Description</entry> </row> </thead> <tbody> <row> <entry>implementationName</entry> <entry>nom de l'implementation du serveur</entry> </row> <row> <entry>implementationVersion</entry> <entry>version de l'implementation du serveur</entry> </row> <row> <entry>implementationId</entry> <entry>ID de l'implementation du serveur</entry> </row> <row> <entry>schema</entry> <entry>schema de lecture. Par défaut, aucun schéma n'est utilisé. Modifier cette option est l'équivalent de l'utilisation de la fonction <function>yaz_schema</function></entry> </row> <row> <entry>preferredRecordSyntax</entry> <entry>Syntaxe des enregistrement en lecture. Par défaut, il n'y a pas de syntaxe. Modifier cette option est l'équivalent de l'utilisation de la fonction <function>yaz_syntax</function></entry> </row> <row> <entry>start</entry> <entry>Décalage du premier enregistrement à lire, via la fonction <function>yaz_search</function> ou <function>yaz_present</function>. Les enregistrements sont numérotés à partir de 0. Modifier cette option, en combinaison avec l'option <literal>count</literal>, est l'équivalent de l'utilisation de la fonction <function>yaz_range</function>, hormis le fait que les enregistrements sont numérotés à partir de 1 avec <function>yaz_range</function> </entry> </row> <row> <entry>count</entry> <entry>Nombre maximal d'enregistrements à lire via <function>yaz_search</function> et <function>yaz_present</function>. </entry> </row> <row> <entry>elementSetName</entry> <entry>element-set-name en lecture. Modifier cette option est l'équivalent de l'utilisation de la fonction <function>yaz_element</function>. </entry> </row> </tbody> </tgroup> </table> </refsect1> </refentry> <!-- 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 --> Index: phpdoc-fr/reference/yaz/functions/yaz-sort.xml +++ phpdoc-fr/reference/yaz/functions/yaz-sort.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <!-- splitted from ./en/functions/yaz.xml, last change in rev 1.1 --> <refentry id="function.yaz-sort"> <refnamediv> <refname>yaz_sort</refname> <refpurpose>Configure les critères de tri</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>yaz_sort</methodname> <methodparam><type>resource</type><parameter>id</parameter></methodparam> <methodparam><type>string</type><parameter>criteria</parameter></methodparam> </methodsynopsis> <para> <methodname>yaz_sort</methodname> permet de configurer les critères de tri, et d'activer le tri Z39.50. Utilisez cette fonction conjointement avec <function>yaz_search</function> ou <function>yaz_present</function>. Utiliser cette fonction seule n'a aucun effet. Si elle est utilisée conjointement avec <function>yaz_search</function>, une commande Z39.50 Sort ser envoyée après chaque retour de recherche, et avant que les résultats ne soient lus avec Z39.50 Present. Le paramètre <parameter>criteria</parameter> prend la forme suivante : </para> <para> <replaceable>field1 flags1 field2 flags2</replaceable> ... </para> <para> où field1 spécifie l'attribut primaire de tri, field2 le second, etc... Le champs spécifie soit une combinaison d'attributs numériques, constituée de paire type=valeur, séparée par des virgules (e.g. <literal>1=4,2=1</literal>) , soit le champs spécifie un critère en chaîne de caractère (e.g. <literal>title</literal>). Les options (flags) sont des séquences de caractères, choisis parmi les valeurs suivantes. Ces caractères ne peuvent être séparé par des espaces : </para> <variablelist> <title>Options de tri</title> <varlistentry><term><literal>a</literal></term><listitem> <simpara>Tri ascendant</simpara></listitem> </varlistentry> <varlistentry><term><literal>d</literal></term><listitem> <simpara>Tri descendant</simpara></listitem> </varlistentry> <varlistentry><term><literal>i</literal></term><listitem> <simpara>Tri insensible à la casse</simpara></listitem> </varlistentry> <varlistentry><term><literal>s</literal></term><listitem> <simpara>Tri sensible à la casse</simpara></listitem> </varlistentry> </variablelist> <example> <title>Critères de tri</title> <para> Pour effectuer des tris avec l'attribut Bib1 du champ title, de manière insensible à la casse, vous pouvez utiliser le critère suivant : <screen> 1=4 ia </screen> </para> <para> Si le second critère de tri doit être l'auteur, en tenant compte de la casse, et dans l'ordre alphabétique, vous pouvez utiliser : <screen> 1=4 ia 1=1003 sa </screen> </para> </example> </refsect1> </refentry> <!-- 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 -->