cvs: phpdoc-fr /reference/stream reference.xml /reference/stream/functions stream-context-create.xml stream-context-get-options.xml
stream-copy-to-stream.xml stream-filter-append.xml stream-filter-prepend.xml stream-get-line.xml stream-get-meta-data.xml stream-get-transports.xml
stream-register-filter.xml stream-register-wrapper.xml stream-socket-accept.xml stream-socket-client.xml stream-socket-get-name.xml
stream-socket-server.xml
| From: | Damien Seguy | Date: | Mon, 28 Apr 2003 15:49:21 +0000 |
| Subject: | cvs: phpdoc-fr /reference/stream reference.xml /reference/stream/functions stream-context-create.xml stream-context-get-options.xml stream-copy-to-stream.xml stream-filter-append.xml stream-filter-prepend.xml stream-get-line.xml stream-get-meta-data.xml stream-get-transports.xml stream-register-filter.xml stream-register-wrapper.xml stream-socket-accept.xml stream-socket-client.xml stream-socket-get-name.xml stream-socket-server.xml |
||
| Groups: | php.doc.fr | ||
| Request: | Send a blank email to doc-fr+get-313@lists.php.net to get a copy of this message | ||
dams Mon Apr 28 11:49:21 2003 EDT
Added files:
/phpdoc-fr/reference/stream/functions stream-copy-to-stream.xml
stream-get-line.xml
stream-get-transports.xml
stream-socket-accept.xml
stream-socket-client.xml
stream-socket-get-name.xml
stream-socket-server.xml
Modified files:
/phpdoc-fr/reference/stream reference.xml
/phpdoc-fr/reference/stream/functions stream-context-create.xml
stream-context-get-options.xml
stream-filter-append.xml
stream-filter-prepend.xml
stream-get-meta-data.xml
stream-register-filter.xml
stream-register-wrapper.xml
Log:
spring commit
Index: phpdoc-fr/reference/stream/reference.xml diff -u phpdoc-fr/reference/stream/reference.xml:1.4 phpdoc-fr/reference/stream/reference.xml:1.5 --- phpdoc-fr/reference/stream/reference.xml:1.4 Sun Apr 13 09:27:15 2003 +++ phpdoc-fr/reference/stream/reference.xml Mon Apr 28 11:49:20 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <reference id="ref.stream"> <title>Flôts</title> <titleabbrev>Flôts</titleabbrev> @@ -32,6 +32,10 @@ des gestionnaires actuellement enregistrés, utilisez la fonction <function>stream_get_wrappers</function>. </simpara> + </section> + + <section id="stream.filters"> + <title>Filtres de flôts</title> <simpara> Un <literal>filtre</literal> est une fonction finale qui effectue des opérations sur les données qui sont lues ou écrites dans un flôt. Un nombre arbitraire de @@ -68,10 +72,52 @@ </itemizedlist> </para> </section> - - <section id="stream.requirements"> - &reftitle.required; - &no.requirement; + + <section id="stream.contexts"> + <title>Contextes de flôts</title> + <simpara> + Un <literal>contexte</literal> est un jeu de paramètres et d'options + spécifiques à un gestionnaire qui modifie ou améliore le comportement + d'un flôt. Les contextes sont créés en utilisant la fonction + <function>stream_context_create</function> et peuvent être donné aux + fonctions de créations de flôts sur le système de fichier + (i.e. <function>fopen</function>, <function>file</function>, + <function>file_get_contents</function>, etc...). + </simpara> + <simpara> + Les options peuvent être spécifiées en appelant + <function>stream_context_create</function>, ou plus tard, avec + <function>stream_context_set_option</function>. + Une liste des options spécifiques à des gestionnaires est disponible + dans la liste des gestionnaires intégrés (voyez <xref linkend="wrappers"/>). + </simpara> + <simpara> + De plus, les paramètres peuvent être envoyés à un contexte en utilisant + la fonction <function>stream_context_set_params</function>. Actuellement, le + seul paramètre de contexte supporté par &php; est <literal>notification</literal>. + La valeur de ce paramètre doit être le nom d'une fonction qui sera appelée + lorsqu'un événement survient pour un flôt. La fonction d'alerte + est appelé durant la reception de l'événement, et doit accepter 6 paramètres : + </simpara> + <methodsynopsis> + <type>void</type><methodname>my_notifier</methodname> + <methodparam><type>int</type><parameter>notification_code</parameter></methodparam> + <methodparam><type>int</type><parameter>severity</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + <methodparam><type>int</type><parameter>message_code</parameter></methodparam> + <methodparam><type>int</type><parameter>bytes_transferred</parameter></methodparam> + <methodparam><type>int</type><parameter>bytes_max</parameter></methodparam> + </methodsynopsis> + <simpara> + <parameter>notification_code</parameter> et <parameter>severity</parameter> + sont des valeurs numériques qui correspondent aux constantes <constant>STREAM_NOTIFY_*</constant> + listées ci-dessous. Si un message descriptif est disponible dans un flôt, les + paramètre <parameter>message</parameter> et <parameter>message_code</parameter> + en seront équipé. La signification de ces valeurs est dépendante du gestionnaire. + + <parameter>bytes_transferred</parameter> et <parameter>bytes_max</parameter> seront + fournies lorsque possible. + </simpara> </section> <section id="stream.installation"> @@ -82,13 +128,8 @@ </para> </section> - <section id="stream.configuration"> - &reftitle.runtime; - &no.config; - </section> - <section id="stream.resources"> - <title>Stream Classes</title> + <title>Classes Stream</title> <simpara> Des gestionnaires personnalisés peuvent être enregistrés via la fonction <function>stream_register_wrapper</function>, en utilisant la définition de @@ -102,37 +143,7 @@ </simpara> </section> - <section id="stream.constants"> - &reftitle.constants; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>Constante</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>STREAM_USE_PATH</constant></entry> - <entry><literal>Flag</literal> indique si le flôt fait partie de - l'include_path. - </entry> - </row> - <row> - <entry><constant>STREAM_REPORT_ERRORS</constant></entry> - <entry><literal>Flag</literal> indiquant si le gestionnaire est responsable - de la levée des erreurs via <function>trigger_error</function> durant les - opérations de flôts. Si cette option n'est pas activée, vous ne - pourrez pas générer d'erreurs. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </section> + &reference.stream.constants; <section id="stream.errors"> <title>Erreurs de flôts</title> @@ -226,7 +237,7 @@ <programlisting role="php"> <![CDATA[ <?php -/* Creation d'un fichier compressee; contenant une chaine arbitraire +/* Création d'un fichier compressé contenant une chaîne arbitraire * Le fichier peut etre lu en utilisant le gestionnaire compress.zlib * ou simplement decompresse; en ligne de commande avec 'gzip -d foo-bar.txt.gz' */ Index: phpdoc-fr/reference/stream/functions/stream-context-create.xml diff -u phpdoc-fr/reference/stream/functions/stream-context-create.xml:1.1 phpdoc-fr/reference/stream/functions/stream-context-create.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-context-create.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-context-create.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-context-create"> <refnamediv> <refname>stream_context_create</refname> @@ -9,15 +9,45 @@ <title>Description</title> <methodsynopsis> <type>resource</type><methodname>stream_context_create</methodname> - <methodparam><type>array</type><parameter>params</parameter></methodparam> + <methodparam><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> <simpara> <methodname>stream_context_create</methodname> crée et retourne un contexte - de flôt, avec les paramètres fournis par <parameter>params</parameter>. + de flôt, avec les paramètres fournis par <parameter>options</parameter>. </simpara> <simpara> + Le paramètre <parameter>options</parameter> doit être un tableau + associatif, au format <literal>$arr['wrapper']['option'] = $value</literal>. + </simpara> + <example> + <title>Exemple avec <function>stream_context_create</function></title> + <programlisting role="php"> +<![CDATA[ +<?php + $opts = array( + 'http'=>array( + 'method'=>"GET", + 'header'=>"Accept-language: en\r\n" . + "Cookie: foo=bar\r\n" + ) + ); + + $context = stream_context_create($opts); + +/* Envoie une requête HTTP à www.exemple.com + avec des entêtes supplémentaires */ + $fp = fopen('http://www.exemple.com', 'r', false, $context); + fpassthru($fp); + fclose($fp); +?> +]]> + </programlisting> + </example> + <simpara> Voir aussi - <function>stream_context_set_params</function>. + <function>stream_context_set_params</function> et + la liste des gestionnaires avec des options de contexte + (<xref linkend="wrappers"/>). </simpara> </refsect1> </refentry> Index: phpdoc-fr/reference/stream/functions/stream-context-get-options.xml diff -u phpdoc-fr/reference/stream/functions/stream-context-get-options.xml:1.1 phpdoc-fr/reference/stream/functions/stream-context-get-options.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-context-get-options.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-context-get-options.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-context-get-options"> <refnamediv> <refname>stream_context_get_options</refname> @@ -8,7 +8,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>bool</type><methodname>stream_context_get_options</methodname> + <type>array</type><methodname>stream_context_get_options</methodname> <methodparam><type>resource</type><parameter>stream|context</parameter></methodparam> </methodsynopsis> <simpara> Index: phpdoc-fr/reference/stream/functions/stream-filter-append.xml diff -u phpdoc-fr/reference/stream/functions/stream-filter-append.xml:1.1 phpdoc-fr/reference/stream/functions/stream-filter-append.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-filter-append.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-filter-append.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-filter-append"> <refnamediv> <refname>stream_filter_append</refname> @@ -11,6 +11,7 @@ <type>bool</type><methodname>stream_filter_append</methodname> <methodparam><type>resource</type><parameter>stream</parameter></methodparam> <methodparam><type>string</type><parameter>filtername</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>read_write</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>params</parameter></methodparam> </methodsynopsis> <para> @@ -23,10 +24,67 @@ Pour ajouter un filtre au début de la liste, utilisez la fonction <function>stream_filter_prepend</function>. </para> - <note> + <para> + Par défaut, <function>stream_filter_prepend</function> va ajouter + le filtre à la liste de filtre de lecture si le fichier a été ouvert + en mode lecture (<literal>r</literal> et/ou <literal>+</literal>). Le + filtre sera aussi attaché à la liste des filtres de lecture + si le fichier a été ouvert en mode lecture (<literal>w</literal>, + <literal>a</literal> et/ou <literal>+</literal>). + <constant>STREAM_FILTER_READ</constant>, + <constant>STREAM_FILTER_WRITE</constant>, et/ou + <constant>STREAM_FILTER_ALL</constant> peuvent aussi être utilisées + dans le paramètre <parameter>read_write</parameter> pour contrôler + ce comportement. Voyez la fonction + <function>stream_filter_append</function> pour un exemple de l'utilisation + de ce paramètre. + </para> + <para> + <example> + <title>Contrôler l'application des filtres</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* Open a test file for reading and writting */ +$fp = fopen("test.txt","rw"); + +/* Apply the ROT13 filter to the + * write filter chain, but not the + * read filter chain */ +stream_filter_append($fp, "string.rot13", STREAM_FILTER_WRITE); + +/* Write a simple string to the file + * it will be ROT13 transformed on the + * way out */ +fwrite($fp, "This is a test\n"); + +/* Back up to the beginning of the file */ +rewind($fp); + +/* Read the contents of the file back out. + * Had the filter been applied to the + * read filter chain as well, we would see + * the text ROT13ed back to its original state */ +fpassthru($fp); + +fclose($fp); + +/* Expected Output + --------------- + +Guvf vf n grfg + + */ +?> +]]> + </programlisting> + </example> + </para> + <note> + <title>Quand utiliser des filtres personnalisés</title> <simpara> <function>stream_register_filter</function> doit être appelé avant - <function>stream_filter_append</function> pour enregistrer le filtre + <function>stream_filter_prepend</function> pour enregistrer le filtre sous le nom de <parameter>filtername</parameter>. </simpara> </note> Index: phpdoc-fr/reference/stream/functions/stream-filter-prepend.xml diff -u phpdoc-fr/reference/stream/functions/stream-filter-prepend.xml:1.1 phpdoc-fr/reference/stream/functions/stream-filter-prepend.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-filter-prepend.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-filter-prepend.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-filter-prepend"> <refnamediv> <refname>stream_filter_prepend</refname> @@ -11,6 +11,7 @@ <type>bool</type><methodname>stream_filter_prepend</methodname> <methodparam><type>resource</type><parameter>stream</parameter></methodparam> <methodparam><type>string</type><parameter>filtername</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>read_write</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>params</parameter></methodparam> </methodsynopsis> <para> @@ -23,7 +24,23 @@ Pour ajouter un filtre à la fin de la liste, utilisez la fonction <function>stream_filter_prepend</function>. </para> + <para> + Par défaut, <function>stream_filter_prepend</function> va ajouter + le filtre à la liste de filtre de lecture si le fichier a été ouvert + en mode lecture (<literal>r</literal> et/ou <literal>+</literal>). Le + filtre sera aussi attaché à la liste des filtres de lecture + si le fichier a été ouvert en mode lecture (<literal>w</literal>, + <literal>a</literal> et/ou <literal>+</literal>). + <constant>STREAM_FILTER_READ</constant>, + <constant>STREAM_FILTER_WRITE</constant>, et/ou + <constant>STREAM_FILTER_ALL</constant> peuvent aussi être utilisées + dans le paramètre <parameter>read_write</parameter> pour contrôler + ce comportement. Voyez la fonction + <function>stream_filter_append</function> pour un exemple de l'utilisation + de ce paramètre. + </para> <note> + <title>Quand utiliser des filtres personnalisés</title> <simpara> <function>stream_register_filter</function> doit être appelé avant <function>stream_filter_prepend</function> pour enregistrer le filtre Index: phpdoc-fr/reference/stream/functions/stream-get-meta-data.xml diff -u phpdoc-fr/reference/stream/functions/stream-get-meta-data.xml:1.1 phpdoc-fr/reference/stream/functions/stream-get-meta-data.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-get-meta-data.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-get-meta-data.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-get-meta-data"> <refnamediv> <refname>stream_get_meta_data</refname> @@ -8,11 +8,11 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>array</type><methodname>file_get_meta_data</methodname> + <type>array</type><methodname>stream_get_meta_data</methodname> <methodparam><type>resource</type><parameter>stream</parameter></methodparam> </methodsynopsis> <simpara> - <methodname>file_get_meta_data</methodname> retourne les informations disponibles + <methodname>stream_get_meta_data</methodname> retourne les informations disponibles sur le flôt <parameter>stream</parameter>. Ce flôt peut être n'importe quel flôt créé par <function>fopen</function>, <function>fsockopen</function> et <function>pfsockopen</function>. Le tableau résultant peut contenir les Index: phpdoc-fr/reference/stream/functions/stream-register-filter.xml diff -u phpdoc-fr/reference/stream/functions/stream-register-filter.xml:1.1 phpdoc-fr/reference/stream/functions/stream-register-filter.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-register-filter.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-register-filter.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-register-filter"> <refnamediv> <refname>stream_register_filter</refname> @@ -8,7 +8,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>boolean</type><methodname>stream_register_filter</methodname> + <type>bool</type><methodname>stream_register_filter</methodname> <methodparam><type>string</type><parameter>filtername</parameter></methodparam> <methodparam><type>string</type><parameter>classname</parameter></methodparam> </methodsynopsis> @@ -34,76 +34,38 @@ </para> <methodsynopsis> - <type>int</type><methodname>write</methodname> - <methodparam><type>string</type><parameter>data</parameter></methodparam> + <type>int</type><methodname>filter</methodname> + <methodparam><type>resource</type><parameter>in</parameter></methodparam> + <methodparam><type>resource</type><parameter>out</parameter></methodparam> + <methodparam><type>int</type><parameter>&consumed</parameter></methodparam> + <methodparam><type>boolean</type><parameter>closing</parameter></methodparam> </methodsynopsis> <para> - Cette méthode est appelée dès que les données sont écrite dans le flôt, - comme avec la fonction <function>fwrite</function>. Après la modification - des données <parameter>data</parameter>, cette méthode doit utiliser la - ligne suivante <literal>return parent::write($data);</literal> - pour que le prochain filtre puisse s'exécuter. Lorsqu'il ne reste plus - de filtres, le flôt va écrire les données <parameter>data</parameter> - dans leur forme finale. - <note> - <para> - Si votre filtre modifie la taille de la chaîne <parameter>data</parameter>, - par exemple en supprimant le premier caractère, il faut, avant d'utiliser - la fonction <literal>parent::write($data);</literal>, s'assurer d'inclure - le caractère supprimé dans la valeur de retour. - </para> - </note> - <informalexample> - <programlisting role="php"> -<![CDATA[ -class myfilter extends php_user_filter { - function write($data) { - $data = substr($data,1); - $written_by_parent = parent::write($data); - return ($written_by_parent + 1); - } -} -]]> - </programlisting> - </informalexample> - </para> - - <methodsynopsis> - <type>string</type><methodname>read</methodname> - <methodparam><type>int</type><parameter>maxlength</parameter></methodparam> - </methodsynopsis> - <para> - Cette méthode est appelée dès que des données sont lues dans le flôt - (comme avec la fonction <function>fread</function>). Un filtre doit commencer - par utiliser la ligne <literal>parent::read($maxlength);</literal> pour - lire les données issue du filtre précédent. Ultimement, ce sera le - flôt qui lira les données. Votre filtre peut alors modifier cette - valeur et retourner la valeur finale. Votre filtre ne doit jamais - retourner plus de <parameter>maxlength</parameter> octets. - Comme <literal>parent::read($maxlength);</literal> ne retournera - aussi pas plus de <parameter>maxlength</parameter>, ce ne sera pas - un problème en règle général. Cependant, si votre filtre accroit la - taille des données retournées, il faut alors appeler cette ligne avec - <literal>parent::read($maxlength-$x);</literal> où <parameter>x</parameter> - est l'accroissement maximal de vos données. Alternativement, vous pouvez - bâtir un buffer de lecture dans votre classe. - </para> - - <methodsynopsis> - <type>int</type><methodname>flush</methodname> - <methodparam><type>bool</type><parameter>closing</parameter></methodparam> - </methodsynopsis> - <para> - Cette méthode est appelée en réponse à une requête de vidage des - buffers du flôt (comme avec la fonction <function>fflush</function> ou - <function>fclose</function>). Le paramètre <parameter>closing</parameter> - vous indique si le flôt est, en réalité, dans un processus de fermeture. - L'action par défaut est d'appeler simplement - <literal>return parent::flush($closing);</literal>, mais votre filtre - peut souhaiter exécuter des écritures supplémentaires, ou bien - nettoyer des ressources avant de réaliser le vidage en règle. - </para> - + Cette méthode est appelé à chaque fois que des données sont lues ou écrites + dans le flôt attaché (avec des fonctions comme <function>fread</function> ou + <function>fwrite</function>). Le paramètre <parameter>in</parameter> est une ressource + qui pointe sur une <literal>bucket brigade</literal> qui contient un ou plusieurs + objet <literal>bucket</literal> contenant les données à filtrer. + <parameter>out</parameter> est une autre ressource + qui pointe sur une <literal>bucket brigade</literal> + dans laquelle les donnée seront placées. + <parameter>consumed</parameter>, qui doit <emphasis>toujours</emphasis> + être déclaré par référence, doit être incrémenté de la taille de données que + votre filtre lit et modifie. Dans la plupart des cas, cela signifie que vous + devrez incrémenter <parameter>consumed</parameter> avec <literal>$bucket->datalen</literal> + pour chaque <literal>$bucket</literal>. + Si le flôt est en cours de fermeture (et par conséquent, cela sera le dernier + passage dans la chaîne de filtres), le paramètre <parameter>closing</parameter> + vaudra &true; La méthode <methodname>filter</methodname> doit retourner l'une + des trois valeurs suivantes : <constant>PSFS_PASS_ON</constant> indique la réussite, + et les données sont dans le paramètre <parameter>out</parameter>, une <literal>bucket brigade</literal>. + <constant>PSFS_FEED_ME</constant> indique que le filtre n'a aucune données à retourner, et + requiert d'autres données du flôt. + <constant>PSFS_ERR_FATAL</constant> indique que le flôt a rencontré une erreur + fatale, et ne peut continuer. Si aucune valeur n'est retournée par cette méthode, + <constant>PSFS_ERR_FATAL</constant> est utilisé. + </para> + <methodsynopsis> <type>void</type><methodname>oncreate</methodname> <void/> Index: phpdoc-fr/reference/stream/functions/stream-register-wrapper.xml diff -u phpdoc-fr/reference/stream/functions/stream-register-wrapper.xml:1.2 phpdoc-fr/reference/stream/functions/stream-register-wrapper.xml:1.3 --- phpdoc-fr/reference/stream/functions/stream-register-wrapper.xml:1.2 Mon Feb 3 07:48:42 2003 +++ phpdoc-fr/reference/stream/functions/stream-register-wrapper.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.141 --> <refentry id="function.stream-register-wrapper"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>boolean</type><methodname>stream_register_wrapper</methodname> + <type>bool</type><methodname>stream_register_wrapper</methodname> <methodparam><type>string</type><parameter>protocol</parameter></methodparam> <methodparam><type>string</type><parameter>classname</parameter></methodparam> </methodsynopsis> @@ -35,7 +35,7 @@ </para> <methodsynopsis> - <type>boolean</type><methodname>stream_open</methodname> + <type>bool</type><methodname>stream_open</methodname> <methodparam><type>string</type><parameter>path</parameter></methodparam> <methodparam><type>string</type><parameter>mode</parameter></methodparam> <methodparam><type>int</type><parameter>options</parameter></methodparam> @@ -140,7 +140,7 @@ </para> <methodsynopsis> - <type>boolean</type><methodname>stream_eof</methodname> + <type>bool</type><methodname>stream_eof</methodname> <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> @@ -161,7 +161,7 @@ </para> <methodsynopsis> - <type>boolean</type><methodname>stream_seek</methodname> + <type>bool</type><methodname>stream_seek</methodname> <methodparam><type>int</type><parameter>offset</parameter></methodparam> <methodparam><type>int</type><parameter>whence</parameter></methodparam> </methodsynopsis> @@ -176,7 +176,7 @@ </para> <methodsynopsis> - <type>boolean</type><methodname>stream_flush</methodname> + <type>bool</type><methodname>stream_flush</methodname> <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> Index: phpdoc-fr/reference/stream/functions/stream-copy-to-stream.xml +++ phpdoc-fr/reference/stream/functions/stream-copy-to-stream.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-copy-to-stream"> <refnamediv> <refname>stream_copy_to_stream</refname> <refpurpose>Copie des données depuis un flôt vers un autre</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>stream_copy_to_stream</methodname> <methodparam><type>resource</type><parameter>source</parameter></methodparam> <methodparam><type>resource</type><parameter>dest</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>maxlength</parameter></methodparam> </methodsynopsis> <para> <function>stream_copy_to_stream</function> copie jusqu'à <parameter>maxlength</parameter> octets de données depuis la position courante du pointeur dans le flôt <parameter>source</parameter> vers le paramètre <parameter>dest</parameter>. Si <parameter>maxlength</parameter> n'est pas spécifié, tout le reste du flôt <parameter>source</parameter> sera copié. will be copied. <function>stream_copy_to_stream</function> retourne le total d'octets copié. <example> <title>Exemple avec <function>stream_copy_to_stream</function></title> <programlisting role="php"> <![CDATA[ <?php $src = fopen('http://www.exemple.com','r'); $dest1 = fopen('first1k.txt','w'); $dest2 = fopen('remainder.txt','w'); print stream_copy_to_stream($src, $dest1, 1024) . " octets copiés vers first1k.txt\n"; print stream_copy_to_stream($src, $dest2) . " octets copiés vers remainder.txt\n"; ?> ]]> </programlisting> </example> </para> <para> Voir aussi <function>copy</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/stream/functions/stream-get-line.xml +++ phpdoc-fr/reference/stream/functions/stream-get-line.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-get-line"> <refnamediv> <refname>stream_get_line</refname> <refpurpose>Lit une ligne dans un flôt</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>stream_get_line</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> <methodparam><type>int</type><parameter>length</parameter></methodparam> <methodparam><type>string</type><parameter>ending</parameter></methodparam> </methodsynopsis> <para> <function>stream_get_line</function> lit une ligne de taille maximale <parameter>length</parameter> dans le flôt <parameter>handle</parameter>. La lecture se termine lorsque <parameter>length</parameter> ont été lus, ou que la chaîne <parameter>ending</parameter> est trouvée dans le flôt (et qui <emphasis>n'est pas</emphasis> inclue dans la valeur retournée), ou la fin du fichier (le premier des trois). </para> <para> Si une erreur survient, <function>stream_get_line</function> retourne &false;. </para> <simpara> <function>stream_get_line</function> est presque identique à <function>fgets</function> hormis le fait qu'elle autorise d'autres délimiteur de fin de ligne que <literal>\n</literal>, <literal>\r</literal> et <literal>\r\n</literal>, et <emphasis>ne retourne pas</emphasis> le délimiteur lui-même. </simpara> <para> Voir aussi <function>fread</function>, <function>fgets</function> et <function>fgetc</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/stream/functions/stream-get-transports.xml +++ phpdoc-fr/reference/stream/functions/stream-get-transports.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-get-transports"> <refnamediv> <refname>stream_get_transports</refname> <refpurpose>Liste les gestionnaires de transports de sockets disponibles</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>array</type><methodname>stream_get_transports</methodname> <void/> </methodsynopsis> <simpara> <function>stream_get_transports</function> retourne un tableau indexé contenant les noms des transports de sockets disponibles pour le système. </simpara> <para> <example> <title>Exemple avec <function>stream_get_transports</function></title> <programlisting role="php"> <![CDATA[ <?php $xportlist = stream_get_transports(); print_r($xportlist); /* L'affichage ne sera jamais identique au suivant Note: Il peut y avoir plus ou moins de transports dans votre version de PHP --------------------------------------- Array ( [0] => tcp [1] => udp [2] => unix [3] => udg ) */ ?> ]]> </programlisting> </example> </para> <para> Voir aussi <function>stream_get_filters</function>, et <function>stream_get_wrappers</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/stream/functions/stream-socket-accept.xml +++ phpdoc-fr/reference/stream/functions/stream-socket-accept.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-socket-accept"> <refnamediv> <refname>stream_socket_accept</refname> <refpurpose> Accepte une connexion sur une socket créée par <function>stream_socket_server</function> </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>resource</type><methodname>stream_socket_accept</methodname> <methodparam><type>resource</type><parameter>server_socket</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>&peername</parameter></methodparam> </methodsynopsis> <para> <function>stream_socket_accept</function> accepte une connexion sur une socket créée précédemment avec <function>stream_socket_server</function>. Si <parameter>timeout</parameter> est spécifié, le délai d'expiration de la socket sera remplacé par cette valeur, exprimée en secondes. L'adresse du client qui est connecté est retourné dans <parameter>peername</parameter>, si cette valeur est accessible pour ce type de transport. </para> <simpara> <parameter>peername</parameter> peut aussi être déterminé plus tard avec <function>stream_socket_get_name</function>. </simpara> <simpara> Si <function>stream_socket_accept</function> échoue, elle retournera &false;. </simpara> <para> Voir aussi <function>stream_socket_server</function>, <function>stream_socket_get_name</function>, <function>stream_set_blocking</function>, <function>stream_set_timeout</function>, <function>fgets</function>, <function>fgetss</function>, <function>fputs</function>, <function>fclose</function>, <function>feof</function> et l'<link linkend="ref.curl">extension CURL</link>. </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/stream/functions/stream-socket-client.xml +++ phpdoc-fr/reference/stream/functions/stream-socket-client.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-socket-client"> <refnamediv> <refname>stream_socket_client</refname> <refpurpose> Ouvre une connexion socket Internet ou Unix </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>resource</type><methodname>stream_socket_client</methodname> <methodparam><type>string</type><parameter>remote_socket</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>&errno</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>&errstr</parameter></methodparam> <methodparam choice="opt"><type>float</type><parameter>timeout</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam> </methodsynopsis> <para> <function>stream_socket_client</function> initie un flôt ou une connexion datagramme avec la destination <parameter>remote_socket</parameter>. Le type de socket créé est déterminé par le transport spécifié avec le formattage URL suivant : <literal>transport://target</literal>. Pour une socket Internet, (<constant>AF_INET</constant>) comme TCP et UDP, la <literal>cible</literal> de <parameter>remote_socket</parameter> sera une adresse IP ou un nom d'hôte. Pour une socket Unix,la <literal>cible</literal> doit être un fichier de socket du système. </para> <para> Le paramètre optionnel <parameter>timeout</parameter> sert à imposer un délai d'expiration, en secondes, à l'appel système. </para> <para> <parameter>flags</parameter> est un champs de bits qui peut être la combinaison de n'importe quelle option de connexion. Actuellement, les valeurs possibles pour ces options sont <constant>STREAM_CLIENT_ASYNC_CONNECT</constant> et <constant>STREAM_CLIENT_PERSISTENT</constant>. </para> <note> <simpara> Si vous n'avez pas besoin de mettre de délai d'expiration pour les opérations via la socket, utilisez la fonction <function>stream_set_timeout</function>, car <parameter>timeout</parameter> de <function>stream_socket_client</function> ne s'appliqu que lors de la connexion à la socket. </simpara> </note> <para> <function>stream_socket_client</function> retourne une ressource de flôt, qui peut être utilisée avec d'autres fonctions de fichiers, comme <function>fgets</function>, <function>fgetss</function>, <function>fputs</function>, <function>fclose</function> et <function>feof</function>). </para> <para> Si l'appel échoue, <function>stream_socket_client</function> va retourner &false; et si les paramètres optionnels <parameter>errno</parameter> et <parameter>errstr</parameter> sont fournis, ils recevront l'erreur exacte qui est survenue dans le système lors de l'appel à <literal>connect()</literal>. Si la valeur retournée dans <parameter>errno</parameter> est <literal>0</literal> et que la fonction a retournée &false;, c'est une indication que l'erreur est survenue avant l'appel à <literal>connect()</literal>. Cela est probablement du à un problème d'initialisation de la socket. Notez que <parameter>errno</parameter> et<parameter>errstr</parameter> doivent être passé par référence. </para> <para> Suivant votre environnement, les sockets Unix ou le délai d'expiration peuvent ne pas être disponibles. Une liste des transports disponibles qui sont disponibles sur le système est accessible via <function>stream_get_transports</function>. </para> <para> Le flôt sera par défaut ouvert en mode bloquant. Vous pouvez le passer en mode non bloquant en utilisant la fonction <function>stream_set_blocking</function>. <example> <title>Exemple avec <function>stream_socket_client</function></title> <programlisting role="php"> <![CDATA[ <?php $fp = stream_socket_client("tcp://www.exemple.com:80", $errno, $errstr, 30); if (!$fp) { echo "$errstr ($errno)<br>\n"; } else { fputs ($fp, "GET / HTTP/1.0\r\nHost: www.example.com\r\nAccept: */*\r\n\r\n"); while (!feof($fp)) { echo fgets ($fp,1024); } fclose ($fp); } ?> ]]> </programlisting> </example> L'exemple ci-dessous vous montre comment lire la date et l'heure sur un service UDP de type "daytime" (port 13) sur votre propre machine : <example> <title>Utilisation de connexions UDP</title> <programlisting role="php"> <![CDATA[ <?php $fp = stream_socket_client("udp://127.0.0.1:13", $errno, $errstr); if (!$fp) { echo "ERREIR : $errno - $errstr<br>\n"; } else { fwrite($fp,"\n"); echo fread($fp, 26); fclose($fp); } ?> ]]> </programlisting> </example> <warning> <simpara> Les sockets UDP sembleront parfois s'ouvrir sans erreur, même si l'hôte distant n'est pas accessible. Cette erreur ne deviendra apparente que lorsque vous essaierez de lire ou écrire des données avec cette socket. La raison à cela est que UDP est un protocole sans connexion, ce qui signifie que le système d'exploitaiton n'a pas à établir de lien pour la socket, jusqu'à ce qu'il commence à échanger des données. </simpara> </warning> &ipv6.brackets; Voir aussi <function>stream_socket_server</function>, <function>stream_set_blocking</function>, <function>stream_set_timeout</function>, <function>fgets</function>, <function>fgetss</function>, <function>fputs</function>, <function>fclose</function>, <function>feof</function> et l'<link linkend="ref.curl">extension CURL</link>. </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/stream/functions/stream-socket-get-name.xml +++ phpdoc-fr/reference/stream/functions/stream-socket-get-name.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-socket-get-name"> <refnamediv> <refname>stream_socket_get_name</refname> <refpurpose>Lit le nom des sockets locale ou distante</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>stream_socket_get_name</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> <methodparam><type>boolean</type><parameter>want_peer</parameter></methodparam> </methodsynopsis> <para> <function>stream_socket_get_name</function> retourne le nom de la socket locale ou distante pour la connexion <parameter>handle</parameter>. Si <parameter>want_peer</parameter> vaut &true;, le nom de la socket distante est retourné. Si il vaut &false;, c'est le nom de la socket locale. </para> <para> Voir aussi <function>stream_socket_accept</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/stream/functions/stream-socket-server.xml +++ phpdoc-fr/reference/stream/functions/stream-socket-server.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-socket-server"> <refnamediv> <refname>stream_socket_server</refname> <refpurpose> Crée une socket serveur Unix ou Internet </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>resource</type><methodname>stream_socket_server</methodname> <methodparam><type>string</type><parameter>local_socket</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>&errno</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>&errstr</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam> </methodsynopsis> <para> <function>stream_socket_server</function> crée un flôt ou un datagramme sur la socket spécifiée <parameter>local_socket</parameter>. Le type de socket créé est déterminé par le transport spécifié avec le formattage URL suivant : <literal>transport://target</literal>. Pour une socket Internet, (<constant>AF_INET</constant>) comme TCP et UDP, la <literal>cible</literal> de <parameter>remote_socket</parameter> sera une adresse IP ou un nom d'hôte. Pour une socket Unix,la <literal>cible</literal> doit être un fichier de socket du système. </para> <para> <parameter>flags</parameter> est un champs de bits qui peut être la combinaison de n'importe quelle option de connexion. Actuellement, les valeurs possibles pour ces options sont <constant>STREAM_CLIENT_ASYNC_CONNECT</constant> et <constant>STREAM_CLIENT_PERSISTENT</constant>. La valeur par défaut est <constant>STREAM_SERVER_BIND</constant> | <constant>STREAM_SERVER_LISTEN</constant>. <para> <function>stream_socket_server</function> ne fait que créer une socket, et pour accepter des connexions, vous devez utiliser <function>stream_socket_accept</function>. </para> <para> Si l'appel échoue, <function>stream_socket_server</function> va retourner &false; et si les paramètres optionnels <parameter>errno</parameter> et <parameter>errstr</parameter> sont fournis, ils recevront l'erreur exacte qui est survenue dans le système lors de l'appel à <literal>connect()</literal>. Si la valeur retournée dans <parameter>errno</parameter> est <literal>0</literal> et que la fonction a retournée &false;, c'est une indication que l'erreur est survenue avant l'appel à <literal>connect()</literal>. Cela est probablement du à un problème d'initialisation de la socket. Notez que <parameter>errno</parameter> et<parameter>errstr</parameter> doivent être passé par référence. </para> <para> Suivant votre environnement, les sockets Unix ou le délai d'expiration peuvent ne pas être disponibles. Une liste des transports disponibles qui sont disponibles sur le système est accessible via <function>stream_get_transports</function>. </para> <para> <example> <title>Exemple avec <function>stream_socket_server</function></title> <programlisting role="php"> <![CDATA[ <?php $socket = stream_socket_server("tcp://0.0.0.0:8000", $errno, $errstr); if (!$socket) { echo "$errstr ($errno)<br>\n"; } else { while ($conn = stream_socket_accept($socket)) { fputs ($conn, 'Merci de vous connecter à mon serveur. L\'heure locale est ' . date('n/j/Y g:i a') . "\n"); fclose ($conn); } fclose($socket); } ?> ]]> </programlisting> </example> L'exemple ci-dessous vous montre comment lire la date et l'heure sur un service UDP de type "daytime" (port 13) sur votre propre machine, tel que présenté avec la fonction <function>stream_socket_client</function> : <note> <simpara>La plupart des systèmes ont besoin d'un accès administrateur pour ouvrir une socket au dela des ports 1024. </simpara> </note> <example> <title>Utiliser un serveur de socket UDP</title> <programlisting role="php"> <![CDATA[ <?php $socket = stream_socket_server("udp://0.0.0.0:13", $errno, $errstr); if (!$socket) { echo "ERROR: $errno - $errstr<br>\n"; } else { while ($conn = stream_socket_accept($socket)) { fwrite($conn, date("D M j H:i:s Y\r\n")); fclose($conn); } fclose($socket); } ?> ]]> </programlisting> </example> &ipv6.brackets; Voir aussi <function>stream_socket_client</function>, <function>stream_set_blocking</function>, <function>stream_set_timeout</function>, <function>fgets</function>, <function>fgetss</function>, <function>fputs</function>, <function>fclose</function>, <function>feof</function> et l'<link linkend="ref.curl">extension CURL</link>. </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/stream/reference.xml diff -u phpdoc-fr/reference/stream/reference.xml:1.4 phpdoc-fr/reference/stream/reference.xml:1.5 --- phpdoc-fr/reference/stream/reference.xml:1.4 Sun Apr 13 09:27:15 2003 +++ phpdoc-fr/reference/stream/reference.xml Mon Apr 28 11:49:20 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <reference id="ref.stream"> <title>Flôts</title> <titleabbrev>Flôts</titleabbrev> @@ -32,6 +32,10 @@ des gestionnaires actuellement enregistrés, utilisez la fonction <function>stream_get_wrappers</function>. </simpara> + </section> + + <section id="stream.filters"> + <title>Filtres de flôts</title> <simpara> Un <literal>filtre</literal> est une fonction finale qui effectue des opérations sur les données qui sont lues ou écrites dans un flôt. Un nombre arbitraire de @@ -68,10 +72,52 @@ </itemizedlist> </para> </section> - - <section id="stream.requirements"> - &reftitle.required; - &no.requirement; + + <section id="stream.contexts"> + <title>Contextes de flôts</title> + <simpara> + Un <literal>contexte</literal> est un jeu de paramètres et d'options + spécifiques à un gestionnaire qui modifie ou améliore le comportement + d'un flôt. Les contextes sont créés en utilisant la fonction + <function>stream_context_create</function> et peuvent être donné aux + fonctions de créations de flôts sur le système de fichier + (i.e. <function>fopen</function>, <function>file</function>, + <function>file_get_contents</function>, etc...). + </simpara> + <simpara> + Les options peuvent être spécifiées en appelant + <function>stream_context_create</function>, ou plus tard, avec + <function>stream_context_set_option</function>. + Une liste des options spécifiques à des gestionnaires est disponible + dans la liste des gestionnaires intégrés (voyez <xref linkend="wrappers"/>). + </simpara> + <simpara> + De plus, les paramètres peuvent être envoyés à un contexte en utilisant + la fonction <function>stream_context_set_params</function>. Actuellement, le + seul paramètre de contexte supporté par &php; est <literal>notification</literal>. + La valeur de ce paramètre doit être le nom d'une fonction qui sera appelée + lorsqu'un événement survient pour un flôt. La fonction d'alerte + est appelé durant la reception de l'événement, et doit accepter 6 paramètres : + </simpara> + <methodsynopsis> + <type>void</type><methodname>my_notifier</methodname> + <methodparam><type>int</type><parameter>notification_code</parameter></methodparam> + <methodparam><type>int</type><parameter>severity</parameter></methodparam> + <methodparam><type>string</type><parameter>message</parameter></methodparam> + <methodparam><type>int</type><parameter>message_code</parameter></methodparam> + <methodparam><type>int</type><parameter>bytes_transferred</parameter></methodparam> + <methodparam><type>int</type><parameter>bytes_max</parameter></methodparam> + </methodsynopsis> + <simpara> + <parameter>notification_code</parameter> et <parameter>severity</parameter> + sont des valeurs numériques qui correspondent aux constantes <constant>STREAM_NOTIFY_*</constant> + listées ci-dessous. Si un message descriptif est disponible dans un flôt, les + paramètre <parameter>message</parameter> et <parameter>message_code</parameter> + en seront équipé. La signification de ces valeurs est dépendante du gestionnaire. + + <parameter>bytes_transferred</parameter> et <parameter>bytes_max</parameter> seront + fournies lorsque possible. + </simpara> </section> <section id="stream.installation"> @@ -82,13 +128,8 @@ </para> </section> - <section id="stream.configuration"> - &reftitle.runtime; - &no.config; - </section> - <section id="stream.resources"> - <title>Stream Classes</title> + <title>Classes Stream</title> <simpara> Des gestionnaires personnalisés peuvent être enregistrés via la fonction <function>stream_register_wrapper</function>, en utilisant la définition de @@ -102,37 +143,7 @@ </simpara> </section> - <section id="stream.constants"> - &reftitle.constants; - <para> - <informaltable> - <tgroup cols="2"> - <thead> - <row> - <entry>Constante</entry> - <entry>Description</entry> - </row> - </thead> - <tbody> - <row> - <entry><constant>STREAM_USE_PATH</constant></entry> - <entry><literal>Flag</literal> indique si le flôt fait partie de - l'include_path. - </entry> - </row> - <row> - <entry><constant>STREAM_REPORT_ERRORS</constant></entry> - <entry><literal>Flag</literal> indiquant si le gestionnaire est responsable - de la levée des erreurs via <function>trigger_error</function> durant les - opérations de flôts. Si cette option n'est pas activée, vous ne - pourrez pas générer d'erreurs. - </entry> - </row> - </tbody> - </tgroup> - </informaltable> - </para> - </section> + &reference.stream.constants; <section id="stream.errors"> <title>Erreurs de flôts</title> @@ -226,7 +237,7 @@ <programlisting role="php"> <![CDATA[ <?php -/* Creation d'un fichier compressee; contenant une chaine arbitraire +/* Création d'un fichier compressé contenant une chaîne arbitraire * Le fichier peut etre lu en utilisant le gestionnaire compress.zlib * ou simplement decompresse; en ligne de commande avec 'gzip -d foo-bar.txt.gz' */ Index: phpdoc-fr/reference/stream/functions/stream-context-create.xml diff -u phpdoc-fr/reference/stream/functions/stream-context-create.xml:1.1 phpdoc-fr/reference/stream/functions/stream-context-create.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-context-create.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-context-create.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-context-create"> <refnamediv> <refname>stream_context_create</refname> @@ -9,15 +9,45 @@ <title>Description</title> <methodsynopsis> <type>resource</type><methodname>stream_context_create</methodname> - <methodparam><type>array</type><parameter>params</parameter></methodparam> + <methodparam><type>array</type><parameter>options</parameter></methodparam> </methodsynopsis> <simpara> <methodname>stream_context_create</methodname> crée et retourne un contexte - de flôt, avec les paramètres fournis par <parameter>params</parameter>. + de flôt, avec les paramètres fournis par <parameter>options</parameter>. </simpara> <simpara> + Le paramètre <parameter>options</parameter> doit être un tableau + associatif, au format <literal>$arr['wrapper']['option'] = $value</literal>. + </simpara> + <example> + <title>Exemple avec <function>stream_context_create</function></title> + <programlisting role="php"> +<![CDATA[ +<?php + $opts = array( + 'http'=>array( + 'method'=>"GET", + 'header'=>"Accept-language: en\r\n" . + "Cookie: foo=bar\r\n" + ) + ); + + $context = stream_context_create($opts); + +/* Envoie une requête HTTP à www.exemple.com + avec des entêtes supplémentaires */ + $fp = fopen('http://www.exemple.com', 'r', false, $context); + fpassthru($fp); + fclose($fp); +?> +]]> + </programlisting> + </example> + <simpara> Voir aussi - <function>stream_context_set_params</function>. + <function>stream_context_set_params</function> et + la liste des gestionnaires avec des options de contexte + (<xref linkend="wrappers"/>). </simpara> </refsect1> </refentry> Index: phpdoc-fr/reference/stream/functions/stream-context-get-options.xml diff -u phpdoc-fr/reference/stream/functions/stream-context-get-options.xml:1.1 phpdoc-fr/reference/stream/functions/stream-context-get-options.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-context-get-options.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-context-get-options.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-context-get-options"> <refnamediv> <refname>stream_context_get_options</refname> @@ -8,7 +8,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>bool</type><methodname>stream_context_get_options</methodname> + <type>array</type><methodname>stream_context_get_options</methodname> <methodparam><type>resource</type><parameter>stream|context</parameter></methodparam> </methodsynopsis> <simpara> Index: phpdoc-fr/reference/stream/functions/stream-filter-append.xml diff -u phpdoc-fr/reference/stream/functions/stream-filter-append.xml:1.1 phpdoc-fr/reference/stream/functions/stream-filter-append.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-filter-append.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-filter-append.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-filter-append"> <refnamediv> <refname>stream_filter_append</refname> @@ -11,6 +11,7 @@ <type>bool</type><methodname>stream_filter_append</methodname> <methodparam><type>resource</type><parameter>stream</parameter></methodparam> <methodparam><type>string</type><parameter>filtername</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>read_write</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>params</parameter></methodparam> </methodsynopsis> <para> @@ -23,10 +24,67 @@ Pour ajouter un filtre au début de la liste, utilisez la fonction <function>stream_filter_prepend</function>. </para> - <note> + <para> + Par défaut, <function>stream_filter_prepend</function> va ajouter + le filtre à la liste de filtre de lecture si le fichier a été ouvert + en mode lecture (<literal>r</literal> et/ou <literal>+</literal>). Le + filtre sera aussi attaché à la liste des filtres de lecture + si le fichier a été ouvert en mode lecture (<literal>w</literal>, + <literal>a</literal> et/ou <literal>+</literal>). + <constant>STREAM_FILTER_READ</constant>, + <constant>STREAM_FILTER_WRITE</constant>, et/ou + <constant>STREAM_FILTER_ALL</constant> peuvent aussi être utilisées + dans le paramètre <parameter>read_write</parameter> pour contrôler + ce comportement. Voyez la fonction + <function>stream_filter_append</function> pour un exemple de l'utilisation + de ce paramètre. + </para> + <para> + <example> + <title>Contrôler l'application des filtres</title> + <programlisting role="php"> +<![CDATA[ +<?php +/* Open a test file for reading and writting */ +$fp = fopen("test.txt","rw"); + +/* Apply the ROT13 filter to the + * write filter chain, but not the + * read filter chain */ +stream_filter_append($fp, "string.rot13", STREAM_FILTER_WRITE); + +/* Write a simple string to the file + * it will be ROT13 transformed on the + * way out */ +fwrite($fp, "This is a test\n"); + +/* Back up to the beginning of the file */ +rewind($fp); + +/* Read the contents of the file back out. + * Had the filter been applied to the + * read filter chain as well, we would see + * the text ROT13ed back to its original state */ +fpassthru($fp); + +fclose($fp); + +/* Expected Output + --------------- + +Guvf vf n grfg + + */ +?> +]]> + </programlisting> + </example> + </para> + <note> + <title>Quand utiliser des filtres personnalisés</title> <simpara> <function>stream_register_filter</function> doit être appelé avant - <function>stream_filter_append</function> pour enregistrer le filtre + <function>stream_filter_prepend</function> pour enregistrer le filtre sous le nom de <parameter>filtername</parameter>. </simpara> </note> Index: phpdoc-fr/reference/stream/functions/stream-filter-prepend.xml diff -u phpdoc-fr/reference/stream/functions/stream-filter-prepend.xml:1.1 phpdoc-fr/reference/stream/functions/stream-filter-prepend.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-filter-prepend.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-filter-prepend.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-filter-prepend"> <refnamediv> <refname>stream_filter_prepend</refname> @@ -11,6 +11,7 @@ <type>bool</type><methodname>stream_filter_prepend</methodname> <methodparam><type>resource</type><parameter>stream</parameter></methodparam> <methodparam><type>string</type><parameter>filtername</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>read_write</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>params</parameter></methodparam> </methodsynopsis> <para> @@ -23,7 +24,23 @@ Pour ajouter un filtre à la fin de la liste, utilisez la fonction <function>stream_filter_prepend</function>. </para> + <para> + Par défaut, <function>stream_filter_prepend</function> va ajouter + le filtre à la liste de filtre de lecture si le fichier a été ouvert + en mode lecture (<literal>r</literal> et/ou <literal>+</literal>). Le + filtre sera aussi attaché à la liste des filtres de lecture + si le fichier a été ouvert en mode lecture (<literal>w</literal>, + <literal>a</literal> et/ou <literal>+</literal>). + <constant>STREAM_FILTER_READ</constant>, + <constant>STREAM_FILTER_WRITE</constant>, et/ou + <constant>STREAM_FILTER_ALL</constant> peuvent aussi être utilisées + dans le paramètre <parameter>read_write</parameter> pour contrôler + ce comportement. Voyez la fonction + <function>stream_filter_append</function> pour un exemple de l'utilisation + de ce paramètre. + </para> <note> + <title>Quand utiliser des filtres personnalisés</title> <simpara> <function>stream_register_filter</function> doit être appelé avant <function>stream_filter_prepend</function> pour enregistrer le filtre Index: phpdoc-fr/reference/stream/functions/stream-get-meta-data.xml diff -u phpdoc-fr/reference/stream/functions/stream-get-meta-data.xml:1.1 phpdoc-fr/reference/stream/functions/stream-get-meta-data.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-get-meta-data.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-get-meta-data.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-get-meta-data"> <refnamediv> <refname>stream_get_meta_data</refname> @@ -8,11 +8,11 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>array</type><methodname>file_get_meta_data</methodname> + <type>array</type><methodname>stream_get_meta_data</methodname> <methodparam><type>resource</type><parameter>stream</parameter></methodparam> </methodsynopsis> <simpara> - <methodname>file_get_meta_data</methodname> retourne les informations disponibles + <methodname>stream_get_meta_data</methodname> retourne les informations disponibles sur le flôt <parameter>stream</parameter>. Ce flôt peut être n'importe quel flôt créé par <function>fopen</function>, <function>fsockopen</function> et <function>pfsockopen</function>. Le tableau résultant peut contenir les Index: phpdoc-fr/reference/stream/functions/stream-register-filter.xml diff -u phpdoc-fr/reference/stream/functions/stream-register-filter.xml:1.1 phpdoc-fr/reference/stream/functions/stream-register-filter.xml:1.2 --- phpdoc-fr/reference/stream/functions/stream-register-filter.xml:1.1 Mon Jan 13 14:56:55 2003 +++ phpdoc-fr/reference/stream/functions/stream-register-filter.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.stream-register-filter"> <refnamediv> <refname>stream_register_filter</refname> @@ -8,7 +8,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>boolean</type><methodname>stream_register_filter</methodname> + <type>bool</type><methodname>stream_register_filter</methodname> <methodparam><type>string</type><parameter>filtername</parameter></methodparam> <methodparam><type>string</type><parameter>classname</parameter></methodparam> </methodsynopsis> @@ -34,76 +34,38 @@ </para> <methodsynopsis> - <type>int</type><methodname>write</methodname> - <methodparam><type>string</type><parameter>data</parameter></methodparam> + <type>int</type><methodname>filter</methodname> + <methodparam><type>resource</type><parameter>in</parameter></methodparam> + <methodparam><type>resource</type><parameter>out</parameter></methodparam> + <methodparam><type>int</type><parameter>&consumed</parameter></methodparam> + <methodparam><type>boolean</type><parameter>closing</parameter></methodparam> </methodsynopsis> <para> - Cette méthode est appelée dès que les données sont écrite dans le flôt, - comme avec la fonction <function>fwrite</function>. Après la modification - des données <parameter>data</parameter>, cette méthode doit utiliser la - ligne suivante <literal>return parent::write($data);</literal> - pour que le prochain filtre puisse s'exécuter. Lorsqu'il ne reste plus - de filtres, le flôt va écrire les données <parameter>data</parameter> - dans leur forme finale. - <note> - <para> - Si votre filtre modifie la taille de la chaîne <parameter>data</parameter>, - par exemple en supprimant le premier caractère, il faut, avant d'utiliser - la fonction <literal>parent::write($data);</literal>, s'assurer d'inclure - le caractère supprimé dans la valeur de retour. - </para> - </note> - <informalexample> - <programlisting role="php"> -<![CDATA[ -class myfilter extends php_user_filter { - function write($data) { - $data = substr($data,1); - $written_by_parent = parent::write($data); - return ($written_by_parent + 1); - } -} -]]> - </programlisting> - </informalexample> - </para> - - <methodsynopsis> - <type>string</type><methodname>read</methodname> - <methodparam><type>int</type><parameter>maxlength</parameter></methodparam> - </methodsynopsis> - <para> - Cette méthode est appelée dès que des données sont lues dans le flôt - (comme avec la fonction <function>fread</function>). Un filtre doit commencer - par utiliser la ligne <literal>parent::read($maxlength);</literal> pour - lire les données issue du filtre précédent. Ultimement, ce sera le - flôt qui lira les données. Votre filtre peut alors modifier cette - valeur et retourner la valeur finale. Votre filtre ne doit jamais - retourner plus de <parameter>maxlength</parameter> octets. - Comme <literal>parent::read($maxlength);</literal> ne retournera - aussi pas plus de <parameter>maxlength</parameter>, ce ne sera pas - un problème en règle général. Cependant, si votre filtre accroit la - taille des données retournées, il faut alors appeler cette ligne avec - <literal>parent::read($maxlength-$x);</literal> où <parameter>x</parameter> - est l'accroissement maximal de vos données. Alternativement, vous pouvez - bâtir un buffer de lecture dans votre classe. - </para> - - <methodsynopsis> - <type>int</type><methodname>flush</methodname> - <methodparam><type>bool</type><parameter>closing</parameter></methodparam> - </methodsynopsis> - <para> - Cette méthode est appelée en réponse à une requête de vidage des - buffers du flôt (comme avec la fonction <function>fflush</function> ou - <function>fclose</function>). Le paramètre <parameter>closing</parameter> - vous indique si le flôt est, en réalité, dans un processus de fermeture. - L'action par défaut est d'appeler simplement - <literal>return parent::flush($closing);</literal>, mais votre filtre - peut souhaiter exécuter des écritures supplémentaires, ou bien - nettoyer des ressources avant de réaliser le vidage en règle. - </para> - + Cette méthode est appelé à chaque fois que des données sont lues ou écrites + dans le flôt attaché (avec des fonctions comme <function>fread</function> ou + <function>fwrite</function>). Le paramètre <parameter>in</parameter> est une ressource + qui pointe sur une <literal>bucket brigade</literal> qui contient un ou plusieurs + objet <literal>bucket</literal> contenant les données à filtrer. + <parameter>out</parameter> est une autre ressource + qui pointe sur une <literal>bucket brigade</literal> + dans laquelle les donnée seront placées. + <parameter>consumed</parameter>, qui doit <emphasis>toujours</emphasis> + être déclaré par référence, doit être incrémenté de la taille de données que + votre filtre lit et modifie. Dans la plupart des cas, cela signifie que vous + devrez incrémenter <parameter>consumed</parameter> avec <literal>$bucket->datalen</literal> + pour chaque <literal>$bucket</literal>. + Si le flôt est en cours de fermeture (et par conséquent, cela sera le dernier + passage dans la chaîne de filtres), le paramètre <parameter>closing</parameter> + vaudra &true; La méthode <methodname>filter</methodname> doit retourner l'une + des trois valeurs suivantes : <constant>PSFS_PASS_ON</constant> indique la réussite, + et les données sont dans le paramètre <parameter>out</parameter>, une <literal>bucket brigade</literal>. + <constant>PSFS_FEED_ME</constant> indique que le filtre n'a aucune données à retourner, et + requiert d'autres données du flôt. + <constant>PSFS_ERR_FATAL</constant> indique que le flôt a rencontré une erreur + fatale, et ne peut continuer. Si aucune valeur n'est retournée par cette méthode, + <constant>PSFS_ERR_FATAL</constant> est utilisé. + </para> + <methodsynopsis> <type>void</type><methodname>oncreate</methodname> <void/> Index: phpdoc-fr/reference/stream/functions/stream-register-wrapper.xml diff -u phpdoc-fr/reference/stream/functions/stream-register-wrapper.xml:1.2 phpdoc-fr/reference/stream/functions/stream-register-wrapper.xml:1.3 --- phpdoc-fr/reference/stream/functions/stream-register-wrapper.xml:1.2 Mon Feb 3 07:48:42 2003 +++ phpdoc-fr/reference/stream/functions/stream-register-wrapper.xml Mon Apr 28 11:49:21 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <!-- splitted from ./en/functions/filesystem.xml, last change in rev 1.141 --> <refentry id="function.stream-register-wrapper"> <refnamediv> @@ -9,7 +9,7 @@ <refsect1> <title>Description</title> <methodsynopsis> - <type>boolean</type><methodname>stream_register_wrapper</methodname> + <type>bool</type><methodname>stream_register_wrapper</methodname> <methodparam><type>string</type><parameter>protocol</parameter></methodparam> <methodparam><type>string</type><parameter>classname</parameter></methodparam> </methodsynopsis> @@ -35,7 +35,7 @@ </para> <methodsynopsis> - <type>boolean</type><methodname>stream_open</methodname> + <type>bool</type><methodname>stream_open</methodname> <methodparam><type>string</type><parameter>path</parameter></methodparam> <methodparam><type>string</type><parameter>mode</parameter></methodparam> <methodparam><type>int</type><parameter>options</parameter></methodparam> @@ -140,7 +140,7 @@ </para> <methodsynopsis> - <type>boolean</type><methodname>stream_eof</methodname> + <type>bool</type><methodname>stream_eof</methodname> <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> @@ -161,7 +161,7 @@ </para> <methodsynopsis> - <type>boolean</type><methodname>stream_seek</methodname> + <type>bool</type><methodname>stream_seek</methodname> <methodparam><type>int</type><parameter>offset</parameter></methodparam> <methodparam><type>int</type><parameter>whence</parameter></methodparam> </methodsynopsis> @@ -176,7 +176,7 @@ </para> <methodsynopsis> - <type>boolean</type><methodname>stream_flush</methodname> + <type>bool</type><methodname>stream_flush</methodname> <methodparam><type>void</type><parameter></parameter></methodparam> </methodsynopsis> <para> Index: phpdoc-fr/reference/stream/functions/stream-copy-to-stream.xml +++ phpdoc-fr/reference/stream/functions/stream-copy-to-stream.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-copy-to-stream"> <refnamediv> <refname>stream_copy_to_stream</refname> <refpurpose>Copie des données depuis un flôt vers un autre</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>int</type><methodname>stream_copy_to_stream</methodname> <methodparam><type>resource</type><parameter>source</parameter></methodparam> <methodparam><type>resource</type><parameter>dest</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>maxlength</parameter></methodparam> </methodsynopsis> <para> <function>stream_copy_to_stream</function> copie jusqu'à <parameter>maxlength</parameter> octets de données depuis la position courante du pointeur dans le flôt <parameter>source</parameter> vers le paramètre <parameter>dest</parameter>. Si <parameter>maxlength</parameter> n'est pas spécifié, tout le reste du flôt <parameter>source</parameter> sera copié. will be copied. <function>stream_copy_to_stream</function> retourne le total d'octets copié. <example> <title>Exemple avec <function>stream_copy_to_stream</function></title> <programlisting role="php"> <![CDATA[ <?php $src = fopen('http://www.exemple.com','r'); $dest1 = fopen('first1k.txt','w'); $dest2 = fopen('remainder.txt','w'); print stream_copy_to_stream($src, $dest1, 1024) . " octets copiés vers first1k.txt\n"; print stream_copy_to_stream($src, $dest2) . " octets copiés vers remainder.txt\n"; ?> ]]> </programlisting> </example> </para> <para> Voir aussi <function>copy</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/stream/functions/stream-get-line.xml +++ phpdoc-fr/reference/stream/functions/stream-get-line.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-get-line"> <refnamediv> <refname>stream_get_line</refname> <refpurpose>Lit une ligne dans un flôt</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>stream_get_line</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> <methodparam><type>int</type><parameter>length</parameter></methodparam> <methodparam><type>string</type><parameter>ending</parameter></methodparam> </methodsynopsis> <para> <function>stream_get_line</function> lit une ligne de taille maximale <parameter>length</parameter> dans le flôt <parameter>handle</parameter>. La lecture se termine lorsque <parameter>length</parameter> ont été lus, ou que la chaîne <parameter>ending</parameter> est trouvée dans le flôt (et qui <emphasis>n'est pas</emphasis> inclue dans la valeur retournée), ou la fin du fichier (le premier des trois). </para> <para> Si une erreur survient, <function>stream_get_line</function> retourne &false;. </para> <simpara> <function>stream_get_line</function> est presque identique à <function>fgets</function> hormis le fait qu'elle autorise d'autres délimiteur de fin de ligne que <literal>\n</literal>, <literal>\r</literal> et <literal>\r\n</literal>, et <emphasis>ne retourne pas</emphasis> le délimiteur lui-même. </simpara> <para> Voir aussi <function>fread</function>, <function>fgets</function> et <function>fgetc</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/stream/functions/stream-get-transports.xml +++ phpdoc-fr/reference/stream/functions/stream-get-transports.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-get-transports"> <refnamediv> <refname>stream_get_transports</refname> <refpurpose>Liste les gestionnaires de transports de sockets disponibles</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>array</type><methodname>stream_get_transports</methodname> <void/> </methodsynopsis> <simpara> <function>stream_get_transports</function> retourne un tableau indexé contenant les noms des transports de sockets disponibles pour le système. </simpara> <para> <example> <title>Exemple avec <function>stream_get_transports</function></title> <programlisting role="php"> <![CDATA[ <?php $xportlist = stream_get_transports(); print_r($xportlist); /* L'affichage ne sera jamais identique au suivant Note: Il peut y avoir plus ou moins de transports dans votre version de PHP --------------------------------------- Array ( [0] => tcp [1] => udp [2] => unix [3] => udg ) */ ?> ]]> </programlisting> </example> </para> <para> Voir aussi <function>stream_get_filters</function>, et <function>stream_get_wrappers</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/stream/functions/stream-socket-accept.xml +++ phpdoc-fr/reference/stream/functions/stream-socket-accept.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-socket-accept"> <refnamediv> <refname>stream_socket_accept</refname> <refpurpose> Accepte une connexion sur une socket créée par <function>stream_socket_server</function> </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>resource</type><methodname>stream_socket_accept</methodname> <methodparam><type>resource</type><parameter>server_socket</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>&peername</parameter></methodparam> </methodsynopsis> <para> <function>stream_socket_accept</function> accepte une connexion sur une socket créée précédemment avec <function>stream_socket_server</function>. Si <parameter>timeout</parameter> est spécifié, le délai d'expiration de la socket sera remplacé par cette valeur, exprimée en secondes. L'adresse du client qui est connecté est retourné dans <parameter>peername</parameter>, si cette valeur est accessible pour ce type de transport. </para> <simpara> <parameter>peername</parameter> peut aussi être déterminé plus tard avec <function>stream_socket_get_name</function>. </simpara> <simpara> Si <function>stream_socket_accept</function> échoue, elle retournera &false;. </simpara> <para> Voir aussi <function>stream_socket_server</function>, <function>stream_socket_get_name</function>, <function>stream_set_blocking</function>, <function>stream_set_timeout</function>, <function>fgets</function>, <function>fgetss</function>, <function>fputs</function>, <function>fclose</function>, <function>feof</function> et l'<link linkend="ref.curl">extension CURL</link>. </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/stream/functions/stream-socket-client.xml +++ phpdoc-fr/reference/stream/functions/stream-socket-client.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-socket-client"> <refnamediv> <refname>stream_socket_client</refname> <refpurpose> Ouvre une connexion socket Internet ou Unix </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>resource</type><methodname>stream_socket_client</methodname> <methodparam><type>string</type><parameter>remote_socket</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>&errno</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>&errstr</parameter></methodparam> <methodparam choice="opt"><type>float</type><parameter>timeout</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam> </methodsynopsis> <para> <function>stream_socket_client</function> initie un flôt ou une connexion datagramme avec la destination <parameter>remote_socket</parameter>. Le type de socket créé est déterminé par le transport spécifié avec le formattage URL suivant : <literal>transport://target</literal>. Pour une socket Internet, (<constant>AF_INET</constant>) comme TCP et UDP, la <literal>cible</literal> de <parameter>remote_socket</parameter> sera une adresse IP ou un nom d'hôte. Pour une socket Unix,la <literal>cible</literal> doit être un fichier de socket du système. </para> <para> Le paramètre optionnel <parameter>timeout</parameter> sert à imposer un délai d'expiration, en secondes, à l'appel système. </para> <para> <parameter>flags</parameter> est un champs de bits qui peut être la combinaison de n'importe quelle option de connexion. Actuellement, les valeurs possibles pour ces options sont <constant>STREAM_CLIENT_ASYNC_CONNECT</constant> et <constant>STREAM_CLIENT_PERSISTENT</constant>. </para> <note> <simpara> Si vous n'avez pas besoin de mettre de délai d'expiration pour les opérations via la socket, utilisez la fonction <function>stream_set_timeout</function>, car <parameter>timeout</parameter> de <function>stream_socket_client</function> ne s'appliqu que lors de la connexion à la socket. </simpara> </note> <para> <function>stream_socket_client</function> retourne une ressource de flôt, qui peut être utilisée avec d'autres fonctions de fichiers, comme <function>fgets</function>, <function>fgetss</function>, <function>fputs</function>, <function>fclose</function> et <function>feof</function>). </para> <para> Si l'appel échoue, <function>stream_socket_client</function> va retourner &false; et si les paramètres optionnels <parameter>errno</parameter> et <parameter>errstr</parameter> sont fournis, ils recevront l'erreur exacte qui est survenue dans le système lors de l'appel à <literal>connect()</literal>. Si la valeur retournée dans <parameter>errno</parameter> est <literal>0</literal> et que la fonction a retournée &false;, c'est une indication que l'erreur est survenue avant l'appel à <literal>connect()</literal>. Cela est probablement du à un problème d'initialisation de la socket. Notez que <parameter>errno</parameter> et<parameter>errstr</parameter> doivent être passé par référence. </para> <para> Suivant votre environnement, les sockets Unix ou le délai d'expiration peuvent ne pas être disponibles. Une liste des transports disponibles qui sont disponibles sur le système est accessible via <function>stream_get_transports</function>. </para> <para> Le flôt sera par défaut ouvert en mode bloquant. Vous pouvez le passer en mode non bloquant en utilisant la fonction <function>stream_set_blocking</function>. <example> <title>Exemple avec <function>stream_socket_client</function></title> <programlisting role="php"> <![CDATA[ <?php $fp = stream_socket_client("tcp://www.exemple.com:80", $errno, $errstr, 30); if (!$fp) { echo "$errstr ($errno)<br>\n"; } else { fputs ($fp, "GET / HTTP/1.0\r\nHost: www.example.com\r\nAccept: */*\r\n\r\n"); while (!feof($fp)) { echo fgets ($fp,1024); } fclose ($fp); } ?> ]]> </programlisting> </example> L'exemple ci-dessous vous montre comment lire la date et l'heure sur un service UDP de type "daytime" (port 13) sur votre propre machine : <example> <title>Utilisation de connexions UDP</title> <programlisting role="php"> <![CDATA[ <?php $fp = stream_socket_client("udp://127.0.0.1:13", $errno, $errstr); if (!$fp) { echo "ERREIR : $errno - $errstr<br>\n"; } else { fwrite($fp,"\n"); echo fread($fp, 26); fclose($fp); } ?> ]]> </programlisting> </example> <warning> <simpara> Les sockets UDP sembleront parfois s'ouvrir sans erreur, même si l'hôte distant n'est pas accessible. Cette erreur ne deviendra apparente que lorsque vous essaierez de lire ou écrire des données avec cette socket. La raison à cela est que UDP est un protocole sans connexion, ce qui signifie que le système d'exploitaiton n'a pas à établir de lien pour la socket, jusqu'à ce qu'il commence à échanger des données. </simpara> </warning> &ipv6.brackets; Voir aussi <function>stream_socket_server</function>, <function>stream_set_blocking</function>, <function>stream_set_timeout</function>, <function>fgets</function>, <function>fgetss</function>, <function>fputs</function>, <function>fclose</function>, <function>feof</function> et l'<link linkend="ref.curl">extension CURL</link>. </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/stream/functions/stream-socket-get-name.xml +++ phpdoc-fr/reference/stream/functions/stream-socket-get-name.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-socket-get-name"> <refnamediv> <refname>stream_socket_get_name</refname> <refpurpose>Lit le nom des sockets locale ou distante</refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>string</type><methodname>stream_socket_get_name</methodname> <methodparam><type>resource</type><parameter>handle</parameter></methodparam> <methodparam><type>boolean</type><parameter>want_peer</parameter></methodparam> </methodsynopsis> <para> <function>stream_socket_get_name</function> retourne le nom de la socket locale ou distante pour la connexion <parameter>handle</parameter>. Si <parameter>want_peer</parameter> vaut &true;, le nom de la socket distante est retourné. Si il vaut &false;, c'est le nom de la socket locale. </para> <para> Voir aussi <function>stream_socket_accept</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/stream/functions/stream-socket-server.xml +++ phpdoc-fr/reference/stream/functions/stream-socket-server.xml <?xml version="1.0" encoding="iso-8859-1"?> <!-- $Revision: 1.1 $ --> <refentry id="function.stream-socket-server"> <refnamediv> <refname>stream_socket_server</refname> <refpurpose> Crée une socket serveur Unix ou Internet </refpurpose> </refnamediv> <refsect1> <title>Description</title> <methodsynopsis> <type>resource</type><methodname>stream_socket_server</methodname> <methodparam><type>string</type><parameter>local_socket</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>&errno</parameter></methodparam> <methodparam choice="opt"><type>string</type><parameter>&errstr</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> <methodparam choice="opt"><type>resource</type><parameter>context</parameter></methodparam> </methodsynopsis> <para> <function>stream_socket_server</function> crée un flôt ou un datagramme sur la socket spécifiée <parameter>local_socket</parameter>. Le type de socket créé est déterminé par le transport spécifié avec le formattage URL suivant : <literal>transport://target</literal>. Pour une socket Internet, (<constant>AF_INET</constant>) comme TCP et UDP, la <literal>cible</literal> de <parameter>remote_socket</parameter> sera une adresse IP ou un nom d'hôte. Pour une socket Unix,la <literal>cible</literal> doit être un fichier de socket du système. </para> <para> <parameter>flags</parameter> est un champs de bits qui peut être la combinaison de n'importe quelle option de connexion. Actuellement, les valeurs possibles pour ces options sont <constant>STREAM_CLIENT_ASYNC_CONNECT</constant> et <constant>STREAM_CLIENT_PERSISTENT</constant>. La valeur par défaut est <constant>STREAM_SERVER_BIND</constant> | <constant>STREAM_SERVER_LISTEN</constant>. <para> <function>stream_socket_server</function> ne fait que créer une socket, et pour accepter des connexions, vous devez utiliser <function>stream_socket_accept</function>. </para> <para> Si l'appel échoue, <function>stream_socket_server</function> va retourner &false; et si les paramètres optionnels <parameter>errno</parameter> et <parameter>errstr</parameter> sont fournis, ils recevront l'erreur exacte qui est survenue dans le système lors de l'appel à <literal>connect()</literal>. Si la valeur retournée dans <parameter>errno</parameter> est <literal>0</literal> et que la fonction a retournée &false;, c'est une indication que l'erreur est survenue avant l'appel à <literal>connect()</literal>. Cela est probablement du à un problème d'initialisation de la socket. Notez que <parameter>errno</parameter> et<parameter>errstr</parameter> doivent être passé par référence. </para> <para> Suivant votre environnement, les sockets Unix ou le délai d'expiration peuvent ne pas être disponibles. Une liste des transports disponibles qui sont disponibles sur le système est accessible via <function>stream_get_transports</function>. </para> <para> <example> <title>Exemple avec <function>stream_socket_server</function></title> <programlisting role="php"> <![CDATA[ <?php $socket = stream_socket_server("tcp://0.0.0.0:8000", $errno, $errstr); if (!$socket) { echo "$errstr ($errno)<br>\n"; } else { while ($conn = stream_socket_accept($socket)) { fputs ($conn, 'Merci de vous connecter à mon serveur. L\'heure locale est ' . date('n/j/Y g:i a') . "\n"); fclose ($conn); } fclose($socket); } ?> ]]> </programlisting> </example> L'exemple ci-dessous vous montre comment lire la date et l'heure sur un service UDP de type "daytime" (port 13) sur votre propre machine, tel que présenté avec la fonction <function>stream_socket_client</function> : <note> <simpara>La plupart des systèmes ont besoin d'un accès administrateur pour ouvrir une socket au dela des ports 1024. </simpara> </note> <example> <title>Utiliser un serveur de socket UDP</title> <programlisting role="php"> <![CDATA[ <?php $socket = stream_socket_server("udp://0.0.0.0:13", $errno, $errstr); if (!$socket) { echo "ERROR: $errno - $errstr<br>\n"; } else { while ($conn = stream_socket_accept($socket)) { fwrite($conn, date("D M j H:i:s Y\r\n")); fclose($conn); } fclose($socket); } ?> ]]> </programlisting> </example> &ipv6.brackets; Voir aussi <function>stream_socket_client</function>, <function>stream_set_blocking</function>, <function>stream_set_timeout</function>, <function>fgets</function>, <function>fgetss</function>, <function>fputs</function>, <function>fclose</function>, <function>feof</function> et l'<link linkend="ref.curl">extension CURL</link>. </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 -->