# php_manual

id: eio_nop
type: function
doc:
<comment>Description:</comment>
  Ne fait rien, mis à part le fait de parcourir l'ensemble du cycle des requêtes
  
  <strong>eio_nop()</strong> ne fait rien, mis à part le fait de parcourir l'ensemble du cycle des requêtes. Peut
  être utile pour le débogage.

<comment>Param:</comment>
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_nop()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.

<comment>See Also:</comment>
   * <strong>eio_busy()</strong>


id: eio_npending
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de requêtes terminées
  
  <strong>eio_npending()</strong> retourne le nombre de requêtes terminées.

<comment>Return:</comment>
  <info>int</info>  <strong>eio_npending()</strong> retourne le nombre de requêtes terminées.

<comment>See Also:</comment>
   * <strong>eio_nreqs()</strong>
   * <strong>eio_nready()</strong>
   * <strong>eio_nthreads()</strong>


id: eio_nready
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de requêtes pas encore gérées

<comment>Return:</comment>
  <info>int</info>  <strong>eio_nready()</strong> retourne le nombre de requêtes pas encore gérées.

<comment>See Also:</comment>
   * <strong>eio_nreqs()</strong>
   * <strong>eio_nready()</strong>
   * <strong>eio_nthreads()</strong>


id: eio_nreqs
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de requêtes restant à exécuter
  
  <strong>eio_nreqs()</strong> peut être appelée dans une boucle personnalisée appelant la fonction <strong>eio_poll()</strong>.

<comment>Return:</comment>
  <info>int</info>  <strong>eio_nreqs()</strong> retourne le nombre de requêtes restant à exécuter.

<comment>See Also:</comment>
   * <strong>eio_poll()</strong>
   * <strong>eio_nready()</strong>


id: eio_nthreads
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de threads actuellement utilisés

<comment>Return:</comment>
  <info>int</info>  <strong>eio_nthreads()</strong> retourne le nombre de threads actuellement utilisés.

<comment>See Also:</comment>
   * <strong>eio_npending()</strong>
   * <strong>eio_nready()</strong>
   * <strong>eio_nreqs()</strong>
   * <strong>eio_set_max_idle()</strong>
   * <strong>eio_set_max_parallel()</strong>
   * <strong>eio_set_min_parallel()</strong>


id: eio_open
type: function
doc:
<comment>Description:</comment>
  Ouvre un fichier
  
  <strong>eio_open()</strong> ouvre un fichier spécifié par l'argument <strong>$path</strong> avec le mode d'accès spécifié par
  l'argument<strong>$mode</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Chemin vers le fichier à ouvrir.  Avec quelques APIs (i.e. PHP-FPM), l'appel
                       peut échouer si vous ne spécifiez pas le chemin complet.
                       
                       Avec quelques APIs (i.e. PHP-FPM), l'appel peut échouer si vous ne spécifiez
                       pas le chemin complet.
  <info>int</info>       <strong>$flags</strong>     Une constante parmi les constants EIO_O_*, ou bien une combinaison de ces
                       constantes. Les constantes EIO_O_* ont la même signification que les
                       constantes correspondantes O_* définies dans le fichier d'en-têtes C <return>fnctl.h</return>.
                       Par défaut, vaut <info>EIO_O_RDWR</info>.
  <info>int</info>       <strong>$mode</strong>      Une constante parmi les constantes EIO_S_I*, ou bien une combinaison de ces
                       constantes (via l'opérateur OR). Les constantes ont la même signification que
                       les constantes correspondantes S_I* définies dans le fichier d'en-têtes C
                       sys/stat.h. Requis si un fichier est créé. Sinon, il sera ignoré.
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_open()</strong> retourne un descripteur de fichier dans l'argument <strong>$result</strong> de la fonction de
            rappel <strong>$callback</strong> en cas de succès ; sinon, <strong>$result</strong> vaudra <info>-1</info>.

<comment>See Also:</comment>
   * <strong>eio_mknod()</strong>


id: eio_poll
type: function
doc:
<comment>Description:</comment>
  Vérifie s'il reste des requêtes en cours d'exécution
  
  <strong>eio_poll()</strong> peut être utilisé pour implémenter une boucle d'événements spéciale. Pour ceci, la
  fonction <strong>eio_nreqs()</strong> peut être utilisée pour tester s'il reste des requêtes à exécuter.
  
  Applicable uniquement lors de l'implémentation d'une boucle d'événements dans l'espace
  utilisateur.

<comment>Return:</comment>
  <info>int</info>  Si une des invocations retourne une valeur différente de zéro, cette valeur sera retournée.
       Sinon, la fonction retournera <info>0</info>.

<comment>See Also:</comment>
   * <strong>eio_nreqs()</strong>


id: eio_read
type: function
doc:
<comment>Description:</comment>
  Lit un descripteur de fichier à une position donnée
  
  <strong>eio_read()</strong> lit  <strong>$length</strong> octets depuis le descripteur de fichier <strong>$fd</strong> à la position <strong>$offset</strong>. Les
  octets lus sont stockés dans l'argument <strong>$result</strong> de la fonction de rappel <strong>$callback</strong>.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        Un flux, une ressource de socket, ou un descripteur de fichier
  <info>int</info>       <strong>$length</strong>    Nombre maximal d'octets à lire.
  <info>int</info>       <strong>$offset</strong>    Position dans le fichier.
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_read()</strong> stocke les octets lus dans l'argument <strong>$result</strong> de la fonction de rappel
            <strong>$callback</strong>.

<comment>See Also:</comment>
   * <strong>eio_open()</strong>
   * <strong>eio_write()</strong>
   * <strong>eio_close()</strong>
   * <strong>eio_event_loop()</strong>


id: eio_readahead
type: function
doc:
<comment>Description:</comment>
  Effectue un readahead sur le fichier dans le cache d'une page
  
  <strong>eio_readahead()</strong> peuple le cache de la page avec les données d'un fichier faisant que les prochains
  appels à la lecture de ce fichier ne bloquera pas l'I/O du disque. Voir la page du manuel sur
  <return>READAHEAD(2)</return> pour plus de détails.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        Un flux, une ressource de socket ou un descripteur de fichier.
  <info>int</info>       <strong>$offset</strong>    Point de départ à partir de laquelle les données seront lues.
  <info>int</info>       <strong>$length</strong>    Nombre d'octets à lire.
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_readahead()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.


id: eio_readdir
type: function
doc:
<comment>Description:</comment>
  Lit le contenu d'un dossier
  
  Lit le contenu complet d'un dossier (via les appels systèmes <return>opendir</return>, <return>readdir</return> et <return>closedir</return>) et
  retourne soit les noms, soit un tableau suivant la valeur de l'argument <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Chemin du dossier.
  <info>int</info>       <strong>$flags</strong>     Combinaison de constantes EIO_READDIR_*.
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>string</info>    <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>string</info>    <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_readdir()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient. Définissez l'argument <strong>$result</strong> de la fonction de rappel <strong>$callback</strong> suivant le
            drapeau <strong>$flags</strong> utilisé :
            
            <info>EIO_READDIR_DENTS</info> (entier)  Drapeau pour <strong>eio_readdir()</strong>. Si spécifié, l'argument de
            résultat de la fonction de rappel devient un tableau contenant les clés suivantes :
            <return>'names'</return> - tableau de noms de dossiers <return>'dents'</return> - tableau de <return>struct eio_dirent</return> - comme un
            tableau, mais contenant les clés spécifiques suivantes : <return>'name'</return> - le nom du dossier ;
            <return>'type'</return> - une des constantes EIO_DT_* ; <return>'inode'</return> - le numbre d'inodes, si disponible,
            sinon ne sera pas spécifié ; <info>EIO_READDIR_DIRS_FIRST</info> (entier)  Lorsque ce drapeau est
            spécifié, les noms seront retournés dans un ordre où les dossiers arrivent en premier,
            et ensuite dans un ordre de statut optimal. <info>EIO_READDIR_STAT_ORDER</info> (entier)  Lorsque ce
            drapeau est spécifié, alors les noms seront retournés dans un ordre suivant le statut
            <return>stat</return> de chaque nœud. Si vous avez prévu d'appliquer la fonction <strong>stat()</strong> a tous les
            fichiers du dossier, il vous sera plus rapide d'utiliser ce drapeau.
            <info>EIO_READDIR_FOUND_UNKNOWN</info> (entier)
            
            Drapeau pour <strong>eio_readdir()</strong>. Si spécifié, l'argument de résultat de la fonction de rappel
            devient un tableau contenant les clés suivantes : <return>'names'</return> - tableau de noms de dossiers
            <return>'dents'</return> - tableau de <return>struct eio_dirent</return> - comme un tableau, mais contenant les clés
            spécifiques suivantes : <return>'name'</return> - le nom du dossier ; <return>'type'</return> - une des constantes
            EIO_DT_* ; <return>'inode'</return> - le numbre d'inodes, si disponible, sinon ne sera pas spécifié ;
            
            Lorsque ce drapeau est spécifié, les noms seront retournés dans un ordre où les dossiers
            arrivent en premier, et ensuite dans un ordre de statut optimal.
            
            Lorsque ce drapeau est spécifié, alors les noms seront retournés dans un ordre suivant
            le statut <return>stat</return> de chaque nœud. Si vous avez prévu d'appliquer la fonction <strong>stat()</strong> a tous
            les fichiers du dossier, il vous sera plus rapide d'utiliser ce drapeau.
            
            Types de nœud : <info>EIO_DT_UNKNOWN</info> (entier)  Un nœud de type inconnu (souvent le cas). Une
            utilisation de la fonction <strong>stat()</strong> est nécessaire. <info>EIO_DT_FIFO</info> (entier)  Un nœud de type
            FIFO <info>EIO_DT_CHR</info> (entier)  Type de nœud <info>EIO_DT_MPC</info> (entier)  Un nœud de type périphérique
            à caractères multiplexés (v7+coherent) <info>EIO_DT_DIR</info> (entier)  Un nœud de type dossier
            <info>EIO_DT_NAM</info> (entier)  Un nœud de type fichier nommé spécialement Xenix <info>EIO_DT_BLK</info>
            (entier)  Type de nœud <info>EIO_DT_MPB</info> (entier)  Bloc multiplexé du périphérique
            (v7+coherent) <info>EIO_DT_REG</info> (entier)  Type de nœud <info>EIO_DT_NWK</info> (entier)  <info>EIO_DT_CMP</info> (entier)
            Un nœud de type spécial du réseau HP-UX <info>EIO_DT_LNK</info> (entier)  Un nœud de type lien
            <info>EIO_DT_SOCK</info> (entier)  Un nœud de type socket <info>EIO_DT_DOOR</info> (entier)  Un nœud de type
            Solaris door <info>EIO_DT_WHT</info> (entier)  Type de nœud <info>EIO_DT_MAX</info> (entier)  Valeur de type de
            nœud le plus haut possible
            
            Un nœud de type inconnu (souvent le cas). Une utilisation de la fonction <strong>stat()</strong> est
            nécessaire.
            
            Un nœud de type FIFO
            
            Type de nœud
            
            Un nœud de type périphérique à caractères multiplexés (v7+coherent)
            
            Un nœud de type dossier
            
            Un nœud de type fichier nommé spécialement Xenix
            
            Type de nœud
            
            Bloc multiplexé du périphérique (v7+coherent)
            
            Type de nœud
            
            Un nœud de type spécial du réseau HP-UX
            
            Un nœud de type lien
            
            Un nœud de type socket
            
            Un nœud de type Solaris door
            
            Type de nœud
            
            Valeur de type de nœud le plus haut possible


id: eio_readlink
type: function
doc:
<comment>Description:</comment>
  Lit la valeur d'un lien symbolique

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Chemin source du lien symbolique
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_readlink()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.

<comment>See Also:</comment>
   * <strong>eio_symlink()</strong>


id: eio_realpath
type: function
doc:
<comment>Description:</comment>
  Récupère le nom du chemin absolu canonisé
  
  <strong>eio_realpath()</strong> retourne le nom du chemin absolu canonisé dans l'argument <strong>$result</strong> de la fonction de
  rappel <strong>$callback</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Nom du chemin en version courte.
  <info>int</info>       <strong>$pri</strong>       
  <info>callable</info>  <strong>$callback</strong>  
  <info>string</info>    <strong>$data</strong>      

<comment>Return:</comment>
  <info>resource</info>  


id: eio_rename
type: function
doc:
<comment>Description:</comment>
  Modifie le nom ou le chemin d'un fichier
  
  <strong>eio_rename()</strong> renomme ou déplace un fichier vers un nouvel endroit.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Chemin source
  <info>string</info>    <strong>$new_path</strong>  Chemin cible
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_rename()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.


id: eio_rmdir
type: function
doc:
<comment>Description:</comment>
  Supprime un dossier
  
  <strong>eio_rmdir()</strong> supprime un dossier.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Chemin du dossier
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_rmdir()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.

<comment>See Also:</comment>
   * <strong>eio_mkdir()</strong>


id: eio_seek
type: function
doc:
<comment>Description:</comment>
  Repositionne le curseur d'un fichier ouvert
  
  <strong>eio_seek()</strong> repositionne le curseur du fichier ouvert spécifié par l'argument <strong>$fd</strong> (qui peut être un
  flux, une ressource de socket ou un descripteur de fichier) à la position <strong>$offset</strong> suivant la
  directive <strong>$whence</strong> comme suit : <info>EIO_SEEK_SET</info> - Définit la position à <strong>$offset</strong> octets.<info>EIO_SEEK_CUR</info> -
  Définit la position à la position courante, plus <strong>$offset</strong>.<info>EIO_SEEK_END</info> - Définit la position à la
  fin du fichier, plus <strong>$offset</strong>.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        Un flux, une ressource de socket, ou un descripteur de fichier numérique
  <info>int</info>       <strong>$offset</strong>    Point de départ depuis lequel les données vont commencer à être lues.
  <info></info>          <strong>$length</strong>    Nombre d'octets à lire.
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variable arbitraire à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_seek()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.


id: eio_sendfile
type: function
doc:
<comment>Description:</comment>
  Transfère des données entre des descripteurs de fichiers
  
  <strong>eio_sendfile()</strong> copie des données entre un descripteur de fichier et un autre. Voir la page du
  manuel sur <return>SENDFILE(2)</return> pour plus de détails.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$out_fd</strong>    Flux, ressource de socket, ou descripteur de fichier pour la sortie. Doit
                       être ouvert en écriture.
  <info>mixed</info>     <strong>$in_fd</strong>     Flux, ressource de socket, ou descripteur de fichier pour l'entrée. Doit être
                       ouvert en lecture.
  <info>int</info>       <strong>$offset</strong>    Position dans le fichier source.
  <info>int</info>       <strong>$length</strong>    Nombre d'octets à copier.
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>string</info>    <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>string</info>    <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_sendfile()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.


id: eio_set_max_idle
type: function
doc:
<comment>Description:</comment>
  Définit le nombre maximal de threads inactifs

<comment>Param:</comment>
  <info>int</info>  <strong>$nthreads</strong>  Nombre de threads inactifs.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.

<comment>See Also:</comment>
   * <strong>eio_nthreads()</strong>
   * <strong>eio_set_min_parallel()</strong>
   * <strong>eio_set_max_parallel()</strong>


id: eio_set_max_parallel
type: function
doc:
<comment>Description:</comment>
  Définit le nombre maximal de threads en parallèle

<comment>Param:</comment>
  <info>int</info>  <strong>$nthreads</strong>  Nombre de threads en parallèle

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.

<comment>See Also:</comment>
   * <strong>eio_nthreads()</strong>
   * <strong>eio_set_max_idle()</strong>
   * <strong>eio_set_min_parallel()</strong>


id: eio_set_max_poll_reqs
type: function
doc:
<comment>Description:</comment>
  Définit le nombre maximal de requêtes à exécuter dans une file d'attente

<comment>Param:</comment>
  <info>int</info>  <strong>$nreqs</strong>  Nombre de requêtes

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.


id: eio_set_max_poll_time
type: function
doc:
<comment>Description:</comment>
  Définit la durée maximale de la file d'attente
  
  La file d'attente s'interrompt si elle prend plus de <strong>$nseconds</strong> secondes.

<comment>Param:</comment>
  <info>float</info>  <strong>$nseconds</strong>  Nombre de secondes

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.


id: eio_set_min_parallel
type: function
doc:
<comment>Description:</comment>
  Définit le nombre minimum de threads parallèles

<comment>Param:</comment>
  <info>string</info>  <strong>$nthreads</strong>  Nombre de threads en parallèle.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.

<comment>See Also:</comment>
   * <strong>eio_nthreads()</strong>
   * <strong>eio_set_max_idle()</strong>
   * <strong>eio_set_max_parallel()</strong>


id: eio_stat
type: function
doc:
<comment>Description:</comment>
  Récupère le statut d'un fichier
  
  <strong>eio_stat()</strong> retourne les informations de statut d'un fichier dans l'argument <strong>$result</strong> de la fonction
  de rappel <strong>$callback</strong>

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Le chemin vers le fichier
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_stat()</strong> retourne une ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient. En cas de succès, l'argument <strong>$result</strong> de la fonction de rappel <strong>$callback</strong>
            recevra les données sous la forme d'un tableau.

<comment>See Also:</comment>
   * <strong>eio_lstat()</strong>
   * <strong>eio_fstat()</strong>


id: eio_statvfs
type: function
doc:
<comment>Description:</comment>
  Récupère les statistiques du système de fichiers
  
  <strong>eio_statvfs()</strong> retourne les informations quant aux statistiques du système de fichiers dans
  l'argument <strong>$result</strong> de la fonction de rappel <strong>$callback</strong>

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Nom du chemin d'un fichier contenu dans le système de fichiers monté
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_statvfs()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient. En cas de succès, l'argument <strong>$result</strong> de la fonction de rappel <strong>$callback</strong>
            recevra les données sous la forme d'un tableau.


id: eio_symlink
type: function
doc:
<comment>Description:</comment>
  Crée un lien symbolique
  
  <strong>eio_symlink()</strong> crée un lien symbolique <strong>$new_path</strong> vers le chemin <strong>$path</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Chemin source
  <info>string</info>    <strong>$new_path</strong>  Chemin cible
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_symlink()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.

<comment>See Also:</comment>
   * <strong>eio_link()</strong>


id: eio_sync
type: function
doc:
<comment>Description:</comment>
  Valide le cache du buffer sur le disque

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_sync()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.


id: eio_sync_file_range
type: function
doc:
<comment>Description:</comment>
  Synchronise un segment de fichier avec le disque
  
  <strong>eio_sync_file_range()</strong> permet un contrôle fin lors de la synchronisation d'un fichier ouvert
  spécifié par le descripteur de fichier <strong>$fd</strong> avec le disque.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        Le descripteur de fichier.
  <info>int</info>       <strong>$offset</strong>    La position de début d'intervalle à partir de laquelle la synchronisation
                       doit s'effectuer.
  <info>int</info>       <strong>$nbytes</strong>    Spécifie la longueur de l'intervalle à synchroniser, en octets. Si <strong>$nbytes</strong>
                       vaut zéro, alors tous les octets depuis la position <strong>$offset</strong> jusqu'à la fin du
                       fichier seront synchronisés.
  <info>int</info>       <strong>$flags</strong>     Un masque. Peut inclure n'importe quelle valeur suivante :
                       <info>EIO_SYNC_FILE_RANGE_WAIT_BEFORE</info>, <info>EIO_SYNC_FILE_RANGE_WRITE</info>,
                       <info>EIO_SYNC_FILE_RANGE_WAIT_AFTER</info>. Ces drapeaux ont la même signification que
                       leurs équivalents SYNC_FILE_RANGE_* (voir la page du manuel sur
                       <return>SYNC_FILE_RANGE(2)</return>).
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_sync_file_range()</strong> retourne la ressource demandée, en cas de succès, ou <info>false</info> si une
            erreur survient.


id: eio_syncfs
type: function
doc:
<comment>Description:</comment>
  Appel la fonction système Linux syncfs, si disponible

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        Le descripteur de fichier.
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_syncfs()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.


id: eio_truncate
type: function
doc:
<comment>Description:</comment>
  Tronque un fichier
  
  <strong>eio_truncate()</strong> tronque le fichier régulier nommé par le chemin <strong>$path</strong> à une taille de <strong>$length</strong>
  octets.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Chemin vers le fichier.
  <info>int</info>       <strong>$offset</strong>    Position depuis le début du fichier.
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_busy()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.

<comment>See Also:</comment>
   * <strong>eio_ftruncate()</strong>


id: eio_unlink
type: function
doc:
<comment>Description:</comment>
  Supprime un nom et éventuellement, le fichier qui s'y réfère
  
  <strong>eio_unlink()</strong> supprime un nom depuis le système de fichiers.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Chemin vers le fichier.
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_unlink()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.


id: eio_utime
type: function
doc:
<comment>Description:</comment>
  Modifie l'heure du dernier accès et de la dernière modification d'un fichier

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      Chemin vers le fichier.
  <info>float</info>     <strong>$atime</strong>     Heure du dernier accès.
  <info>float</info>     <strong>$mtime</strong>     Heure de dernière modification.
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_utime()</strong> retourne la ressource demandée en cas de succès, ou <info>false</info> si une erreur
            survient.

<comment>See Also:</comment>
   * <strong>eio_futime()</strong>


id: eio_write
type: function
doc:
<comment>Description:</comment>
  Ecrit dans un fichier
  
  <strong>eio_write()</strong> écrit <strong>$length</strong> octets depuis le paramètre <strong>$str</strong> à la position <strong>$offset</strong> depuis le début du
  fichier.

<comment>Param:</comment>
  <info>mixed</info>     <strong>$fd</strong>        Un flux, une ressource de socket, ou un descripteur de fichier, i.e. retourné
                       par la fonction <strong>eio_open()</strong>
  <info>string</info>    <strong>$str</strong>       Chaîne de caractères source.
  <info>int</info>       <strong>$length</strong>    Nombre maximum d'octets à écrire.
  <info>int</info>       <strong>$offset</strong>    Position depuis le début du fichier.
  <info>int</info>       <strong>$pri</strong>       La priorité de la requête : <info>EIO_PRI_DEFAULT</info>, <info>EIO_PRI_MIN</info>, <info>EIO_PRI_MAX</info>, ou
                       <info>null</info>.
                       Si <info>null</info> est passé, le paramètre <strong>$pri</strong>, en interne, est défini à
                       <info>EIO_PRI_DEFAULT</info>.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel <strong>$callback</strong>
                       est appelée lorsque la requête est terminée.
                       Elle doit correspondre au prototype suivant : 
                       <strong>$data</strong>représente les données personnalisées passées à la
                       requête.<strong>$result</strong>représente la valeur résultante spécifique à la requête ;
                       basiquement, la valeur retournée par l'appel système correspondant.<strong>$req</strong>est la
                       ressource optionnelle de la requête qui peut être utilisée avec les fonctions
                       comme <strong>eio_get_last_error()</strong>
                       
                       représente les données personnalisées passées à la requête.
                       
                       représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
                       
                       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      représente les données personnalisées passées à la requête.
  <info></info>          <strong>$result</strong>    représente la valeur résultante spécifique à la requête ; basiquement, la
                       valeur retournée par l'appel système correspondant.
  <info></info>          <strong>$req</strong>       est la ressource optionnelle de la requête qui peut être utilisée avec les
                       fonctions comme <strong>eio_get_last_error()</strong>
  <info>mixed</info>     <strong>$data</strong>      Variables arbitraires à passer à la fonction de rappel <strong>$callback</strong>.

<comment>Return:</comment>
  <info>resource</info>  <strong>eio_write()</strong> retourne la ressource demandée, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>eio_open()</strong>


id: empty
type: function
doc:
<comment>Description:</comment>
  Détermine si une variable est vide
  
  Détermine si une variable est considérée comme vide. Une variable est considérée comme vide si
  elle n'existe pas, ou si sa valeur équivaut à <info>false</info>. La fonction <strong>empty()</strong> ne génère pas d'alerte si
  la variable n'existe pas.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var</strong>  Variable à vérifier.
               
               Aucune alerte n'est générée si la variable n'existe pas. Cela signifie que <strong>empty()</strong>
               est strictement équivalent à !isset($var) || $var == false.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si <strong>$var</strong> n'existe pas ou a une valeur vide ou égale à zéro, c.à.d. qu'elle est
        considérée "false", voir conversion en booléen. Sinon retourne <info>false</info>.

<comment>See Also:</comment>
   * <strong>isset()</strong>
   * __isset()
   * <strong>unset()</strong>
   * <strong>array_key_exists()</strong>
   * <strong>count()</strong>
   * <strong>strlen()</strong>
   * Les tables de comparaison des types


id: enchant_broker_describe
type: function
doc:
<comment>Description:</comment>
  Énumère les fournisseurs Enchant
  
  Énumère les fournisseurs Enchant et affiche quelques informations sur eux. Les mêmes informations
  sont fournis via la fonction <strong>phpinfo()</strong>.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Un courtier Enchant retourné par <strong>enchant_broker_init()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau des fournisseurs Enchant disponible avec leurs détails.


id: enchant_broker_dict_exists
type: function
doc:
<comment>Description:</comment>
  Vérifie si un dictionnaire existe
  
  Vérifie si un dictionnaire existe.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Un courtier Enchant retourné par <strong>enchant_broker_init()</strong>.
  <info>string</info>         <strong>$tag</strong>     langage, dans un format comme us_US, ch_DE, etc.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le langage existe, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>enchant_broker_describe()</strong>


id: enchant_broker_free
type: function
doc:
<comment>Description:</comment>
  Libère la ressource de sponsor ainsi que ses dictionnaires
  
  Libère un sponsor ainsi que tous ses dictionnaires. À partir de PHP 8.0.0, il est recommandé de
  détruire l'objet au lieu d'appeler cette fonction.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Un courtier Enchant retourné par <strong>enchant_broker_init()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>enchant_broker_init()</strong>


id: enchant_broker_free_dict
type: function
doc:
<comment>Description:</comment>
  Libère une ressource de dictionnaire
  
  Libère un dictionnaire. À partir de PHP 8.0.0, il est recommandé de détruire l'objet au lieu
  d'appeler cette fonction.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Un dictionnaire Enchant retourné par <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>enchant_broker_request_dict()</strong>
   * <strong>enchant_broker_request_pwl_dict()</strong>


id: enchant_broker_get_dict_path
type: function
doc:
<comment>Description:</comment>
  Récupère le chemin du dossier pour un backend fournit
  
  Récupère le chemin du dossier pour un backend fournit.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Un courtier Enchant retourné par <strong>enchant_broker_init()</strong>.
  <info>int</info>            <strong>$type</strong>    Le type des dictionnaires, c.à.d. <info>ENCHANT_MYSPELL</info> ou <info>ENCHANT_ISPELL</info>.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le chemin du dossier du dictionnaire en cas de succès ou <info>false</info> si une
                erreur survient.

<comment>See Also:</comment>
   * <strong>enchant_broker_set_dict_path()</strong>


id: enchant_broker_get_error
type: function
doc:
<comment>Description:</comment>
  Retourne la dernière erreur d'un sponsor
  
  Retourne la dernière erreur survenue pour ce sponsor.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Un courtier Enchant retourné par <strong>enchant_broker_init()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le message si une erreur a été trouvée, ou <info>false</info> sinon.


id: enchant_broker_init
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet sponsor

<comment>Return:</comment>
  <info>EnchantBroker|false</info>  Retourne une ressource de sponsor en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>enchant_broker_free()</strong>


id: enchant_broker_list_dicts
type: function
doc:
<comment>Description:</comment>
  Retourne une liste de tous les dictionnaires disponibles
  
  Retourne une liste de tous les dictionnaires disponibles ainsi que leurs détails.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Un courtier Enchant retourné par <strong>enchant_broker_init()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau des dictionnaires disponible avec leurs détails.

<comment>See Also:</comment>
   * <strong>enchant_broker_describe()</strong>


id: enchant_broker_request_dict
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau dictionnaire
  
  Crée un nouveau dictionnaire en utilisant le paramètre <strong>$tag</strong>, représentant le langage dont vous
  voulez associer le dictionnaire ("en_US", "de_DE", ...).

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Un courtier Enchant retourné par <strong>enchant_broker_init()</strong>.
  <info>string</info>         <strong>$tag</strong>     Une balise décrivant le langage, par exemple, en_US, de_DE

<comment>Return:</comment>
  <info>EnchantDictionary|false</info>  Retourne une ressource de dictionnaire en cas de succès ou <info>false</info> si une
                           erreur survient.

<comment>See Also:</comment>
   * <strong>enchant_dict_describe()</strong>
   * <strong>enchant_broker_dict_exists()</strong>
   * <strong>enchant_broker_free_dict()</strong>


id: enchant_broker_request_pwl_dict
type: function
doc:
<comment>Description:</comment>
  Crée un dictionnaire en utilisant un fichier PWL
  
  Crée un dictionnaire en utilisant un fichier PWL. Un fichier PWL est un fichier de mots personnels
  contenant un mot par ligne.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>    Un courtier Enchant retourné par <strong>enchant_broker_init()</strong>.
  <info>string</info>         <strong>$filename</strong>  Chemin vers le fichier PWL. Si le fichier n'existe pas, un nouveau sera
                            créé, si possible.

<comment>Return:</comment>
  <info>EnchantDictionary|false</info>  Retourne une ressource de dictionnaire en cas de succès ou <info>false</info> si une
                           erreur survient.

<comment>See Also:</comment>
   * <strong>enchant_dict_describe()</strong>
   * <strong>enchant_broker_dict_exists()</strong>
   * <strong>enchant_broker_free_dict()</strong>


id: enchant_broker_set_dict_path
type: function
doc:
<comment>Description:</comment>
  Définit le chemin du dossier pour un backend fournit
  
  Définit le chemin du dossier pour un backend fournit.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>  Un courtier Enchant retourné par <strong>enchant_broker_init()</strong>.
  <info>int</info>            <strong>$type</strong>    Le type des dictionnaires, c.à.d. <info>ENCHANT_MYSPELL</info> ou <info>ENCHANT_ISPELL</info>.
  <info>string</info>         <strong>$path</strong>    Le chemin du dossier du dictionnaire.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>enchant_broker_get_dict_path()</strong>


id: enchant_broker_set_ordering
type: function
doc:
<comment>Description:</comment>
  Déclare une préférence pour un dictionnaire d'une langue
  
  Déclare une préférence pour un dictionnaire à utiliser pour la langue spécifiée par le paramètre
  <strong>$tag</strong>. L'ordre des langues est une liste séparée par une virgule. Le caractère spécial "*" peut
  être utilisé comme langue pour déclarer un ordre par défaut pour tous les langages qui ne
  déclarent pas explicitement un ordre.

<comment>Param:</comment>
  <info>EnchantBroker</info>  <strong>$broker</strong>    Un courtier Enchant retourné par <strong>enchant_broker_init()</strong>.
  <info>string</info>         <strong>$tag</strong>       La langue. Le caractère "*" peut être utilisé en tant que langage pour
                            déclarer un ordre par défaut pour tous les langages qui ne déclarent pas
                            explicitement un ordre.
  <info>string</info>         <strong>$ordering</strong>  Liste de noms de fournisseurs séparée par une virgule

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: enchant_dict_add
type: function
doc:
<comment>Description:</comment>
  Ajoute un mot à une liste de mot personnelle
  
  Ajoute un mot à la liste des mots personnelle du dictionnaire fournis.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Un dictionnaire Enchant retourné par <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>        Le mot à ajouter

<comment>Return:</comment>
  <info>void</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>enchant_broker_request_pwl_dict()</strong>
   * <strong>enchant_broker_request_dict()</strong>


id: enchant_dict_add_to_personal
type: function
doc:
<comment>Description:</comment>
  Alias de enchant_dict_add
  
  Cette fonction est un alias de :  <strong>enchant_dict_add()</strong>.


id: enchant_dict_add_to_session
type: function
doc:
<comment>Description:</comment>
  Ajoute un mot à la session courante
  
  Ajoute le mot <strong>$word</strong> au dictionnaire fourni. Il ne sera ajouté que pour la session courante.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Un dictionnaire Enchant retourné par <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>        Le mot à ajouter

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.

<comment>See Also:</comment>
   * <strong>enchant_broker_request_dict()</strong>


id: enchant_dict_check
type: function
doc:
<comment>Description:</comment>
  Vérifie si un mot est correctement orthographié
  
  Retourne <info>true</info> si le mot <strong>$word</strong> est correctement orthographié, <info>false</info> sinon.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Un dictionnaire Enchant retourné par <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>        Le mot à vérifier

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le mot est correctement orthographié, <info>false</info> sinon.


id: enchant_dict_describe
type: function
doc:
<comment>Description:</comment>
  Décrit un dictionnaire
  
  Retourne les détails d'un dictionnaire.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Un dictionnaire Enchant retourné par <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.

<comment>Return:</comment>
  <info>array</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: enchant_dict_get_error
type: function
doc:
<comment>Description:</comment>
  Retourne la dernière erreur de la session courante
  
  Retourne la dernière erreur de la session courante.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Un dictionnaire Enchant retourné par <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le message d'erreur sous la forme d'une chaîne de caractères, ou <info>false</info> si
                une erreur survient.


id: enchant_dict_is_added
type: function
doc:
<comment>Description:</comment>
  Que le 'mot' existe ou non dans cette session d'orthographe
  
  Informe si le mot existe déjà ou non dans la session courante.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Un dictionnaire Enchant retourné par <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>        Le mot à rechercher

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le mot existe ou <info>false</info>

<comment>See Also:</comment>
   * <strong>enchant_dict_add_to_session()</strong>


id: enchant_dict_is_in_session
type: function
doc:
<comment>Description:</comment>
  Alias de enchant_dict_is_added
  
  Cette fonction est un alias de :  <strong>enchant_dict_is_added()</strong>.


id: enchant_dict_quick_check
type: function
doc:
<comment>Description:</comment>
  Vérifie si le mot est correctement orthographié et fournit des suggestions
  
  Retourne <info>true</info> si le mot est correctement orthographié, <info>false</info> si la variable des suggestions est
  fournie, et la remplit des suggestions possibles.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>   Un dictionnaire Enchant retourné par
                                   <strong>enchant_broker_request_dict()</strong> ou
                                   <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>         Le mot à vérifier
  <info>array</info>              <strong>$suggestions</strong>  Si le mot n'est pas correctement orthographié, cette variable
                                   contiendra un tableau de suggestions.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le mot est correctement orthographié, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>enchant_dict_check()</strong>
   * <strong>enchant_dict_suggest()</strong>


id: enchant_dict_store_replacement
type: function
doc:
<comment>Description:</comment>
  Ajoute une orthographe pour un mot
  
  Ajoute une orthographe pour <strong>$mis</strong> en utilisant <strong>$cor</strong>. Notez que si vous remplacez @mis par @cor,
  alors il est probable que les futures occurrences den@mis seront remplacées par @cor. Ainsi, @cor
  sera ajouté à la liste des suggestions.

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Un dictionnaire Enchant retourné par <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$misspelled</strong>  Le mot à traiter
  <info>string</info>             <strong>$correct</strong>     Le mot correct

<comment>Return:</comment>
  <info>void</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: enchant_dict_suggest
type: function
doc:
<comment>Description:</comment>
  Retourne une liste de valeurs si aucunes des conditions ne sont réunies

<comment>Param:</comment>
  <info>EnchantDictionary</info>  <strong>$dictionary</strong>  Un dictionnaire Enchant retourné par <strong>enchant_broker_request_dict()</strong>
                                  ou <strong>enchant_broker_request_pwl_dict()</strong>.
  <info>string</info>             <strong>$word</strong>        Mot à utiliser pour les suggestions

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau de suggestions si le mot est mal orthographié.

<comment>See Also:</comment>
   * <strong>enchant_dict_check()</strong>
   * <strong>enchant_dict_quick_check()</strong>


id: end
type: function
doc:
<comment>Description:</comment>
  Positionne le pointeur de tableau en fin de tableau
  
  <strong>end()</strong> déplace le pointeur interne du tableau <strong>$array</strong> jusqu'au dernier élément et retourne sa
  valeur.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  Le tableau. Ce tableau est passé par référence car il sera modifié par la
                        fonction. Cela signifie que vous devez passer une vraie variable et non une
                        fonction retournant un tableau, car actuellement, seules les variables
                        peuvent être passées par référence.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur du dernier élément ou <info>false</info> si le tableau est vide.

<comment>See Also:</comment>
   * <strong>current()</strong>
   * <strong>each()</strong>
   * <strong>prev()</strong>
   * <strong>reset()</strong>
   * <strong>next()</strong>
   * <strong>array_key_last()</strong>


id: enum_exists
type: function
doc:
<comment>Description:</comment>
  Vérifie si l'énumération est définie
  
  Cette fonction vérifie si l'enum donnée a été définie ou non.

<comment>Param:</comment>
  <info>string</info>  <strong>$enum</strong>      Le nom de l'enum. Le nom est pris en compte sans tenir compte des majuscules et
                     des minuscules.
  <info>bool</info>    <strong>$autoload</strong>  S'il faut appeler autoload par défaut.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si <strong>$enum</strong> est un enum défini, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>function_exists()</strong>
   * <strong>class_exists()</strong>
   * <strong>interface_exists()</strong>
   * <strong>get_declared_classes()</strong>


id: error_clear_last
type: function
doc:
<comment>Description:</comment>
  Enlève l'erreur la plus récente

<comment>Return:</comment>
  <info>void</info>  Enlève l'erreur la plus récente, le rendant irrécupérable avec <strong>error_get_last()</strong>.

<comment>See Also:</comment>
   * Constantes d'erreurs


id: error_get_last
type: function
doc:
<comment>Description:</comment>
  Récupère la dernière erreur survenue
  
  Récupère la dernière erreur survenue.

<comment>Return:</comment>
  <info>array|null</info>  Retourne un tableau associatif décrivant la dernière erreur avec les clés "type",
              "message", "file" et "line". Si l'erreur a été causée par une fonction interne à PHP,
              le message commencera par le nom de cette fonction. Retourne <info>null</info> s'il n'y a
              actuellement aucune erreur.

<comment>See Also:</comment>
   * Constantes d'erreur
   * Variable $php_errormsg
   * <strong>error_clear_last()</strong>
   * Directive <strong>$display_errors</strong>
   * Directive <strong>$html_errors</strong>
   * Directive <strong>$xmlrpc_errors</strong>


id: error_log
type: function
doc:
<comment>Description:</comment>
  Envoi un message d'erreur vers le gestionnaire d'erreurs défini
  
  Envoie un message d'erreur à l'historique d'erreur du serveur web ou à un fichier.

<comment>Param:</comment>
  <info>string</info>       <strong>$message</strong>             Le message d'erreur qui doit être stocké.
  <info>int</info>          <strong>$message_type</strong>        Spécifie la destination du message d'erreur.  Les types
                                    possibles de messages sont :
                                    
                                    <strong>error_log()</strong> log types0<strong>$message</strong> est envoyé à l'historique PHP,
                                    qui est basé sur l'historique système ou un fichier, en fonction
                                    de la configuration de error_log. C'est l'option par défaut.
                                    1<strong>$message</strong> est envoyé par email à l'adresse <strong>$destination</strong>. C'est
                                    le seul type qui utilise le quatrième paramètre
                                    <strong>$additional_headers</strong>. 2 N'est plus une option. 3<strong>$message</strong> est
                                    ajouté au fichier <strong>$destination</strong>. Aucune nouvelle ligne (retour
                                    chariot) n'est automatiquement ajoutée à la fin de la chaîne
                                    <strong>$message</strong>. 4<strong>$message</strong> est envoyé directement au gestionnaire
                                    d'identification SAPI.
  <info>string|null</info>  <strong>$destination</strong>         La destination. Cela dépend du paramètre <strong>$message_type</strong> décrit
                                    ci-dessus.
  <info>string|null</info>  <strong>$additional_headers</strong>  Les en-têtes supplémentaires. Ils sont utilisés lorsque le
                                    paramètre <strong>$message_type</strong> est défini à  <return>1</return>. Ce type de message
                                    utilise la même fonction interne que la fonction <strong>mail()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient. Si
        <strong>$message_type</strong> est zéro, alors cette fonction retourne toujours <info>true</info>, peu importe si l'erreur
        à pu être enregistrée dans le journal d'événements.


id: error_reporting
type: function
doc:
<comment>Description:</comment>
  Fixe le niveau de rapport d'erreurs PHP
  
  <strong>error_reporting()</strong> modifie la directive error_reporting pendant l'exécution du script. PHP possède
  plusieurs niveaux d'erreurs, utiliser cette fonction configure ce niveau pendant la durée
  (d'exécution) de votre script. Si le paramètre optionnel <strong>$error_level</strong> n'est pas défini,
  <strong>error_reporting()</strong> retournera uniquement le niveau de rapport d'erreurs courant.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$error_level</strong>  Le nouveau niveau error_reporting. Il peut être un champ de bits ou une
                          combinaison de constantes. L'utilisation des constantes est vivement
                          recommandée pour assurer une compatibilité maximale avec les futures
                          versions. Au fur et à mesure que de nouveaux niveaux d'erreurs sont créés,
                          les valeurs évoluent, c'est pourquoi les anciennes valeurs n'ont plus
                          forcément la même signification.
                          
                          Les constantes représentant les niveaux d'erreurs disponibles et la
                          signification de ces niveaux d'erreurs est décrite dans le manuel sur les
                          constantes prédéfinies.

<comment>Return:</comment>
  <info>int</info>  Retourne le niveau d'error_reporting, before qu'il ne soit changé en <strong>$error_level</strong>
       
       L'opérateur de contrôle d'erreur <return>@</return> modifie le <strong>$error_level</strong> pendant la gestion des erreurs.

<comment>See Also:</comment>
   * La directive display_errors
   * La directive html_errors
   * La directive xmlrpc_errors
   * L'opérateur de contrôle d'erreur
   * <strong>ini_set()</strong>


id: escapeshellarg
type: function
doc:
<comment>Description:</comment>
  Protège une chaîne de caractères pour utilisation en ligne de commande
  
  <strong>escapeshellarg()</strong> ajoute des guillemets simples autour des chaînes de caractères, et ajoute des
  guillemets puis échappe les guillemets simples de la chaîne. Cela permet de faire passer
  directement le paramètre <strong>$arg</strong> comme argument Shell, tout en assurant un maximum de sécurité.
  <strong>escapeshellarg()</strong> doit être utilisée pour traiter individuellement chacun des arguments à passer au
  Shell. Les fonctions Shell sont <strong>exec()</strong>, <strong>system()</strong> et les opérateurs guillemets obliques.
  
  Sous Windows, <strong>escapeshellarg()</strong> remplace plutôt les  signes de pourcentage, les points
  d'exclamation (substitution de variables  différées) et les guillemets doubles avec des espaces et
  ajoute des  guillemets doubles autour de la chaîne. De plus, chaque série de barres obliques
  inversées consécutives (<return>\</return>) est échappée par une barre oblique inverse supplémentaire.

<comment>Param:</comment>
  <info>string</info>  <strong>$arg</strong>  L'argument à échapper.

<comment>Return:</comment>
  <info>string</info>  La chaîne échappée.

<comment>See Also:</comment>
   * <strong>escapeshellcmd()</strong>
   * <strong>exec()</strong>
   * <strong>popen()</strong>
   * <strong>system()</strong>
   * backtick operator


id: escapeshellcmd
type: function
doc:
<comment>Description:</comment>
  Protège les caractères spéciaux du Shell
  
  <strong>escapeshellcmd()</strong> échappe tous les caractères de la chaîne <strong>$command</strong> qui pourraient avoir une
  signification spéciale dans une commande Shell. Cette fonction permet de s'assurer que la commande
  sera correctement passée à l'exécuteur de commande Shell <strong>exec()</strong> et <strong>system()</strong>, ou encore à
  guillemets obliques.
  
  Les caractères suivants seront échappés : <return>&#;`|*?~\<&gt;^()[]{}$\</return>, <return>\x0A</return> et <return>\xFF</return>. <return>'</return> et <return>"</return> sont échappés que s'ils ne sont pas par paire. Sous Windows, tous ces caractères ainsi que <return>%</return> et <return>!</return> sont précédés d'un accent circonflexe (<return>^</return>).

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  La commande à échapper.

<comment>Return:</comment>
  <info>string</info>  La chaîne échappée.

<comment>See Also:</comment>
   * <strong>escapeshellarg()</strong>
   * <strong>exec()</strong>
   * <strong>popen()</strong>
   * <strong>system()</strong>
   * les guillemets obliques


id: eval
type: function
doc:
<comment>Description:</comment>
  Exécute une chaîne comme un script PHP
  
  Évalue le <strong>$code</strong> fourni comme étant du code PHP.
  
  Le code en cours d'évaluation hérite de la portée des variables de la ligne sur laquelle l'appel à
  <strong>eval()</strong> a lieu. Toutes les variables disponibles à cette ligne seront accessibles en lecture et
  modification dans le code évalué. Cependant, toutes les fonctions et classes définies seront
  définies dans l'espace de noms global. En d'autres termes, le compilateur considère le code évalué
  comme s'il s'agissait d'un fichier inclus séparé.
  
  La construction de langage <strong>eval()</strong> est très dangereuse car elle autorise l'exécution de code PHP
  arbitraire. Son utilisation est vivement déconseillée. Si vous avez soigneusement vérifié qu'il
  n'y a pas d'autres options que de l'utiliser, gardez une attention toute particulière à ne pas y
  passer de données provenant d'un utilisateur sans les avoir précédemment validées minutieusement.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>  Code PHP valide à évaluer.
                 
                 Le code ne doit pas être entouré de balises PHP ouvrante et fermante, i.e. <return>'echo
                 "Hi!";'</return> doit être passé au lieu de <return>'\<?php echo "Hi!"; &gt;'</return>. Il est toujours possible de quitter et de retourner en mode PHP en utilisant les balises PHP appropriées, i.e. <return>'echo "En mode PHP !"; ?&gt;En mode HTML !\<?php echo "Retour en mode PHP !";'</return>.
                 
                 Mis à part cela, le code PHP passé doit être valide. Ceci inclut que toutes les
                 instructions doivent se terminer par un point-virgule. <return>'echo "Hi!"'</return> par exemple
                 résultera en une erreur fatale, alors que <return>'echo "Hi!";'</return> fonctionnera.
                 
                 Une instruction <return>return</return> terminera immédiatement l'évaluation du code.
                 
                 Le code sera exécuté dans le scope du code appelant la fonction <strong>eval()</strong>. Aussi,
                 toutes les variables définies ou modifiées dans l'appel à la fonction <strong>eval()</strong>
                 resteront visibles après la fin de l'exécution de la fonction.

<comment>Return:</comment>
  <info>mixed</info>  <strong>eval()</strong> retourne <info>null</info> sauf si <return>return</return> est appelé dans le code évalué, auquel cas la valeur
         passée à <return>return</return> est retournée. À partir de PHP 7, s'il y a une erreur de syntaxe dans le
         code évalué, <strong>eval()</strong> lance une exception ParseError. Avant PHP 7, dans ce cas <strong>eval()</strong>
         retourne <info>false</info> et l'exécution du code suivant continue normalement. Il n'est pas possible
         d'attraper l'erreur d'analyse de la fonction <strong>eval()</strong> en utilisant la fonction
         <strong>set_error_handler()</strong>.

<comment>See Also:</comment>
   * <strong>call_user_func()</strong>


id: exec
type: function
doc:
<comment>Description:</comment>
  Exécute un programme externe
  
  <strong>exec()</strong> exécute la commande <strong>$command</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>      La commande à exécuter.
  <info>array</info>   <strong>$output</strong>       Si l'argument <strong>$output</strong> est présent, alors ce tableau sera rempli par les
                        lignes retournées par la commande. Les espaces de début et de fin de chaîne,
                        comme <return>\n</return>, ne seront pas inclus dans ce tableau. Il faut noter que si ce
                        tableau contient des éléments, <strong>exec()</strong> ajoutera les nouvelles lignes à la fin
                        du tableau. Si vous ne voulez pas que les nouveaux éléments soient
                        concaténés, utilisez la fonction <strong>unset()</strong> avec ce tableau avant de le passer
                        à <strong>exec()</strong>.
  <info>int</info>     <strong>$result_code</strong>  Si l'argument <strong>$result_code</strong> est présent en plus du tableau <strong>$output</strong>, alors le
                        statut de retour d'exécution sera inscrit dans cette variable.

<comment>Return:</comment>
  <info>string|false</info>  La dernière ligne du résultat de la commande. Pour exécuter une commande et obtenir
                le résultat sans aucun traitement, il faut utiliser la fonction <strong>passthru()</strong>.
                
                Retourne <info>false</info> en cas d'erreur.
                
                Pour récupérer la sortie de la commande exécutée, assurez-vous de définir et
                d'utiliser le paramètre <strong>$output</strong>.

<comment>See Also:</comment>
   * <strong>system()</strong>
   * <strong>passthru()</strong>
   * <strong>escapeshellcmd()</strong>
   * <strong>pcntl_exec()</strong>
   * les guillemets obliques


id: exif_imagetype
type: function
doc:
<comment>Description:</comment>
  Détermine le type d'une image
  
  <strong>exif_imagetype()</strong> lit les premiers octets du fichier d'image <strong>$filename</strong>, et vérifie sa signature.
  
  <strong>exif_imagetype()</strong> peut être utilisée pour éviter les appels aux autres fonctions exif pour les
  formats de fichiers qui ne sont pas supportés, ou en conjonction avec  $_SERVER['HTTP_ACCEPT']
  pour vérifier si l'utilisateur pourra voir cette image dans son navigateur.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  L'image à vérifier.

<comment>Return:</comment>
  <info>int|false</info>  Lorsqu'une valeur valide est trouvée, la constante appropriée est retournée, et sinon,
             <info>false</info>. La valeur retournée est la même que la fonction <strong>getimagesize()</strong> à l'index 2, mais
             cette fonction est bien plus rapide.
             
             Les constantes suivantes sont définies et représentent les valeurs possibles de retour
             de la fonction <strong>exif_imagetype()</strong> : Constantes de type
             d'imagesValeurConstante1<info>IMAGETYPE_GIF</info>2<info>IMAGETYPE_JPEG</info>3<info>IMAGETYPE_PNG</info>4<info>IMAGETYPE_SWF</info>5<info>IMAGETYPE_PSD</info>6<info>IMAGETYPE_BMP</info>7<info>IMAGETYPE_TIFF_II</info>
             (ordre d'octets d'Intel)8<info>IMAGETYPE_TIFF_MM</info> (ordre d'octets Motorola)
             9<info>IMAGETYPE_JPC</info>10<info>IMAGETYPE_JP2</info>11<info>IMAGETYPE_JPX</info>12<info>IMAGETYPE_JB2</info>13<info>IMAGETYPE_SWC</info>14<info>IMAGETYPE_IFF</info>15<info>IMAGETYPE_WBMP</info>16<info>IMAGETYPE_XBM</info>17<info>IMAGETYPE_ICO</info>18<info>IMAGETYPE_WEBP</info>19<info>IMAGETYPE_AVIF</info>
             
             La fonction <strong>exif_imagetype()</strong> émettra une alerte de niveau <info>E_NOTICE</info> et retournera <info>false</info>
             si elle n'est pas capable de lire assez d'octets depuis le fichier pour y déterminer le
             type d'image.

<comment>See Also:</comment>
   * <strong>image_type_to_mime_type()</strong>
   * <strong>getimagesize()</strong>


id: exif_read_data
type: function
doc:
<comment>Description:</comment>
  Lit les en-têtes EXIF dans les images
  
  <strong>exif_read_data()</strong> lit les en-têtes EXIF des images. Avec cette fonction, vous pouvez lire les
  données méta générées par les appareils photos numériques.
  
  Les en-têtes EXIF tendent à être présents dans les images JPEG/TIFF générées par les appareils
  photos numériques, mais malheureusement, chaque appareil photo numérique a une idée différente de
  la façon dont leurs images doivent être marquées, donc, vous ne pouvez pas toujours compter sur un
  en-tête EXIF spécifique, bien que présent.
  
  Les paramètres <return>Height</return> et <return>Width</return> sont calculés de la même façon que pour la fonction <strong>getimagesize()</strong>,
  donc leurs valeurs ne feront parties d'aucun en-tête retourné. De même, l'index <return>html</return> est la
  représentation textuelle de la hauteur/largeur utilisée dans une balise image HTML classique.
  
  Lorsqu'un en-tête EXIF contient une note de Copyright, cet en-tête peut alors contenir lui-même
  deux valeurs. Comme cette solution est incohérente avec les standards EXIF 2.10, la section
  <return>COMPUTED</return> retournera les deux en-têtes, <return>Copyright.Photographer</return> et <return>Copyright.Editor</return>, tandis que les
  sections <return>IFD0</return> contiennent le tableau d'octets avec des caractères NULL pour séparer les deux
  entrées ; ou bien, juste la première entrée si le type de données était erroné (comportement par
  défaut de EXIF). La section <return>COMPUTED</return> va aussi contenir une entrée <return>Copyright</return>, qui sera soit la
  chaîne originale de copyright, soit une liste de valeurs séparées par des virgules de photos et de
  copyright de l'auteur.
  
  La balise <return>UserComment</return> présente le même problème que la balise Copyright. Elle peut stocker deux
  valeurs : en premier, le jeu de caractères utilisé, puis la valeur elle-même. Si c'est le cas, la
  section <return>IFD</return> contiendra uniquement le jeu de caractères, ou bien un tableau d'octets. La section
  <return>COMPUTED</return> va stocker les deux entrées <return>UserCommentEncoding</return> et <return>UserComment</return>. L'index <return>UserComment</return> est
  disponible dans les deux cas, et il est préférable de l'utiliser, plutôt que la valeur de la
  section <return>IFD0</return>.
  
  <strong>exif_read_data()</strong> valide les données des balises EXIF en accord avec la spécification EXIF
  (http://exif.org/Exif2-2.PDF, page 20).

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$file</strong>               L'emplacement du fichier image. Il peut s'agir soit d'un
                                       chemin d'accès  au fichier (les wrappers de flux sont
                                       également pris en charge comme  d'habitude), soit d'un flux
                                       <info>resource</info>.
  <info>string|null</info>      <strong>$required_sections</strong>  Liste de valeur séparées par des virgules des sections qui
                                       devront être présentées dans le tableau de résultat. Si
                                       aucune des sections demandées n'est trouvée, la valeur
                                       retournée est <info>false</info>. FILEFileName (nom du ficher), FileSize
                                       (taille du fichier), FileDateTime (date de modification du
                                       fichier), SectionsFound (sections trouvées)COMPUTED Attribut
                                       Html, largeur, hauteur, couleur ou noir et blanc et plus si
                                       disponible. La largeur et la hauteur sont calculées de la
                                       même façon que la fonction <strong>getimagesize()</strong>, donc, leurs
                                       valeurs ne devraient jamais différer. De même, l'index <return>html</return>
                                       est la représentation textuelle de la hauteur/largeur
                                       utilisée dans une balise image HTML classique. ANY_TAG Toutes
                                       les informations concernant cette balise, comme <return>IFD0</return>, <return>EXIF</return>,
                                       ... IFD0 Toutes les balises <return>IFD0</return>. Dans les images normales,
                                       ils contiennent les dimensions de l'image, etc. THUMBNAIL Un
                                       fichier qui contient une miniature, s'il y a un second <return>IFD</return>.
                                       Toutes les informations mises en balises à propos de cette
                                       miniature seront stockées dans cette section. COMMENTEn-tête
                                       de commentaire des images JPEG.EXIF La section EXIF est une
                                       sous section de la section <return>IFD0</return>. Elle contient des
                                       informations plus détaillées sur les images. La plupart de
                                       ces index sont reliés aux appareils numériques.
  <info>bool</info>             <strong>$as_arrays</strong>          Spécifie si chaque section doit devenir un tableau ou non.
                                       Les <strong>$required_sections</strong>  <return>COMPUTED</return>, <return>THUMBNAIL</return> et <return>COMMENT</return> seront
                                       toujours transformées en tableau, car elle contiennent des
                                       noms qui risquent d'être en conflit.
  <info>bool</info>             <strong>$read_thumbnail</strong>     Lorsque défini à <info>true</info>, la miniature elle-même est lue. Sinon,
                                       seules les données contenues dans le taf seront lues.

<comment>Return:</comment>
  <info>array|false</info>  Retourne un tableau associatif où les index sont les noms des en-têtes et les valeurs
               sont les valeurs associées à ces en-têtes. Si aucune donnée ne peut être retournée,
               <strong>exif_read_data()</strong> retournera <info>false</info>.

<comment>See Also:</comment>
   * <strong>exif_thumbnail()</strong>
   * <strong>getimagesize()</strong>
   * 


id: exif_tagname
type: function
doc:
<comment>Description:</comment>
  Lit le nom d'en-tête EXIF d'un index

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  L'id de Tag pour lequel un nom sera recherché.

<comment>Return:</comment>
  <info>string|false</info>  <strong>exif_tagname()</strong> retourne <info>false</info> si <strong>$index</strong>  n'est pas un id de tag EXIF défini, sinon
                elle retourne le nom de l'en-tête.

<comment>See Also:</comment>
   * <strong>exif_imagetype()</strong>
   * EXIF Specification
   * EXIF Tags


id: exif_thumbnail
type: function
doc:
<comment>Description:</comment>
  Récupère la miniature d'une image
  
  <strong>exif_thumbnail()</strong> lit la miniature de l'image.
  
  Si vous voulez afficher des miniatures avec cette fonction, vous devez envoyer le bon type MIME
  avec la fonction <strong>header()</strong>.
  
  Il est possible que la fonction <strong>exif_thumbnail()</strong>  n'arrive pas à créer l'image mais peut
  déterminer sa taille. Dans ce cas, la fonction retourne <info>false</info> mais les paramètres <strong>$width</strong> et
  <strong>$height</strong> sont définis.

<comment>Param:</comment>
  <info>resource|string</info>  <strong>$file</strong>        Localisation du fichier image. Il peut s'agir soit d'un chemin
                                d'accès au fichier, soit d'un flux <info>ressource</info>.
  <info>int</info>              <strong>$width</strong>       La largeur retournée de la miniature retournée.
  <info>int</info>              <strong>$height</strong>      La hauteur retournée de la miniature retournée.
  <info>int</info>              <strong>$image_type</strong>  Le type de l'image retourné de la miniature retournée. Peut être
                                soit TIFF, soit JPEG.

<comment>Return:</comment>
  <info>string|false</info>  Retourne la miniature embarquée ou <info>false</info> si l'image ne contient pas de miniature.

<comment>See Also:</comment>
   * <strong>exif_read_data()</strong>
   * <strong>image_type_to_mime_type()</strong>


id: exit
type: function
doc:
<comment>Description:</comment>
  Affiche un message et termine le script courant
  
  Termine le script courant. Les fonctions d'extinction et les destructeurs d'objets seront toujours
  exécutés même si <return>exit</return> est appelé.
  
  <return>exit</return> est une construction de langage et peut être appelé sans parenthèse si aucun paramètre
  <strong>$status</strong> n'est passé.

<comment>Param:</comment>
  <info>string</info>  <strong>$status</strong>  Si <strong>$status</strong> est une chaîne de caractères, cette fonction affichera le <strong>$status</strong>
                   juste avant de sortir.
                   
                   Si le paramètre <strong>$status</strong> est un entier, cette valeur pourra être utilisée comme
                   statut de sortie et ne sera pas affichée. Le statut de sortie peut être dans
                   l'intervalle 0-255, le statut de sortie 255 est réservé par PHP et ne doit pas
                   être utilisé. Le statut 0 est utilisé pour terminer le programme avec succès.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.

<comment>See Also:</comment>
   * <strong>register_shutdown_function()</strong>


id: exp
type: function
doc:
<comment>Description:</comment>
  Calcul l'exponentielle de e
  
  Retourne <info>e</info>, à la puissance <strong>$num</strong>.
  
  '<info>e</info>' est le logarithme naturel, ou approximativement 2.718282.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  L'argument à traiter

<comment>Return:</comment>
  <info>float</info>  'e', à la puissance <strong>$num</strong>.

<comment>See Also:</comment>
   * <strong>log()</strong>
   * <strong>pow()</strong>


id: expect_expectl
type: function
doc:
<comment>Description:</comment>
  Attend jusqu'à ce que la sortie d'un processus corresponde à un
    des motifs, un période de temps spécifique est passée ou un EOF est vu
    
  
  Attend jusqu'à ce que la sortie d'un processus corresponde à un des motifs, un période de temps
  spécifique est passée ou un EOF est vu.
  
  Si le paramètre <strong>$match</strong> est fourni, alors il est rempli avec le résultat de la recherche. La chaîne
  de caractères de recherche peut être trouvée dans <strong>$match[0]</strong>. Les sous-chaînes de recherche (selon
  les parenthèses) dans le motif original peuvent être trouvées dans <strong>$match[1]</strong>, <strong>$match[2]</strong> et ainsi
  de suite jusqu'à <strong>$match[9]</strong> (limité par libexpect).

<comment>Param:</comment>
  <info>resource</info>  <strong>$expect</strong>  Un flux de données Expect, ouvert précédemment avec <strong>expect_popen()</strong>.
  <info>array</info>     <strong>$cases</strong>   Un tableau des cas expect. Chaque cas expect est un tableau indexé, comme
                     décrit dans la table suivante : Expect Case ArrayClé IndexType
                     ValeurDescriptionEst ObligatoireValeur par Défaut0stringmotif, qui sera vérifié
                     avec la sortie du fluxoui1mixed valeur, qui sera retournée par cette fonction,
                     si le motif concorde oui2integer type de motif, un de : <info>EXP_GLOB</info>, <info>EXP_EXACT</info> ou
                     <info>EXP_REGEXP</info> non<info>EXP_GLOB</info>

<comment>Return:</comment>
  <info>int</info>  Retourne une valeur associée avec le motif qui correspond.
       
       En cas d'échec, cette fonction retourne : <info>EXP_EOF</info>, <info>EXP_TIMEOUT</info> ou <info>EXP_FULLBUFFER</info>

<comment>See Also:</comment>
   * <strong>expect_popen()</strong>


id: expect_popen
type: function
doc:
<comment>Description:</comment>
  Exécute une commande via le shell Bourne, et ouvre le flux PTY
    au processus
  
  Exécute une commande via le shell Bourne, et ouvre le flux PTY au processus.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Commande à exécuter.

<comment>Return:</comment>
  <info>resource</info>  Retourne un flux de données PTY ouvert au processus <return>stdio</return>, <return>stdout</return> et <return>stderr</return>.
            
            En cas d'erreur, cette fonction retourne <info>false</info>.

<comment>See Also:</comment>
   * <strong>popen()</strong>


id: explode
type: function
doc:
<comment>Description:</comment>
  Scinde une chaîne de caractères en segments
  
  <strong>explode()</strong> retourne un tableau de chaînes de caractères,  chacune d'elle étant une sous-chaîne du
  paramètre <strong>$string</strong> extraite en utilisant le séparateur <strong>$separator</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  Le séparateur.
  <info>string</info>  <strong>$string</strong>     La chaîne initiale.
  <info>int</info>     <strong>$limit</strong>      Si <strong>$limit</strong> est défini et positif,  le tableau retourné contient, au maximum,
                      <strong>$limit</strong> éléments, et le dernier élément contiendra le reste de la chaîne.
                      
                      Si le paramètre <strong>$limit</strong> est négatif, tous les éléments, excepté les -<strong>$limit</strong>
                      derniers éléments sont retournés.
                      
                      Si <strong>$limit</strong> vaut zéro, il est traité comme valant 1.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau de chaînes de caractères créées en scindant la chaîne du paramètre
         <strong>$string</strong> en plusieurs morceaux suivant le paramètre <strong>$separator</strong>.
         
         Si <strong>$separator</strong> est une chaîne vide (""), <strong>explode()</strong> lancera une <class>ValueError</class>. Si <strong>$separator</strong>
         contient une valeur qui n'est pas contenue dans <strong>$string</strong> ainsi qu'une valeur négative pour
         le paramètre <strong>$limit</strong>, alors <strong>explode()</strong> retournera un tableau vide, sinon, un tableau
         contenant la chaîne <strong>$string</strong> entière. Si les valeurs de <strong>$separator</strong> apparaissent au début ou
         à la fin de <strong>$string</strong>, ces valeurs seront ajouté comme une valeur d'un <info>array</info> vide soit en la
         première ou dernière position du <info>array</info> retourné respectivement.

<comment>See Also:</comment>
   * <strong>preg_split()</strong>
   * <strong>str_split()</strong>
   * <strong>mb_split()</strong>
   * <strong>str_word_count()</strong>
   * <strong>strtok()</strong>
   * <strong>implode()</strong>


id: expm1
type: function
doc:
<comment>Description:</comment>
  Retourne exp($num) - 1, calculé de manière précise même
     lorsque la valeur du nombre est proche de zéro
    
  
  <strong>expm1()</strong> retourne l'équivalent de <return>exp(arg) -  1</return> calculé de telle sorte qu'il sera précis, même si
  la valeur de l'argument <strong>$num</strong> est proche de <return>0</return>, un cas où l'expression <return>"exp (arg) - 1"</return> n'est pas
  précis, du fait de la soustraction de deux nombres quasi-égaux.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  L'argument à traiter

<comment>Return:</comment>
  <info>float</info>  'e' à la puissance <strong>$num</strong>, moins un.

<comment>See Also:</comment>
   * <strong>log1p()</strong>
   * <strong>exp()</strong>


id: expression
type: function
doc:
<comment>Description:</comment>
  Bind prepared statement variables as parameters
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  

<comment>Return:</comment>
  <info>object</info>  


id: extension_loaded
type: function
doc:
<comment>Description:</comment>
  Détermine si une extension est chargée ou non
  
  Détermine si une extension est chargée ou non.

<comment>Param:</comment>
  <info>string</info>  <strong>$extension</strong>  Le nom de l'extension. Ce paramètre n'est pas sensible à la casse.
                      
                      Vous pouvez connaître le nom des différentes extensions PHP en utilisant la
                      fonction <strong>phpinfo()</strong> ou bien si vous utilisez la version <return>CGI</return> ou <return>CLI</return> de PHP, vous
                      pouvez utiliser l'option de ligne de commande  <return>-m</return> pour afficher toutes les
                      extensions disponibles :

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si l'extension <strong>$extension</strong> a été chargée, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>get_loaded_extensions()</strong>
   * <strong>get_extension_funcs()</strong>
   * <strong>phpinfo()</strong>
   * <strong>dl()</strong>
   * <strong>function_exists()</strong>


id: extract
type: function
doc:
<comment>Description:</comment>
  Importe les variables dans la table des symboles
  
  Importe les variables dans la table des symboles.
  
  <strong>extract()</strong> vérifie chaque clé afin de contrôler si elle a un nom de variable valide. Elle vérifie
  également les collisions avec des variables existantes dans la table des symboles.
  
  N'utilisez pas <strong>extract()</strong> sur des données non sûres comme les entrées utilisateur (ex. $_GET,
  $_FILES).

<comment>Param:</comment>
  <info>array</info>   <strong>$array</strong>   Un tableau associatif. Cette fonction crée les variables dont les noms sont les
                   index de ce tableau, et leur affecte la valeur associée. Pour chaque paire
                   clé/valeur, <strong>extract()</strong> crée une variable, avec les paramètres <strong>$flags</strong> et <strong>$prefix</strong>.
                   
                   Vous devez utiliser un tableau associatif. Un tableau indexé numériquement ne
                   produira aucun résultat, à moins que vous n'utilisiez l'option <info>EXTR_PREFIX_ALL</info> ou
                   <info>EXTR_PREFIX_INVALID</info>.
  <info>int</info>     <strong>$flags</strong>   Le traitement des collisions est déterminé par <strong>$flags</strong>. Ce paramètre peut prendre
                   une des valeurs suivantes : <info>EXTR_OVERWRITE</info> Lors d'une collision, réécrire la
                   variable existante. <info>EXTR_SKIP</info> Lors d'une collision, ne pas réécrire la variable
                   existante. <info>EXTR_PREFIX_SAME</info> Lors d'une collision, ajouter le préfixe <strong>$prefix</strong>, et
                   créer une nouvelle variable. <info>EXTR_PREFIX_ALL</info> Ajouter le préfixe <strong>$prefix</strong> pour
                   toutes les variables. <info>EXTR_PREFIX_INVALID</info> Préfixer uniquement les variables aux
                   noms invalides ou numériques avec le préfixe <strong>$prefix</strong>. <info>EXTR_IF_EXISTS</info> Écrase la
                   variable uniquement si elle existe déjà dans la table des symboles, et, sinon, ne
                   rien faire. Ceci est pratique pour définir une liste de variables valides, puis
                   extraire du tableau les valeurs que vous avez déjà définies grâce à $_REQUEST,
                   par exemple. <info>EXTR_PREFIX_IF_EXISTS</info> Ne crée que des variables préfixées, si la
                   version non préfixée de la même variable existe dans la table des symboles
                   courante. <info>EXTR_REFS</info> Extrait les variables sous forme de références. Cela signifie
                   que les valeurs des variables importées font toujours référence aux valeurs des
                   variables d'origine dans le paramètre <strong>$array</strong>. Vous pouvez utiliser cette option
                   seule, ou bien la combiner avec d'autres options avec l'opérateur OR, dans le
                   paramètre <strong>$flags</strong>.
                   
                   Lors d'une collision, réécrire la variable existante.
                   
                   Lors d'une collision, ne pas réécrire la variable existante.
                   
                   Lors d'une collision, ajouter le préfixe <strong>$prefix</strong>, et créer une nouvelle variable.
                   
                   Ajouter le préfixe <strong>$prefix</strong> pour toutes les variables.
                   
                   Préfixer uniquement les variables aux noms invalides ou numériques avec le
                   préfixe <strong>$prefix</strong>.
                   
                   Écrase la variable uniquement si elle existe déjà dans la table des symboles, et,
                   sinon, ne rien faire. Ceci est pratique pour définir une liste de variables
                   valides, puis extraire du tableau les valeurs que vous avez déjà définies grâce à
                   $_REQUEST, par exemple.
                   
                   Ne crée que des variables préfixées, si la version non préfixée de la même
                   variable existe dans la table des symboles courante.
                   
                   Extrait les variables sous forme de références. Cela signifie que les valeurs des
                   variables importées font toujours référence aux valeurs des variables d'origine
                   dans le paramètre <strong>$array</strong>. Vous pouvez utiliser cette option seule, ou bien la
                   combiner avec d'autres options avec l'opérateur OR, dans le paramètre <strong>$flags</strong>.
                   
                   Si <strong>$flags</strong> est omis, <strong>extract()</strong> utilisera <info>EXTR_OVERWRITE</info> par défaut.
  <info>string</info>  <strong>$prefix</strong>  Lors d'une collision, ajouter le préfixe <strong>$prefix</strong>, et créer une nouvelle variable.
  <info>string</info>  <strong>$prefix</strong>  Ajouter le préfixe <strong>$prefix</strong> pour toutes les variables.
  <info>string</info>  <strong>$prefix</strong>  Préfixer uniquement les variables aux noms invalides ou numériques avec le
                   préfixe <strong>$prefix</strong>.
  <info>array</info>   <strong>$array</strong>   Extrait les variables sous forme de références. Cela signifie que les valeurs des
                   variables importées font toujours référence aux valeurs des variables d'origine
                   dans le paramètre <strong>$array</strong>. Vous pouvez utiliser cette option seule, ou bien la
                   combiner avec d'autres options avec l'opérateur OR, dans le paramètre <strong>$flags</strong>.
  <info>string</info>  <strong>$prefix</strong>  Notez que <strong>$prefix</strong> n'est nécessaire que pour les valeurs de <strong>$flags</strong> suivantes :
                   <info>EXTR_PREFIX_SAME</info>, <info>EXTR_PREFIX_ALL</info>, <info>EXTR_PREFIX_INVALID</info> ou <info>EXTR_PREFIX_IF_EXISTS</info>.
                   Si le résultat préfixé n'est pas un nom de variable valide, il ne sera pas
                   importé dans la table des symboles. Les préfixes sont automatiquement séparés de
                   l'index du tableau par un caractère de soulignement.

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de variables importées avec succès dans la table des symboles.

<comment>See Also:</comment>
   * <strong>compact()</strong>
   * <strong>list()</strong>


id: ezmlm_hash
type: function
doc:
<comment>Description:</comment>
  Calcule le hachage demandé par EZMLM
  
  <strong>ezmlm_hash()</strong> calcule le hachage nécessaire lors de la gestion de listes de diffusion EZMLM avec
  une base de données MySQL.

<comment>Param:</comment>
  <info>string</info>  <strong>$addr</strong>  L'adresse E-Mail qui doit être hachée.

<comment>Return:</comment>
  <info>int</info>  La valeur du hachage de <strong>$addr</strong>.


id: fann_cascadetrain_on_data
type: function
doc:
<comment>Description:</comment>
  Trains on an entire dataset, for a period of time using the Cascade2 training algorithm
  
  The cascade output change fraction is a number between 0 and 1 determining how large a fraction
  the <strong>fann_get_MSE()</strong> value should change within <strong>fann_get_cascade_output_stagnation_epochs()</strong> during
  training of the output connections, in order for the training not to stagnate.  If the training
  stagnates, the training of the output connections will be ended and new candidates will be
  prepared.
  
  This training uses the parameters set using the fann_set_cascade_..., but it also uses another
  training algorithm as it’s internal training algorithm. This algorithm can be set to either
  <info>FANN_TRAIN_RPROP</info> or <info>FANN_TRAIN_QUICKPROP</info> by <strong>fann_set_training_algorithm()</strong>, and the parameters set
  for these training algorithms will also affect the cascade training.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      Ressource de réseau de neurones.
  <info>resource</info>  <strong>$data</strong>                     Ressource de données d'entrainement du réseau de neurones.
  <info>int</info>       <strong>$max_neurons</strong>              The maximum number of neurons to be added to neural network.
  <info>int</info>       <strong>$neurons_between_reports</strong>  The number of neurons between printing a status report. A
                                      value of zero means no reports should be printed.
  <info>float</info>     <strong>$desired_error</strong>            The desired <strong>fann_get_MSE()</strong> or <strong>fann_get_bit_fail()</strong>, depending
                                      on which stop function is chosen by
                                      <strong>fann_set_train_stop_function()</strong>

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_cascadetrain_on_file()</strong>


id: fann_cascadetrain_on_file
type: function
doc:
<comment>Description:</comment>
  Trains on an entire dataset read from file, for a period of time using the Cascade2 training
  algorithm
  
  Does the same as <strong>fann_cascadetrain_on_data()</strong>, but reads the training data directly from a file.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      Ressource de réseau de neurones.
  <info>string</info>    <strong>$filename</strong>                 A file containing the data for training.
  <info>int</info>       <strong>$max_neurons</strong>              The maximum number of neurons to be added to neural network
  <info>int</info>       <strong>$neurons_between_reports</strong>  The number of neurons between printing a status report. A
                                      value of zero means no reports should be printed.
  <info>float</info>     <strong>$desired_error</strong>            The desired <strong>fann_get_MSE()</strong> or <strong>fann_get_bit_fail()</strong>, depending
                                      on which stop function is chosen by
                                      <strong>fann_set_train_stop_function()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_cascadetrain_on_data()</strong>


id: fann_clear_scaling_params
type: function
doc:
<comment>Description:</comment>
  Clears scaling parameters
  
  Clears scaling parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.


id: fann_copy
type: function
doc:
<comment>Description:</comment>
  Crée une copie d'une structure fann
  
  Crée une copie d'une structure fann.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>resource</info>  Retourne une copie du réseau neuronal en cas de succès, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_test()</strong>


id: fann_create_from_file
type: function
doc:
<comment>Description:</comment>
  Consruit une propagation de retour du réseau neuronal depuis un fichier
     de configuration
  
  Consruit une propagation de retour du réseau neuronal depuis un fichier de configuration, qui a
  été sauvegardée par la fonction <strong>fann_save()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$configuration_file</strong>  Le chemin vers le fichier de configuration.

<comment>Return:</comment>
  <info>resource</info>  Retourne une ressource de réseau de neurones en cas de succès, ou <info>false</info> si une erreur
            survient.

<comment>See Also:</comment>
   * <strong>fann_save()</strong>


id: fann_create_shortcut
type: function
doc:
<comment>Description:</comment>
  Creates a standard backpropagation neural network which is not fully connectected and has shortcut
  connections
  
  Creates a standard backpropagation neural network, which is not fully connected and which also has
  shortcut connections.
  
  Shortcut connections are connections that skip layers. A fully connected network with shortcut
  connections, is a network where all neurons are connected to all neurons in later layers.
  Including direct connections from the input layer to the output layer.

<comment>Param:</comment>
  <info>int</info>  <strong>$num_layers</strong>    The total number of layers including the input and the output layer.
  <info>int</info>  <strong>$num_neurons1</strong>  Number of neurons in the first layer.
  <info>int</info>  <strong>$num_neurons2</strong>  Number of neurons in the second layer.
  <info>int</info>  <strong>$num_neuronsN</strong>  Number of neurons in other layers.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_shortcut_array()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>


id: fann_create_shortcut_array
type: function
doc:
<comment>Description:</comment>
  Crée une propagation de retour standart de réseau neuronal
     qui n'est pas totalement connecté, et a des connexions raccourcies
  
  Crée une propagation de retour standart de réseau neuronal qui n'est pas totalement connecté, et a
  des connexions raccourcies en utilisant un tableau de tailles de couches.

<comment>Param:</comment>
  <info>int</info>    <strong>$num_layers</strong>  Le nombre total de couches, incluant les couches d'entrée et de sortie.
  <info>array</info>  <strong>$layers</strong>      Un tableau de tailles de couches.

<comment>Return:</comment>
  <info>resource</info>  Retourne une ressource représentant le réseau neurinal en cas de succès, ou <info>false</info> si une
            erreur survient.

<comment>See Also:</comment>
   * <strong>fann_create_shortcut()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>


id: fann_create_sparse
type: function
doc:
<comment>Description:</comment>
  Creates a standard backpropagation neural network, which is not fully connected
  
  Creates a standard backpropagation neural network, which is not fully connected.

<comment>Param:</comment>
  <info>float</info>  <strong>$connection_rate</strong>  The connection rate controls how many connections there will be in the
                           network. If the connection rate is set to 1, the network will be fully
                           connected, but if it is set to 0.5 only half of the connections will be
                           set. A connection rate of 1 will yield the same result as
                           <strong>fann_create_standard()</strong>.
  <info>int</info>    <strong>$num_layers</strong>       The total number of layers including the input and the output layer.
  <info>int</info>    <strong>$num_neurons1</strong>     Number of neurons in the first layer.
  <info>int</info>    <strong>$num_neurons2</strong>     Number of neurons in the second layer.
  <info>int</info>    <strong>$num_neuronsN</strong>     Number of neurons in other layers.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_sparse_array()</strong>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_sparse_array
type: function
doc:
<comment>Description:</comment>
  Creates a standard backpropagation neural network, which is not fully connected using an array of
  layer sizes
  
  Creates a standard backpropagation neural network, which is not fully connected using an array of
  layer sizes.

<comment>Param:</comment>
  <info>float</info>  <strong>$connection_rate</strong>  The connection rate controls how many connections there will be in the
                           network. If the connection rate is set to 1, the network will be fully
                           connected, but if it is set to 0.5 only half of the connections will be
                           set. A connection rate of 1 will yield the same result as
                           <strong>fann_create_standard()</strong>.
  <info>int</info>    <strong>$num_layers</strong>       The total number of layers including the input and the output layer.
  <info>array</info>  <strong>$layers</strong>           An array of layer sizes.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_standard
type: function
doc:
<comment>Description:</comment>
  Creates a standard fully connected backpropagation neural network
  
  Creates a standard fully connected backpropagation neural network.
  
  There will be a bias neuron in each layer (except the output layer), and this bias neuron will be
  connected to all neurons in the next layer. When running the network, the bias nodes always emits
  1.
  
  To destroy a neural network use the <strong>fann_destroy()</strong> function.

<comment>Param:</comment>
  <info>int</info>  <strong>$num_layers</strong>    The total number of layers including the input and the output layer.
  <info>int</info>  <strong>$num_neurons1</strong>  Number of neurons in the first layer.
  <info>int</info>  <strong>$num_neurons2</strong>  Number of neurons in the second layer.
  <info>int</info>  <strong>$num_neuronsN</strong>  Number of neurons in other layers.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_standard_array()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_standard_array
type: function
doc:
<comment>Description:</comment>
  Creates a standard fully connected backpropagation neural network using an array of layer sizes
  
  Creates a standard fully connected backpropagation neural network.
  
  There will be a bias neuron in each layer (except the output layer), and this bias neuron will be
  connected to all neurons in the next layer. When running the network, the bias nodes always emits
  1.
  
  To destroy a neural network use the <strong>fann_destroy()</strong> function.

<comment>Param:</comment>
  <info>int</info>    <strong>$num_layers</strong>  The total number of layers including the input and the output layer.
  <info>array</info>  <strong>$layers</strong>      An array of layer sizes.

<comment>Return:</comment>
  <info>resource</info>  Returns a neural network resource on success, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_create_standard()</strong>
   * <strong>fann_create_sparse()</strong>
   * <strong>fann_create_shortcut()</strong>


id: fann_create_train
type: function
doc:
<comment>Description:</comment>
  Crée une structure vide de données d'entrainement
  
  Crée une structure vide de données d'entrainement.

<comment>Param:</comment>
  <info>int</info>  <strong>$num_data</strong>    Le nombre de données d'entrainement
  <info>int</info>  <strong>$num_input</strong>   Le nombre d'entrées par données d'entrainement
  <info>int</info>  <strong>$num_output</strong>  Le nombre de sorties par données d'entrainement

<comment>Return:</comment>
  <info>resource</info>  Retourne une ressource de données d'entrainement en cas de succès, ou <info>false</info> si une
            erreur survient.

<comment>See Also:</comment>
   * <strong>fann_read_train_from_file()</strong>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


id: fann_create_train_from_callback
type: function
doc:
<comment>Description:</comment>
  Crée la structure de données d'entrainement depuis une fonction
     fournie par l'utilisateur
  
  Crée la structure de données d'entrainement depuis une fonction fournie par l'utilisateur. Sachant
  que les données d'entrainement sont numérotées (donnée 1, donnée 2...), l'utilisateur doit écrire
  une fonction qui reçoit le numéro du jeu de données d'entrainement (d'entrée et de sortie) et elle
  doit retourner le jeu.

<comment>Param:</comment>
  <info>int</info>       <strong>$num_data</strong>       Le nombre de données d'entrainement
  <info>int</info>       <strong>$num_input</strong>      Le nombre d'entrées par données d'entrainement
  <info>int</info>       <strong>$num_output</strong>     Le nombre de sorties par données d'entrainement
  <info>callable</info>  <strong>$user_function</strong>  La fonction fournie par l'utilisateur doit avoir les paramètres suivants
                            : <return>num</return> - Le nombre de données d'entrainement <return>num_input</return> - Le nombre
                            d'entrées par données d'entrainement <return>num_output</return> - Le nombre de sorties
                            par données d'entrainement
                            
                            La fonction doit retourner un tableau associatif avec les clés <return>input</return> et
                            <return>output</return> et deux valeurs de tableaux pour les entrées et les sorties.

<comment>Return:</comment>
  <info>resource</info>  Retourne une ressource de données d'entrainement en cas de succès, ou <info>false</info> si une
            erreur survient.

<comment>See Also:</comment>
   * <strong>fann_read_train_from_file()</strong>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


id: fann_descale_input
type: function
doc:
<comment>Description:</comment>
  Scale data in input vector after get it from ann based on previously calculated parameters
  
  Scale data in input vector after get it from ann based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           Ressource de réseau de neurones.
  <info>array</info>     <strong>$input_vector</strong>  Input vector that will be descaled

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_scale_input()</strong>
   * <strong>fann_descale_output()</strong>


id: fann_descale_output
type: function
doc:
<comment>Description:</comment>
  Scale data in output vector after get it from ann based on previously calculated parameters
  
  Scale data in output vector after get it from ann based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            Ressource de réseau de neurones.
  <info>array</info>     <strong>$output_vector</strong>  Output vector that will be descaled

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_scale_output()</strong>
   * <strong>fann_descale_input()</strong>


id: fann_descale_train
type: function
doc:
<comment>Description:</comment>
  Descale input and output data based on previously calculated parameters
  
  Descale input and output data based on previously calculated parameters.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         Ressource de réseau de neurones.
  <info>resource</info>  <strong>$train_data</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_scale_train()</strong>
   * <strong>fann_set_scaling_params()</strong>


id: fann_destroy
type: function
doc:
<comment>Description:</comment>
  Détruit le réseau en entier, et libère proprement toute la mémoire associée
  
  Détruit le réseau en entier, et libère proprement toute la mémoire associée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.


id: fann_destroy_train
type: function
doc:
<comment>Description:</comment>
  Détruit les données d'entrainement
  
  Détruit les données d'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.


id: fann_duplicate_train_data
type: function
doc:
<comment>Description:</comment>
  Retourne une copie exact des données d'entrainement fann
  
  Retourne une copie exact des données d'entrainement fann, sous la forme d'une ressource.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>resource</info>  Retourne une ressource de données d'entrainement en cas de succès, ou <info>false</info> si une
            erreur survient.


id: fann_get_MSE
type: function
doc:
<comment>Description:</comment>
  Reads the mean square error from the network
  
  Reads the mean square error from the network.
  
  Reads the mean square error from the network. This value is calculated during training or testing
  and can therefore sometimes be a bit off if the weights have been changed since the last
  calculation of the value.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  The mean square error, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_test_data()</strong>


id: fann_get_activation_function
type: function
doc:
<comment>Description:</comment>
  Returns the activation function
  
  Get the activation function for neuron number <return>neuron</return> in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to get activation functions for the neurons in the input layer.
  
  The return value is one of the activation functions constants.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>     Ressource de réseau de neurones.
  <info>int</info>       <strong>$layer</strong>   Layer number.
  <info>int</info>       <strong>$neuron</strong>  Neuron number.

<comment>Return:</comment>
  <info>int</info>  Learning functions constant or -1 if the neuron is not defined in the neural network, or
       <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_get_activation_steepness
type: function
doc:
<comment>Description:</comment>
  Returns the activation steepness for supplied neuron and layer number
  
  Get the activation steepness for neuron number <return>neuron</return> in layer number <return>layer</return>, counting the input
  layer as layer 0.
  
  It is not possible to get activation steepness for the neurons in the input layer.
  
  The steepness of an activation function says something about how fast the activation function goes
  from the minimum to the maximum.  A high value for the activation function will also give a more
  aggressive training.
  
  When training neural networks where the output values should be at the extremes (usually 0 and 1,
  depending on the activation function), a steep activation function can be used (e.g.  1.0).
  
  The default activation steepness is 0.5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>     Ressource de réseau de neurones.
  <info>int</info>       <strong>$layer</strong>   Layer number
  <info>int</info>       <strong>$neuron</strong>  Neuron number

<comment>Return:</comment>
  <info>float</info>  The activation steepness for the neuron or -1 if the neuron is not defined in the neural
         network, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_get_bias_array
type: function
doc:
<comment>Description:</comment>
  Get the number of bias in each layer in the network
  
  Get the number of bias in each layer in the network.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>array</info>  An array of numbers of bias in each layer


id: fann_get_bit_fail
type: function
doc:
<comment>Description:</comment>
  The number of fail bits
  
  The number of fail bits; means the number of output neurons which differ more than the bit fail
  limit (see <strong>fann_get_bit_fail_limit()</strong>, <strong>fann_set_bit_fail_limit()</strong>). The bits are counted in all of
  the training data, so this number can be higher than the number of training data.
  
  This value is reset by <strong>fann_reset_MSE()</strong> and updated by all the same functions which also updates
  the MSE value (e.g. <strong>fann_test_data()</strong>, <strong>fann_train_epoch()</strong>)

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  The number of bits fail, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_reset_MSE()</strong>
   * <strong>fann_test_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail_limit()</strong>
   * <strong>fann_set_bit_fail_limit()</strong>


id: fann_get_bit_fail_limit
type: function
doc:
<comment>Description:</comment>
  Returns the bit fail limit used during training
  
  Returns the bit fail limit used during training.
  
  The bit fail limit is used during training where the stop function is set to <info>FANN_STOPFUNC_BIT</info>.
  
  The limit is the maximum accepted difference between the desired output and the actual output
  during training. Each output that diverges more than this limit is counted as an error bit. This
  difference is divided by two when dealing with symmetric activation functions, so that symmetric
  and not symmetric activation functions can use the same limit.
  
  The default bit fail limit is 0.35.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  The bit fail limit, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_bit_fail_limit()</strong>


id: fann_get_cascade_activation_functions
type: function
doc:
<comment>Description:</comment>
  Returns the cascade activation functions
  
  The cascade activation functions array is an array of the different activation functions used by
  the candidates
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this array.
  
  The default activation functions are <info>FANN_SIGMOID</info>, <info>FANN_SIGMOID_SYMMETRIC</info>, <info>FANN_GAUSSIAN</info>,
  <info>FANN_GAUSSIAN_SYMMETRIC</info>, <info>FANN_ELLIOT</info>, <info>FANN_ELLIOT_SYMMETRIC</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>array</info>  The cascade activation functions, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_activation_functions_count
type: function
doc:
<comment>Description:</comment>
  Returns the number of cascade activation functions
  
  The number of activation functions in the <strong>fann_get_cascade_activation_functions()</strong> array.
  
  The default number of activation functions is 6.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  The number of cascade activation functions, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_activation_steepnesses
type: function
doc:
<comment>Description:</comment>
  Returns the cascade activation steepnesses
  
  The cascade activation steepnesses array is an array of the different activation functions used by
  the candidates.
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this array.
  
  The default activation steepnesses are {0.25, 0.50, 0.75, 1.00}.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>array</info>  The cascade activation steepnesses, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>
   * <strong>fann_set_cascade_activation_steepnesses()</strong>


id: fann_get_cascade_activation_steepnesses_count
type: function
doc:
<comment>Description:</comment>
  The number of activation steepnesses
  
  The number of activation steepnesses in the <strong>fann_get_cascade_activation_functions()</strong> array.
  
  The default number of activation steepnesses is 4.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  The number of activation steepnesses, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_get_cascade_candidate_change_fraction
type: function
doc:
<comment>Description:</comment>
  Returns the cascade candidate change fraction
  
  The cascade candidate change fraction is a number between 0 and 1 determining how large a fraction
  the <strong>fann_get_MSE()</strong> value should change within <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>
  during training of the candidate neurons, in order for the training not to stagnate. If the
  training stagnates, the training of the candidate neurons will be ended and the best candidate
  will be selected.
  
  It means that if the MSE does not change by a fraction of
  <strong>fann_get_cascade_candidate_change_fraction()</strong> during a period of
  <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>, the training of the candidate neurons is stopped
  because the training has stagnated.
  
  If the cascade candidate change fraction is low, the candidate neurons will be trained more and if
  the fraction is high they will be trained less.
  
  The default cascade candidate change fraction is 0.01, which is equalent to a 1% change in MSE.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  The cascade candidate change fraction, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_candidate_change_fraction()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>


id: fann_get_cascade_candidate_limit
type: function
doc:
<comment>Description:</comment>
  Return the candidate limit
  
  The candidate limit is a limit for how much the candidate neuron may be trained. The limit is a
  limit on the proportion between the MSE and candidate score.
  
  Set this to a lower value to avoid overfitting and to a higher if overfitting is not a problem.
  
  The default candidate limit is 1000.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  The candidate limit, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_candidate_limit()</strong>


id: fann_get_cascade_candidate_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the number of cascade candidate stagnation epochs
  
  The number of cascade candidate stagnation epochs determines the number of epochs training is
  allowed to continue without changing the MSE by a fraction of
  <strong>fann_get_cascade_candidate_change_fraction()</strong>.
  
  See more info about this parameter in <strong>fann_get_cascade_candidate_change_fraction()</strong>.
  
  The default number of cascade candidate stagnation epochs is 12.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  The number of cascade candidate stagnation epochs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_candidate_stagnation_epochs()</strong>
   * <strong>fann_get_cascade_candidate_change_fraction()</strong>


id: fann_get_cascade_max_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the maximum candidate epochs
  
  The maximum candidate epochs determines the maximum number of epochs the input connections to the
  candidates may be trained before adding a new candidate neuron.
  
  The default max candidate epochs is 150.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  The maximum candidate epochs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_max_cand_epochs()</strong>


id: fann_get_cascade_max_out_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the maximum out epochs
  
  The maximum out epochs determines the maximum number of epochs the output connections may be
  trained after adding a new candidate neuron.
  
  The default max out epochs is 150.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  The maximum out epochs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_max_out_epochs()</strong>


id: fann_get_cascade_min_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the minimum candidate epochs
  
  The minimum candidate epochs determines the minimum number of epochs the input connections to the
  candidates may be trained before adding a new candidate neuron.
  
  The default min candidate epochs is 50.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  The minimum candidate epochs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_min_cand_epochs()</strong>


id: fann_get_cascade_min_out_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the minimum out epochs
  
  The minimum out epochs determines the minimum number of epochs the output connections must be
  trained after adding a new candidate neuron.
  
  The default min out epochs is 50.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  The minimum out epochs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_min_out_epochs()</strong>


id: fann_get_cascade_num_candidate_groups
type: function
doc:
<comment>Description:</comment>
  Returns the number of candidate groups
  
  The number of candidate groups is the number of groups of identical candidates which will be used
  during training.
  
  This number can be used to have more candidates without having to define new parameters for the
  candidates.
  
  See <strong>fann_get_cascade_num_candidates()</strong> for a description of which candidate neurons will be
  generated by this parameter.
  
  The default number of candidate groups is 2.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  The number of candidate groups, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_num_candidate_groups()</strong>


id: fann_get_cascade_num_candidates
type: function
doc:
<comment>Description:</comment>
  Returns the number of candidates used during training
  
  The number of candidates used during training (calculated by multiplying
  <strong>fann_get_cascade_activation_functions_count()</strong>, <strong>fann_get_cascade_activation_steepnesses_count()</strong> and
  <strong>fann_get_cascade_num_candidate_groups()</strong>).
  
  The actual candidates is defined by the <strong>fann_get_cascade_activation_functions()</strong> and
  <strong>fann_get_cascade_activation_steepnesses()</strong> arrays. These arrays define the activation functions and
  activation steepnesses used for the candidate neurons. If there are 2 activation functions in the
  activation function array and 3 steepnesses in the steepness array, then there will be 2x3=6
  different candidates which will be trained. These 6 different candidates can be copied into
  several candidate groups, where the only difference between these groups is the initial weights.
  If the number of groups is set to 2, then the number of candidate neurons will be 2x3x2=12. The
  number of candidate groups is defined by <strong>fann_set_cascade_num_candidate_groups()</strong>.
  
  The default number of candidates is 6x4x2 = 48

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  The number of candidates used during training, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions()</strong>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>
   * <strong>fann_get_cascade_num_candidate_groups()</strong>


id: fann_get_cascade_output_change_fraction
type: function
doc:
<comment>Description:</comment>
  Returns the cascade output change fraction
  
  The cascade output change fraction is a number between 0 and 1 determining how large a fraction of
  the <strong>fann_get_MSE()</strong> value should change within <strong>fann_get_cascade_output_stagnation_epochs()</strong> during
  training of the output connections, in order for the training not to stagnate. If the training
  stagnates, the training of the output connections will be ended and new candidates will be
  prepared.
  
  It means that if the MSE does not change by a fraction of
  <strong>fann_get_cascade_output_change_fraction()</strong> during a period of
  <strong>fann_get_cascade_output_stagnation_epochs()</strong>, the training of the output connections is stopped
  because the training has stagnated.
  
  If the cascade output change fraction is low, the output connections will be trained more and if
  the fraction is high, they will be trained less.
  
  The default cascade output change fraction is 0.01, which is equalent to a 1% change in MSE.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  The cascade output change fraction, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_output_change_fraction()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_cascade_output_stagnation_epochs()</strong>


id: fann_get_cascade_output_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Returns the number of cascade output stagnation epochs
  
  The number of cascade output stagnation epochs determines the number of epochs training is allowed
  to continue without changing the MSE by a fraction of <strong>fann_get_cascade_output_change_fraction()</strong>.
  
  See more info about this parameter in <strong>fann_get_cascade_output_change_fraction()</strong>.
  
  The default number of cascade output stagnation epochs is 12.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  The number of cascade output stagnation epochs, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_output_stagnation_epochs()</strong>
   * <strong>fann_get_cascade_output_change_fraction()</strong>


id: fann_get_cascade_weight_multiplier
type: function
doc:
<comment>Description:</comment>
  Returns the weight multiplier
  
  The weight multiplier is a parameter which is used to multiply the weights from the candidate
  neuron before adding the neuron to the neural network. This parameter is usually between 0 and 1,
  and is used to make the training a bit less aggressive.
  
  The default weight multiplier is 0.4.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  The weight multiplier, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_cascade_weight_multiplier()</strong>


id: fann_get_connection_array
type: function
doc:
<comment>Description:</comment>
  Récupère les connexions dans le réseau
  
  Récupère les connexions dans le réseau.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>array</info>  Un tableau de connexions dans le réseau.


id: fann_get_connection_rate
type: function
doc:
<comment>Description:</comment>
  Récupère le taux de connexion lorsque le réseau a été créé
  
  Récupère le taux de connexion lorsque le réseau a été créé.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  Le taux de connexion utilisé lorsque le réseau a été créé, ou <info>false</info> si une erreur survient.


id: fann_get_errno
type: function
doc:
<comment>Description:</comment>
  Retourne le numéro de la dernière erreur
  
  Retourne le numéro de la dernière erreur.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Soit une ressource de réseau de neurones, soit une ressource de données
                     d'entrainement d'un réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  Le numéro de l'erreur, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_reset_errno()</strong>
   * <strong>fann_get_errstr()</strong>


id: fann_get_errstr
type: function
doc:
<comment>Description:</comment>
  Retourne le dernier message d'erreur
  
  Retourne le dernier message d'erreur.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Soit une ressource de réseau de neurones, soit une ressource de données
                     d'entrainement d'un réseau de neurones.

<comment>Return:</comment>
  <info>string</info>  Le dernier message d'erreur, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_reset_errstr()</strong>
   * <strong>fann_get_errno()</strong>


id: fann_get_layer_array
type: function
doc:
<comment>Description:</comment>
  Get the number of neurons in each layer in the network
  
  Get the number of neurons in each layer in the neural network.
  
  Bias is not included so the layers match the fann_create functions.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>array</info>  An array of numbers of neurons in each leayer


id: fann_get_learning_momentum
type: function
doc:
<comment>Description:</comment>
  Returns the learning momentum
  
  The learning momentum can be used to speed up <info>FANN_TRAIN_INCREMENTAL</info> training. A too high momentum
  will however not benefit training. Setting momentum to 0 will be the same as not using the
  momentum parameter. The recommended value of this parameter is between 0.0 and 1.0.
  
  The default momentum is 0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.
         
         The learning momentum, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_learning_momentum()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_get_learning_rate
type: function
doc:
<comment>Description:</comment>
  Returns the learning rate
  
  The learning rate is used to determine how aggressive training should be for some of the training
  algorithms (<info>FANN_TRAIN_INCREMENTAL</info>, <info>FANN_TRAIN_BATCH</info>, <info>FANN_TRAIN_QUICKPROP</info>). Do however note that
  it is not used in <info>FANN_TRAIN_RPROP</info>.
  
  The default learning rate is 0.7.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  The learning rate, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_learning_rate()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_get_network_type
type: function
doc:
<comment>Description:</comment>
  Get the type of neural network it was created as
  
  Get the type of neural network it was created as.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  Network type constant, or <info>false</info> on error.


id: fann_get_num_input
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre de neurones entrants
  
  Récupère le nombre de neurones entrants.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  Le nombre de neurones entrants, ou <info>false</info> si une erreur survient.


id: fann_get_num_layers
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre de couches du réseau neuronal
  
  Récupère le nombre de couches du réseau neuronal.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  Le nombre de couches du réseau neuronal, ou <info>false</info> si une erreur survient.


id: fann_get_num_output
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre de neurones sortants
  
  Récupère le nombre de neurones sortants.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  Le nombre de neurones sortants, ou <info>false</info> si une erreur survient.


id: fann_get_quickprop_decay
type: function
doc:
<comment>Description:</comment>
  Returns the decay which is a factor that weights should decrease in each iteration during
  quickprop
  training
  
  The decay is a small negative valued number which is a factor that the weights should decrease in
  each iteration during quickprop training. This is used to make sure that the weights do not become
  too high during training.
  
  The default decay is -0.0001.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  The decay, or <info>false</info> on error.

<comment>See Also:</comment>
   * <strong>fann_set_quickprop_decay()</strong>


id: fann_get_quickprop_mu
type: function
doc:
<comment>Description:</comment>
  Retourne le facteur mu
  
  Le facteur mu est utilisé pour accroître et décroitre la taille de l'étape durant l'entrainement
  quickprop. Le facteur mu doit toujours être inférieur à 1, sachant que sinon, il va décroitre la
  taille de l'étape alors qu'il est supposé l'accroitre.
  
  Le facteur mu par défaut est 1.75.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  Le facteur mu, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_quickprop_mu()</strong>


id: fann_get_rprop_decrease_factor
type: function
doc:
<comment>Description:</comment>
  Retourne le facteur d'accroissement utilisé pendant l'entrainement RPROP
  
  Le facteur de décroissement est une valeur plus petite que 1, qui est utilisé pour décroitre la
  taille de l'étape pendant l'entrainement RPROP.
  
  Le facteur de décroissement par défaut est 0.5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  Le facteur de décroissement, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_rprop_decrease_factor()</strong>


id: fann_get_rprop_delta_max
type: function
doc:
<comment>Description:</comment>
  Retourne la taille maximale de l'étape
  
  La taille maximale de l'étape est un nombre positif déterminant combien la taille de l'étape peut
  être au maximum.
  
  Le delta maximal par défaut est de 50.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  La taille maximale de l'étape, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_rprop_delta_max()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>


id: fann_get_rprop_delta_min
type: function
doc:
<comment>Description:</comment>
  Retourne la taille minimale de l'étape
  
  La taille minimale de l'étape est un petit nombre positif déterminant combien la taille de l'étape
  peut être au minimal.
  
  La valeur minimale du delta par défaut est de 0.0.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  La taille minimale de l'étape, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_rprop_delta_min()</strong>


id: fann_get_rprop_delta_zero
type: function
doc:
<comment>Description:</comment>
  Retourne la taille initiale de l'étape
  
  La taille initiale de l'étape est un nombre positif déterminant la taille initialie de l'étape.
  
  Le delta par défaut est de 0.1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  La taille initiale de l'étape, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_rprop_delta_zero()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>
   * <strong>fann_get_rprop_delta_max()</strong>


id: fann_get_rprop_increase_factor
type: function
doc:
<comment>Description:</comment>
  Retourne le facteur croissant utilisé pendant l'entrainement RPROP
  
  Le facteur croissant est une valeur supérieure à 1, qui est utilisé pour croitre la taille de
  l'étape pendant l'entrainement RPROP.
  
  Le facteur croissant par défaut est de 1.2.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  Le facteur croissant, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_rprop_increase_factor()</strong>


id: fann_get_sarprop_step_error_shift
type: function
doc:
<comment>Description:</comment>
  Retourne le décalage de l'erreur lors de l'étape sarprop
  
  Retourne le décalage de l'erreur lors de l'étape sarprop.
  
  Le décalage par défaut de l'erreur lors de l'étape est 1.385.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  Le décalage de l'erreur lors de l'étape sarprop, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_sarprop_step_error_shift()</strong>


id: fann_get_sarprop_step_error_threshold_factor
type: function
doc:
<comment>Description:</comment>
  Retourne le facteur de seuil d'erreur lors de l'étape sarprop
  
  Retourne le facteur de seuil d'erreur lors de l'étape sarprop.
  
  Le facteur par défaut est 0.1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  Le facteur de seuil d'erreur lors de l'étape sarprop, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_sarprop_step_error_threshold_factor()</strong>


id: fann_get_sarprop_temperature
type: function
doc:
<comment>Description:</comment>
  Retourne la température sarprop
  
  Retourne la température sarprop.
  
  La température par défaut est 0.015.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  La température sarprop, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_sarprop_temperature()</strong>


id: fann_get_sarprop_weight_decay_shift
type: function
doc:
<comment>Description:</comment>
  Retourne le changement décroissant du poids sarprop
  
  Le changement décroissant du poids sarprop.
  
  Le delta maximal par défaut est -6.644.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  Le changement décroissant du poids sarprop, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_sarprop_weight_decay_shift()</strong>


id: fann_get_total_connections
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre total de connexions dans la totalité du réseau
  
  Récupère le nombre total de connexions dans la totalité du réseau.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  Le nombre total de connexions dans la totalité du réseau, ou <info>false</info> si une erreur survient.


id: fann_get_total_neurons
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre total de neurones dans la totalité du réseau
  
  Récupère le nombre total de neurones dans la totalité du réseau. Ce nombre n'inclut pas les
  neurones de polarisation - un réseau 2-4-2 a 2+4+2 +2(polarisants) = 10 neurones.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  Le nombre total de neurones dans la totalité du réseau, ou <info>false</info> si une erreur survient.


id: fann_get_train_error_function
type: function
doc:
<comment>Description:</comment>
  Retourne la fonction d'erreur utilisée pendant l'entrainement
  
  Retourne la fonction d'erreur utilisée pendant l'entrainement.
  
  Les fonctions d'erreur sont décrites dans la page sur les constantes des fonctions d'erreur.
  
  La fonction d'erreur par défaut est <info>FANN_ERRORFUNC_TANH</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  La constante de fonction d'erreur ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_train_error_function()</strong>


id: fann_get_train_stop_function
type: function
doc:
<comment>Description:</comment>
  Retourne la fonction d'arrêt utilisée pendant l'entrainement
  
  Retourne la fonction d'arrêt utilisée pendant l'entrainement.
  
  Les fonctions d'arrêt sont décrites dans les constantes des fonctions d'arrêt.
  
  La fonction d'arrêt par défaut est <info>FANN_STOPFUNC_MSE</info>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  La constante de fonction d'arrêt, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_train_stop_function()</strong>


id: fann_get_training_algorithm
type: function
doc:
<comment>Description:</comment>
  Retourne l'algorithme d'entrainement
  
  Retourne l'algorithme d'entrainement. Cet algorithme d'entrainement est utilisé par
  <strong>fann_train_on_data()</strong> et les fonctions associées.
  
  Notez que cet algorithme est également utilisé pendant <strong>fann_cascadetrain_on_data()</strong>, bien que
  seules les constantes <info>FANN_TRAIN_RPROP</info> et <info>FANN_TRAIN_QUICKPROP</info> sont autorisées pendant
  l'entrainement en cascade.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  La constante de l'algorithme d'entrainement ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_init_weights
type: function
doc:
<comment>Description:</comment>
  Initialise les poids en utilisant les algorythme Widrow et Nguyen
  
  Initialise les poids en utilisant les algorythme Widrow et Nguyen.
  
  Cette fonction a un fonctionnement similaire à la fonction <strong>fann_randomize_weights()</strong>. Elle va
  utiliser l'algorythme développé par Derrick Nguyen et Bernard Widrow pour définir les poids de
  telle façon à ce que l'entrainement devienne plus rapide. Cette technique n'est pas toujours
  couronnée de succès, et dans quelques cas, peut être moins efficace qu'une initialisation purement
  aléatoire.
  
  L'algorythme requiert l'accès à l'intervalle de données entrantes (par exemple, les entrées la
  plus petit et la plus grande), et aceepte aussi un second argument, les données, qui sont les
  données d'entrainement qui seront utilisés pour l'entrainement du réseau.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         Ressource de réseau de neurones.
  <info>resource</info>  <strong>$train_data</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_randomize_weights()</strong>
   * <strong>fann_read_train_from_file()</strong>


id: fann_length_train_data
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de masques d'entrainement dans les données d'entrainement
  
  Retourne le nombre de masques d'entrainement dans les données d'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  Le nombre d'éléments dans les données d'entrainement, ou <info>false</info> si une erreur survient.


id: fann_merge_train_data
type: function
doc:
<comment>Description:</comment>
  Fusionne les données d'entrainement
  
  Fusionne les données data1 et data2 dans un nouveau jeux de données d'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data1</strong>  Ressource de données d'entrainement du réseau de neurones.
  <info>resource</info>  <strong>$data2</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>resource</info>  Nouveau jeux de données d'entrainement, ou <info>false</info> si une erreur survient.


id: fann_num_input_train_data
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre d'entrées dans chaque masque d'entrainement dans les données d'entrainement
  
  Retourne le nombre d'entrées dans chaque masque d'entrainement dans les données d'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  Le nombre d'entrées, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_length_train_data()</strong>
   * <strong>fann_num_output_train_data()</strong>


id: fann_num_output_train_data
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de sortie dans chaque masque d'entrainement dans les données d'entrainement
  
  Retourne le nombre de sortie dans chaque masque d'entrainement dans les données d'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>int</info>  Le nombre de sortie, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_length_train_data()</strong>
   * <strong>fann_num_input_train_data()</strong>


id: fann_print_error
type: function
doc:
<comment>Description:</comment>
  Affiche le message d'erreur
  
  Affiche le message d'erreur.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Soit une ressource de réseau de neurones, soit une ressource de données
                     d'entrainement d'un réseau de neurones.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur retournée.

<comment>See Also:</comment>
   * <strong>fann_get_errstr()</strong>


id: fann_randomize_weights
type: function
doc:
<comment>Description:</comment>
  Donne à chaque connexion un poids aléatoire compris entre
     min_weight et max_weight
  
  Donne à chaque connexion un poids aléatoire compris entre <strong>$min_weight</strong> et <strong>$max_weight</strong>.
  
  Depuis le début, les poids sont aléatoires, dans un intervalle -0.1 et 0.1.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         Ressource de réseau de neurones.
  <info>float</info>     <strong>$min_weight</strong>  Valeur minimale du poids
  <info>float</info>     <strong>$max_weight</strong>  Valeur maximale du poids

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_init_weights()</strong>


id: fann_read_train_from_file
type: function
doc:
<comment>Description:</comment>
  Lit un fichier contenant les données d'entrainement
  
  Lit un fichier contenant les données d'entrainement.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le fichier d'entrée au format suivant :

<comment>Return:</comment>
  <info>resource</info>  Retourne une ressource de données d'entrainement en cas de succès, ou <info>false</info> si une
            erreur survient.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_destroy_train()</strong>
   * <strong>fann_save_train()</strong>


id: fann_reset_MSE
type: function
doc:
<comment>Description:</comment>
  Réinitialise l'erreur quadratique moyenne du réseau
  
  Réinitialise l'erreur quadratique moyenne du réseau.
  
  Cette fonction réinitialise également le nombre d'octets en échec.

<comment>Param:</comment>
  <info>string</info>  <strong>$ann</strong>  Ressource de réseau de neurones.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_bit_fail_limit()</strong>


id: fann_reset_errno
type: function
doc:
<comment>Description:</comment>
  Réinitialise le numéro de la dernière erreur
  
  Réinitialise le numéro de la dernière erreur.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Soit une ressource de réseau de neurones, soit une ressource de données
                     d'entrainement d'un réseau de neurones.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur retournée.

<comment>See Also:</comment>
   * <strong>fann_get_errno()</strong>
   * <strong>fann_reset_errstr()</strong>


id: fann_reset_errstr
type: function
doc:
<comment>Description:</comment>
  Réinitialise le message de la dernière erreur
  
  Réinitialise le message de la dernière erreur.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>  Soit une ressource de réseau de neurones, soit une ressource de données
                     d'entrainement d'un réseau de neurones.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur retournée.

<comment>See Also:</comment>
   * <strong>fann_get_errstr()</strong>
   * <strong>fann_reset_errno()</strong>


id: fann_run
type: function
doc:
<comment>Description:</comment>
  Exécute les entrées via le réseau neuronal
  
  Exécute les entrées via le réseau neuronal, retourne un tableau de sorties, le nombre de neurones
  dans la couche de sortie.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>    Ressource de réseau de neurones.
  <info>array</info>     <strong>$input</strong>  Tableau de valeurs d'entrées

<comment>Return:</comment>
  <info>array</info>  Tableau de valeurs de sorties, ou <info>false</info> si une erreur survient.


id: fann_save
type: function
doc:
<comment>Description:</comment>
  Sauvegarde le réseau complet dans un fichier de configuration
  
  Sauvegarde le réseau complet dans un fichier de configuration.
  
  Le fichier de configuration contient toutes les informations sur le réseau neuronal, et active la
  fonction <strong>fann_create_from_file()</strong> pour créer une copie exacte du réseau neuronal, et tous les
  paramètres associés au réseau neuronal.
  
  Ces trois paramètres (<strong>fann_set_callback()</strong>, <strong>fann_set_error_log()</strong>, <strong>fann_set_user_data()</strong>) ne sont PAS
  sauvegardés dans le fichier car ils ne peuvent pas être portés en toute sécurité dans un endroit
  différent. De même, les paramètres temporaires générés pendant l'entrainement comme <strong>fann_get_MSE()</strong>
  ne sont pas sauvegardés.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                 Ressource de réseau de neurones.
  <info>string</info>    <strong>$configuration_file</strong>  Le chemin vers le fichier de configuration.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_create_from_file()</strong>


id: fann_save_train
type: function
doc:
<comment>Description:</comment>
  Sauvegarde la structure d'entrainement dans un fichier
  
  Sauvegarde la structure d'entrainement dans un fichier, dont le format est spécifié dans la
  fonction <strong>fann_read_train_from_file()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>       Ressource de données d'entrainement du réseau de neurones.
  <info>string</info>    <strong>$file_name</strong>  Le nom du fichier où la sauvegarde à lieu.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_read_train_from_file()</strong>


id: fann_scale_input
type: function
doc:
<comment>Description:</comment>
  Met à l'échelle les données dans le vecteur d'entrée
     avant de les donner à ANN, en se basant sur les paramètres précédemment calculés
  
  Met à l'échelle les données dans le vecteur d'entrée avant de les donner à ANN, en se basant sur
  les paramètres précédemment calculés.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           Ressource de réseau de neurones.
  <info>array</info>     <strong>$input_vector</strong>  Vecteur d'entrée qui va être mise à l'échelle

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_descale_input()</strong>
   * <strong>fann_scale_output()</strong>


id: fann_scale_input_train_data
type: function
doc:
<comment>Description:</comment>
  Met à l'échelle les entrées dans les données d'entrainement
     à l'intervalle spécifié
  
  Met à l'échelle les entrées dans les données d'entrainement à l'intervalle spécifié.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  Ressource de données d'entrainement du réseau de neurones.
  <info>float</info>     <strong>$new_min</strong>     Nouveau minimum après la mise à l'échelle des entrées dans les données
                         d'entrainement.
  <info>float</info>     <strong>$new_max</strong>     Nouveau maximum après la mise à l'échelle des entrées dans les données
                         d'entrainement.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_scale_output_train_data()</strong>
   * <strong>fann_scale_train_data()</strong>


id: fann_scale_output
type: function
doc:
<comment>Description:</comment>
  Met à l'échelle les données dans le vecteur de sortie
     avant de les passer à ANN, en se basant sur les paramètres précédemment calculés
  
  Met à l'échelle les données dans le vecteur de sortie avant de les passer à ANN, en se basant sur
  les paramètres précédemment calculés.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            Ressource de réseau de neurones.
  <info>array</info>     <strong>$output_vector</strong>  Vecteur de sortie qui sera mis à l'échelle

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_descale_output()</strong>
   * <strong>fann_scale_input()</strong>


id: fann_scale_output_train_data
type: function
doc:
<comment>Description:</comment>
  Met à l'échelle les sorties dans les données d'entrainement
     à l'intervalle spécifié
  
  Met à l'échelle les sorties dans les données d'entrainement à l'intervalle spécifié.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  Ressource de données d'entrainement du réseau de neurones.
  <info>float</info>     <strong>$new_min</strong>     Nouveau minimum après la mise à l'échelle des sorties dans les données
                         d'entrainement.
  <info>float</info>     <strong>$new_max</strong>     Nouveau maximum après la mise à l'échelle des sorties dans les données
                         d'entrainement.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_scale_input_train_data()</strong>
   * <strong>fann_scale_train_data()</strong>


id: fann_scale_train
type: function
doc:
<comment>Description:</comment>
  Met à l'échelle les données d'entrée et de sortie
     en se basant sur les paramètres précédemment calculés
  
  Met à l'échelle les données d'entrée et de sortie en se basant sur les paramètres précédemment
  calculés.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>         Ressource de réseau de neurones.
  <info>resource</info>  <strong>$train_data</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_descale_train()</strong>
   * <strong>fann_set_scaling_params()</strong>


id: fann_scale_train_data
type: function
doc:
<comment>Description:</comment>
  Met à l'échelle les entrées et les sorties dans les données
     d'entrainement à l'intervalle spécifié
  
  Met à l'échelle les entrées et les sorties dans les données d'entrainement à l'intervalle
  spécifié.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  Ressource de données d'entrainement du réseau de neurones.
  <info>float</info>     <strong>$new_min</strong>     Nouvelle valeur minimale après la mise à l'échelle des entrées et des
                         sorties dans les données d'entrainement.
  <info>float</info>     <strong>$new_max</strong>     Nouvelle valeur maximale après la mise à l'échelle des entrées et des
                         sorties dans les données d'entrainement.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_scale_output_train_data()</strong>
   * <strong>fann_scale_input_train_data()</strong>


id: fann_set_activation_function
type: function
doc:
<comment>Description:</comment>
  Défini la fonction d'activation pour le neurone et la couche spécifiés
  
  Défini la fonction d'activation pour le neurone numéro <return>neuron</return> dans la couche numéro <return>layer</return>, en
  comptant la couche d'entrée comme étant la couche numéro 0.
  
  Il n'est pas possible de définir les fonctions d'activation pour les neurones de la couche
  d'entrée.
  
  Lors du choix d'une fonction d'activation, il est important de noter que les fonctions
  d'activation ont un intervalle différent. <info>FANN_SIGMOID</info> est, i.e. dans l'intervalle 0 - 1 alors que
  <info>FANN_SIGMOID_SYMMETRIC</info> est dans l'intervalle -1 - 1 et <info>FANN_LINEAR</info> n'est pas lié.
  
  La valeur de la fonction d'activation fournie doit être une constante parmi les fonctions
  d'activation.
  
  La valeur retournée est une constante parmi les fonctions d'activation.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  Ressource de réseau de neurones.
  <info>int</info>       <strong>$activation_function</strong>  La constante de fonctions d'activation.
  <info>int</info>       <strong>$layer</strong>                Le numéro de la couche.
  <info>int</info>       <strong>$neuron</strong>               Le numéro du neurone.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_get_activation_function()</strong>


id: fann_set_activation_function_hidden
type: function
doc:
<comment>Description:</comment>
  Défini la fonction d'activation pour toutes les couches cachées
  
  Défini la fonction d'activation pour toutes les couches cachées.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  Ressource de réseau de neurones.
  <info>int</info>       <strong>$activation_function</strong>  La constante de fonctions d'activation.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_function_layer
type: function
doc:
<comment>Description:</comment>
  Défini la fonction d'activation pour tous les neurones de la couche spécifiée
  
  Défini la fonction d'activation pour tous les neurones de la couche dont le numéro est <return>layer</return>, en
  comptant la couche d'entrée comme étant la couche numéro 0.
  
  Il n'est pas possible de définir les fonctions d'activation pour les neurones de la couche
  d'entrée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  Ressource de réseau de neurones.
  <info>int</info>       <strong>$activation_function</strong>  La constante de fonctions d'activation.
  <info>int</info>       <strong>$layer</strong>                Le numéro de la couche.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_function_output()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_function_output
type: function
doc:
<comment>Description:</comment>
  Défini la fonction d'activation pour la couche d'entrée
  
  Défini la fonction d'activation pour la couche d'entrée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  Ressource de réseau de neurones.
  <info>int</info>       <strong>$activation_function</strong>  La constante de fonctions d'activation.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_set_activation_function()</strong>
   * <strong>fann_set_activation_function_layer()</strong>
   * <strong>fann_set_activation_function_hidden()</strong>
   * <strong>fann_set_activation_steepness()</strong>


id: fann_set_activation_steepness
type: function
doc:
<comment>Description:</comment>
  Défini la pente d'activation pour le neurone et le numéro de couche donnés
  
  Défini la pente d'activation pour le neurone numéro <return>neuron</return> dans la couche numéro <return>layer</return>, en
  comptant la couche d'entrée comme la couche numéro 0.
  
  Il n'est pas possible de définir la pente d'activation pour les neurones dans la couche d'entrée.
  
  La pente d'une fonction d'activation indique une valeur signifiant la rapidité de la fonction
  d'activation pour aller du minimum au maximum. Une valeur ahute pour la fonction d'activation va
  également produire un entrainement plus agressif.
  
  Lors d'un entrainement sur des réseaux neuronaux, où les valeurs de sortie doivent être aux
  extrèmes (habituellement, 0 et 1, suivant la fonction d'activation), une fonction de pente
  d'activation peut être utilisée (i.e.  1.0).
  
  La pente d'activation par défaut est 0.5.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   Ressource de réseau de neurones.
  <info>float</info>     <strong>$activation_steepness</strong>  La pente d'activation.
  <info>int</info>       <strong>$layer</strong>                 Le numéro de la couche.
  <info>int</info>       <strong>$neuron</strong>                Le numéro du neurone.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_hidden
type: function
doc:
<comment>Description:</comment>
  Défini la raideur de la pente d'activation pour tous les neurones
     des couches cachées
  
  Défini la raideur de la pente d'activation pour tous les neurones des couches cachées.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   Ressource de réseau de neurones.
  <info>float</info>     <strong>$activation_steepness</strong>  La pente d'activation.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_layer
type: function
doc:
<comment>Description:</comment>
  Défini la pente d'activation pour tous les neurones dans la couche dont le numéro est fourni
  
  Défini la pente d'activation pour tous les neurones dans la couche numéro <return>layer</return>, en comptant la
  couche d'entrée comme la couche numéro 0.
  
  Il n'est pas possible de définir la pente d'activation pour les neurones de la couche d'entrée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   Ressource de réseau de neurones.
  <info>float</info>     <strong>$activation_steepness</strong>  La pente d'activation.
  <info>int</info>       <strong>$layer</strong>                 Le numéro de la couche.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_set_activation_steepness_output()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_activation_steepness_output
type: function
doc:
<comment>Description:</comment>
  Défini la raideur de la pente d'activation dans la couche de sortie
  
  Défini la raideur de la pente d'activation dans la couche de sortie.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                   Ressource de réseau de neurones.
  <info>float</info>     <strong>$activation_steepness</strong>  La raideur de la pente d'activation.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_set_activation_steepness()</strong>
   * <strong>fann_set_activation_steepness_layer()</strong>
   * <strong>fann_set_activation_steepness_hidden()</strong>
   * <strong>fann_get_activation_steepness()</strong>
   * <strong>fann_set_activation_function()</strong>


id: fann_set_bit_fail_limit
type: function
doc:
<comment>Description:</comment>
  Défini le bit sûr limite, utilisé pendant l'entrainement
  
  Défini le bit sûr limite, utilisé pendant l'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ressource de réseau de neurones.
  <info>float</info>     <strong>$bit_fail_limit</strong>  Le bit sûr limite.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_bit_fail_limit()</strong>


id: fann_set_callback
type: function
doc:
<comment>Description:</comment>
  Défini la fonction de rappel à utiliser pendant l'entrainement
  
  Défini la fonction de rappel à utiliser pendant l'entrainement. Elle sera appelée depuis la
  fonction <strong>fann_train_on_data()</strong> ou la fonction <strong>fann_train_on_file()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>       Ressource de réseau de neurones.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel fourni prendra les paramètres suivants : <return>ann</return> - Une
                       ressource représentant le réseau neuronal <return>train</return> - Une ressource représentant
                       les données d'entrainement ou <info>null</info> si appelé depuis la fonction
                       <strong>fann_train_on_file()</strong> <return>max_epochs</return> - Le nombre maximal d'époques que
                       l'entrainement doit continuer <return>epochs_between_reports</return> - Le nombre d'époques
                       entre les appels à cette fonction <return>desired_error</return> - Le choix entre
                       <strong>fann_get_MSE()</strong> et <strong>fann_get_bit_fail()</strong>, suivant la fonction d'arrêt choisie
                       par la fonction <strong>fann_set_train_stop_function()</strong> <return>epochs</return> - L'époque courante
                       
                       La fonction de rappel doit retourner <info>true</info>. Si elle retourne <info>false</info>,
                       l'entrainement se terminera.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_on_file()</strong>


id: fann_set_cascade_activation_functions
type: function
doc:
<comment>Description:</comment>
  Défini le tableau des fonctions d'activation candidate en cascade
  
  Défini le tableau des fonctions d'activation candidate en cascade.
  
  Voir la fonction <strong>fann_get_cascade_num_candidates()</strong> pour savoir quels neurones candidats seront
  générés par ce tableau.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                           Ressource de réseau de neurones.
  <info>array</info>     <strong>$cascade_activation_functions</strong>  Le tableau des fonctions d'activation candidate en
                                           cascade.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_functions_count()</strong>
   * <strong>fann_set_cascade_activation_functions()</strong>


id: fann_set_cascade_activation_steepnesses
type: function
doc:
<comment>Description:</comment>
  Défini le tableaux des raideurs d'activation candidate en cascade
  
  Défini le tableaux des raideurs d'activation candidate en cascade.
  
  Voir la fonction <strong>fann_get_cascade_num_candidates()</strong> pour savoir quels neurones candidats seront
  générés par ce tableau.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                   Ressource de réseau de neurones.
  <info>array</info>     <strong>$cascade_activation_steepnesses_count</strong>  Le tableaux des raideurs d'activation candidate
                                                   en cascade.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_activation_steepnesses()</strong>
   * <strong>fann_get_cascade_activation_steepnesses_count()</strong>


id: fann_set_cascade_candidate_change_fraction
type: function
doc:
<comment>Description:</comment>
  Défini la fraction de modification candidate en cascade
  
  Défini la fraction de modification candidate en cascade.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                Ressource de réseau de neurones.
  <info>float</info>     <strong>$cascade_candidate_change_fraction</strong>  La fraction de modification candidate en cascade.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_candidate_change_fraction()</strong>


id: fann_set_cascade_candidate_limit
type: function
doc:
<comment>Description:</comment>
  Défini la limite candidate
  
  Défini la limite candidate.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      Ressource de réseau de neurones.
  <info>float</info>     <strong>$cascade_candidate_limit</strong>  La limite candidate.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_candidate_limit()</strong>


id: fann_set_cascade_candidate_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Défini le nombre d'époques de stagnation candidates en cascade
  
  Défini le nombre d'époques de stagnation candidates en cascade.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                  Ressource de réseau de neurones.
  <info>int</info>       <strong>$cascade_candidate_stagnation_epochs</strong>  Le nombre d'époques de stagnation candidates en
                                                  cascade.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_candidate_stagnation_epochs()</strong>


id: fann_set_cascade_max_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Défini l'époque maximale candidate
  
  Défini l'époque maximale candidate.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      Ressource de réseau de neurones.
  <info>int</info>       <strong>$cascade_max_cand_epochs</strong>  L'époque maximale candidate.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_max_cand_epochs()</strong>


id: fann_set_cascade_max_out_epochs
type: function
doc:
<comment>Description:</comment>
  Défini l'époque maximale de sortie
  
  Défini l'époque maximale de sortie.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     Ressource de réseau de neurones.
  <info>int</info>       <strong>$cascade_max_out_epochs</strong>  L'époque maximale de sortie.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_max_out_epochs()</strong>


id: fann_set_cascade_min_cand_epochs
type: function
doc:
<comment>Description:</comment>
  Défini l'époque minimale candidate
  
  Défini l'époque minimale candidate.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                      Ressource de réseau de neurones.
  <info>int</info>       <strong>$cascade_min_cand_epochs</strong>  L'époque minimale candidate.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_min_cand_epochs()</strong>


id: fann_set_cascade_min_out_epochs
type: function
doc:
<comment>Description:</comment>
  Défini l'époque minimale de sortie
  
  Défini l'époque minimale de sortie.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     Ressource de réseau de neurones.
  <info>int</info>       <strong>$cascade_min_out_epochs</strong>  L'époque minimale de sortie.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_min_out_epochs()</strong>


id: fann_set_cascade_num_candidate_groups
type: function
doc:
<comment>Description:</comment>
  Défini le nombre de groupes candidats
  
  Défini le nombre de groupes candidats.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                           Ressource de réseau de neurones.
  <info>int</info>       <strong>$cascade_num_candidate_groups</strong>  Le nombre de groupes candidats.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_num_candidate_groups()</strong>


id: fann_set_cascade_output_change_fraction
type: function
doc:
<comment>Description:</comment>
  Défini la fraction de modification de sortie en cascade
  
  Défini la fraction de modification de sortie en cascade.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                             Ressource de réseau de neurones.
  <info>float</info>     <strong>$cascade_output_change_fraction</strong>  La fraction de modification de sortie en cascade.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_output_change_fraction()</strong>


id: fann_set_cascade_output_stagnation_epochs
type: function
doc:
<comment>Description:</comment>
  Défini le nombre d'époques de stagnation en cascade de sortie
  
  Défini le nombre d'époques de stagnation en cascade de sortie.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                               Ressource de réseau de neurones.
  <info>int</info>       <strong>$cascade_output_stagnation_epochs</strong>  Le nombre d'époques de stagnation en cascade de
                                               sortie.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_output_stagnation_epochs()</strong>


id: fann_set_cascade_weight_multiplier
type: function
doc:
<comment>Description:</comment>
  Défini le multiplicateur de poids
  
  Défini le multiplicateur de poids.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                        Ressource de réseau de neurones.
  <info>float</info>     <strong>$cascade_weight_multiplier</strong>  Le multiplicateur de poids.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_cascade_weight_multiplier()</strong>


id: fann_set_error_log
type: function
doc:
<comment>Description:</comment>
  Défini l'endroit où les erreurs seront historisées
  
  Défini l'endroit où les erreurs seront historisées.

<comment>Param:</comment>
  <info>resource</info>  <strong>$errdat</strong>    Soit une ressource de réseau de neurones, soit une ressource de données
                       d'entrainement d'un réseau de neurones.
  <info>string</info>    <strong>$log_file</strong>  Le chemin du fichier d'historisation.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur retournée.


id: fann_set_input_scaling_params
type: function
doc:
<comment>Description:</comment>
  Calcule les paramètres d'échelle d'entrée pour une utilisation
     future, en se basant sur les données d'entrainement
  
  Calcule les paramètres d'échelle d'entrée pour une utilisation future, en se basant sur les
  données d'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            Ressource de réseau de neurones.
  <info>resource</info>  <strong>$train_data</strong>     Ressource de données d'entrainement du réseau de neurones.
  <info>float</info>     <strong>$new_input_min</strong>  La limite inférieure souhaitée dans les données d'entrée après mise à
                            l'échelle (pas strictement suivi)
  <info>float</info>     <strong>$new_input_max</strong>  La limite supérieure souhaitée dans les données d'entrée après mise à
                            l'échelle (pas strictement suivi)

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_set_output_scaling_params()</strong>


id: fann_set_learning_momentum
type: function
doc:
<comment>Description:</comment>
  Défini la dynamique d'apprentissage
  
  Défini la dynamique d'apprentissage.
  
  Plus d'informations disponible sur la page de documentation de la fonction
  <strong>fann_get_learning_momentum()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                Ressource de réseau de neurones.
  <info>float</info>     <strong>$learning_momentum</strong>  La dynamique d'apprentissage.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_learning_momentum()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_set_learning_rate
type: function
doc:
<comment>Description:</comment>
  Défini le taux d'apprentissage
  
  Défini le taux d'apprentissage.
  
  Plus d'informations disponible sur la page de la documentation de la fonction
  <strong>fann_get_learning_rate()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            Ressource de réseau de neurones.
  <info>float</info>     <strong>$learning_rate</strong>  Le taux d'apprentissage.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_learning_rate()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_set_output_scaling_params
type: function
doc:
<comment>Description:</comment>
  Calcule les paramètres d'échelle de sortie pour une utilisation future,
     en se basant sur les données d'entrainement
  
  Calcule les paramètres d'échelle de sortie pour une utilisation future, en se basant sur les
  données d'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ressource de réseau de neurones.
  <info>resource</info>  <strong>$train_data</strong>      Ressource de données d'entrainement du réseau de neurones.
  <info>float</info>     <strong>$new_output_min</strong>  La limite inférieure souhaitée dans les données de sortie après mise à
                             l'échelle (pas strictement suivi)
  <info>float</info>     <strong>$new_output_max</strong>  La limite supérieur souhaitée dans les données de sortie après mise à
                             l'échelle (pas strictement suivi)

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_set_input_scaling_params()</strong>


id: fann_set_quickprop_decay
type: function
doc:
<comment>Description:</comment>
  Défini le facteur décroissant quickprop
  
  Défini le facteur décroissant quickprop.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              Ressource de réseau de neurones.
  <info>float</info>     <strong>$quickprop_decay</strong>  Le facteur décroissant quickprop.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_quickprop_decay()</strong>


id: fann_set_quickprop_mu
type: function
doc:
<comment>Description:</comment>
  Défini le facteur quickprop mu
  
  Défini le facteur quickprop mu.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>           Ressource de réseau de neurones.
  <info>float</info>     <strong>$quickprop_mu</strong>  Le facteur mu.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_quickprop_mu()</strong>


id: fann_set_rprop_decrease_factor
type: function
doc:
<comment>Description:</comment>
  Défini le facteur de diminution utilisé pendant l'entrainement RPROP
  
  Défini le facteur de diminution utilisé pendant l'entrainement RPROP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                    Ressource de réseau de neurones.
  <info>float</info>     <strong>$rprop_decrease_factor</strong>  Le facteur de diminution.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_rprop_decrease_factor()</strong>


id: fann_set_rprop_delta_max
type: function
doc:
<comment>Description:</comment>
  Défini la taille maximale de l'étape
  
  La taille maximale de l'étape est un nombre positif déterminant combien la taille maximale de
  l'étape peut être.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              Ressource de réseau de neurones.
  <info>float</info>     <strong>$rprop_delta_max</strong>  La taille maximale de l'étape.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_rprop_delta_max()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>


id: fann_set_rprop_delta_min
type: function
doc:
<comment>Description:</comment>
  Défini la taille minimale de l'étape
  
  La taille minimale de l'étape est un petit nombre positif déterminant combien la taille minimale
  de l'étape peut être.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>              Ressource de réseau de neurones.
  <info>float</info>     <strong>$rprop_delta_min</strong>  La taille minimale de l'étape.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_rprop_delta_min()</strong>


id: fann_set_rprop_delta_zero
type: function
doc:
<comment>Description:</comment>
  Défini la taille de l'étape initiale
  
  Défini la taille de l'étape initiale ; doit être un nombre positif.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>               Ressource de réseau de neurones.
  <info>float</info>     <strong>$rprop_delta_zero</strong>  La taille de l'étape initiale.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_rprop_delta_zero()</strong>
   * <strong>fann_get_rprop_delta_min()</strong>
   * <strong>fann_get_rprop_delta_max()</strong>


id: fann_set_rprop_increase_factor
type: function
doc:
<comment>Description:</comment>
  Défini le facteur d'augmentation utilisé pendant l'entrainement RPROP
  
  Défini le facteur d'augmentation utilisé pendant l'entrainement RPROP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                    Ressource de réseau de neurones.
  <info>float</info>     <strong>$rprop_increase_factor</strong>  Le facteur d'augmentation.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_rprop_increase_factor()</strong>


id: fann_set_sarprop_step_error_shift
type: function
doc:
<comment>Description:</comment>
  Défini le changement de l'étape d'erreur sarprop
  
  Défini le changement de l'étape d'erreur sarprop.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                       Ressource de réseau de neurones.
  <info>float</info>     <strong>$sarprop_step_error_shift</strong>  Le changement de l'étape d'erreur sarprop.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_sarprop_step_error_shift()</strong>


id: fann_set_sarprop_step_error_threshold_factor
type: function
doc:
<comment>Description:</comment>
  Défini le facteur de seuil de l'étape d'erreur sarprop
  
  Défini le facteur de seuil de l'étape d'erreur sarprop.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                                  Ressource de réseau de neurones.
  <info>float</info>     <strong>$sarprop_step_error_threshold_factor</strong>  Le facteur de seuil de l'étape d'erreur sarprop.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_sarprop_step_error_threshold_factor()</strong>


id: fann_set_sarprop_temperature
type: function
doc:
<comment>Description:</comment>
  Défini la températeur sarprop
  
  Défini la températeur sarprop.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                  Ressource de réseau de neurones.
  <info>float</info>     <strong>$sarprop_temperature</strong>  La températeur sarprop.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_sarprop_temperature()</strong>


id: fann_set_sarprop_weight_decay_shift
type: function
doc:
<comment>Description:</comment>
  Défini le changement décroissant du poids de sarprop
  
  Défini le changement décroissant du poids de sarprop.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                         Ressource de réseau de neurones.
  <info>float</info>     <strong>$sarprop_weight_decay_shift</strong>  Le changement décroissant du poids de sarprop.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_sarprop_weight_decay_shift()</strong>


id: fann_set_scaling_params
type: function
doc:
<comment>Description:</comment>
  Calcule les paramètres d'échelles d'entrée et de sortie
     utilisés en se basant sur les données d'entrainement
  
  Calcule les paramètres d'échelles d'entrée et de sortie utilisés en se basant sur les données
  d'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ressource de réseau de neurones.
  <info>resource</info>  <strong>$train_data</strong>      Ressource de données d'entrainement du réseau de neurones.
  <info>float</info>     <strong>$new_input_min</strong>   La limite inférieure souhaitée dans les données d'entrée après mise à
                             l'échelle (pas strictement suivie)
  <info>float</info>     <strong>$new_input_max</strong>   La limite supérieure souhaitée dans les données d'entrée après mise à
                             l'échelle (pas strictement suivie)
  <info>float</info>     <strong>$new_output_min</strong>  La limite inférieure souhaitée dans les données de sortie après mise à
                             l'échelle (pas strictement suivie)
  <info>float</info>     <strong>$new_output_max</strong>  La limite supérieure souhaitée dans les données de sortie après mise à
                             l'échelle (pas strictement suivie)

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_set_input_scaling_params()</strong>
   * <strong>fann_set_output_scaling_params()</strong>


id: fann_set_train_error_function
type: function
doc:
<comment>Description:</comment>
  Défini la fonction d'erreur utilisée pendant l'entrainement
  
  Défini la fonction d'erreur utilisée pendant l'entrainement.
  
  Les fonctions d'erreur sont décrites dans la page de la documentation sur les constantes des
  fonctions d'erreur.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ressource de réseau de neurones.
  <info>int</info>       <strong>$error_function</strong>  Une constante de fonction d'erreur

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_train_error_function()</strong>


id: fann_set_train_stop_function
type: function
doc:
<comment>Description:</comment>
  Défini la fonction d'arrêt à utiliser durant l'entrainement
  
  Défini la fonction d'arrêt à utiliser durant l'entrainement.
  
  Les fonctions d'arrêt sont décrites dans la page de la documentation sur les constantes des
  fonctions d'arrêt.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>            Ressource de réseau de neurones.
  <info>int</info>       <strong>$stop_function</strong>  Une constante de fonction d'arrêt.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_train_stop_function()</strong>


id: fann_set_training_algorithm
type: function
doc:
<comment>Description:</comment>
  Défini l'algorithme d'entrainement
  
  Défini l'algorithme d'entrainement.
  
  Plus d'informations disponible sur la page de la fonction <strong>fann_get_training_algorithm()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                 Ressource de réseau de neurones.
  <info>int</info>       <strong>$training_algorithm</strong>  Une constante d'algorithme d'entrainement

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_get_training_algorithm()</strong>


id: fann_set_weight
type: function
doc:
<comment>Description:</comment>
  Défini une connexion dans le réseau
  
  Défini une connexion dans le réseau.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>          Ressource de réseau de neurones.
  <info>int</info>       <strong>$from_neuron</strong>  Le neurone où la connexion commence
  <info>int</info>       <strong>$to_neuron</strong>    Le neurone où la connexion se termine
  <info>float</info>     <strong>$weight</strong>       Taille de la connexion

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.


id: fann_set_weight_array
type: function
doc:
<comment>Description:</comment>
  Défini les connexions dans le réseau
  
  Défini les connexions dans le réseau.
  
  Seuls les poids peuvent être changés ; les connexions et les poids sont ignorés s'ils n'existent
  pas déjà dans le réseau.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>          Ressource de réseau de neurones.
  <info>array</info>     <strong>$connections</strong>  Un tableau d'objets <class>FANNConnection</class>

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.


id: fann_shuffle_train_data
type: function
doc:
<comment>Description:</comment>
  Mélange les données d'entrainement, et rend aléaloire leurs ordres
  
  Mélange les données d'entrainement, et rend aléaloire leurs ordres. Ceci est recommandé pour un
  entrainement incrémental, alors qu'il n'a aucune influence sur le lot d'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$train_data</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.


id: fann_subset_train_data
type: function
doc:
<comment>Description:</comment>
  Retourne une copie d'un sous-jeu de données d'entrainement
  
  Retourne une copie du sous-jeu de données d'entrainement, en commençant à la position <return>pos</return> et des
  <return>length</return> éléments suivants.
  
  Le code <return>fann_subset_train_data(train_data,  0, fann_length_train_data(train_data))</return> réalise la même
  chose que la fonction <strong>fann_duplicate_train_data()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$data</strong>    Ressource de données d'entrainement du réseau de neurones.
  <info>int</info>       <strong>$pos</strong>     Position de départ.
  <info>int</info>       <strong>$length</strong>  Le nombre d'éléments copiés.

<comment>Return:</comment>
  <info>resource</info>  Retourne une ressource de données d'entrainement en cas de succès, ou <info>false</info> si une
            erreur survient.

<comment>See Also:</comment>
   * <strong>fann_duplicate_train_data()</strong>


id: fann_test
type: function
doc:
<comment>Description:</comment>
  Effectue un test avec un jeu d'entrées et un jeu de sorties désirées
  
  Effectue un test avec un jeu d'entrées et un jeu de sorties désirées. Cette opération met à jour
  l'erreur quadratique moyenne, mais ne modifie en aucune façon le réseau.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ressource de réseau de neurones.
  <info>array</info>     <strong>$input</strong>           Un tableau d'entrées. Ce tableau doit être d'une longueur exacte de
                             <strong>fann_get_num_input()</strong>.
  <info>array</info>     <strong>$desired_output</strong>  Un tableau de sorties désirées. Ce tableau doit être d'une longueur
                             exacte <strong>fann_get_num_output()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retourne les sorties de test en cas de succès, ou <info>false</info> en cas d'erreur.

<comment>See Also:</comment>
   * <strong>fann_test_data()</strong>
   * <strong>fann_train()</strong>
   * <strong>fann_get_num_input()</strong>
   * <strong>fann_get_num_output()</strong>


id: fann_test_data
type: function
doc:
<comment>Description:</comment>
  Effectue un test sur un jeu de données d'entrainement
     et calcule le MSE pour ces données
  
  Effectue un test sur un jeu de données d'entrainement et calcule le MSE pour ces données.
  
  Cette fonction met à jour le MSE à sa valeur la plus sûre.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>   Ressource de réseau de neurones.
  <info>resource</info>  <strong>$data</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  Le MSE mis à jour, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_train
type: function
doc:
<comment>Description:</comment>
  Effectue un entrainement sur une itération avec un jeu d'entrées,
     et un jeu de sorties désirées
  
  Effectue un entrainement sur une itération avec un jeu d'entrées, et un jeu de sorties désirées.
  Cet entrainement est toujours un entrainement incrémental, sachant que seulement un masque est
  présenté.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>             Ressource de réseau de neurones.
  <info>array</info>     <strong>$input</strong>           Un tableau d'entrées. Ce tableau doit être exactement d'une longueur de
                             <strong>fann_get_num_input()</strong>.
  <info>array</info>     <strong>$desired_output</strong>  Un tableau de sorties désirées. Ce tableau doit être exactement d'une
                             longueur de <strong>fann_get_num_output()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_num_input()</strong>
   * <strong>fann_get_num_output()</strong>


id: fann_train_epoch
type: function
doc:
<comment>Description:</comment>
  Effectue un entrainement avec un jeu de données d'entrainement
  
  Effectue un entrainement avec un jeu de données d'entrainement. Une époque correspond au fait que
  toutes les données d'entrainement sont considérées comme étant exactement uniques.
  
  Cette fonction retourne l'erreur MSE sachant qu'elle est calculée soit avant, soit pendant
  l'entrainement actuel. Ce n'est pas le MSE actuel après l'époque d'entrainement, sachant que ce
  calcul nécessite le parcours de la totalité du jeu de données d'entrainement au moins une fois. Il
  est donc plus adéquate d'utiliser cette valeur pendant l'entrainement.
  
  L'algorithme d'entrainement utilisé par cette fonction est choisi par la fonction
  <strong>fann_set_training_algorithm()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>   Ressource de réseau de neurones.
  <info>resource</info>  <strong>$data</strong>  Ressource de données d'entrainement du réseau de neurones.

<comment>Return:</comment>
  <info>float</info>  Le MSE, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_test_data()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_training_algorithm()</strong>


id: fann_train_on_data
type: function
doc:
<comment>Description:</comment>
  Effectue un entrainement sur un jeu de données complet pour une période de temps
  
  Effectue un entrainement sur un jeu de données complet pour une période de temps.
  
  Cet entrainement utiise l'algorithme d'entrainement choisi par la fonction
  <strong>fann_set_training_algorithm()</strong> et le jeu de paramètres pour ces algorithmes d'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     Ressource de réseau de neurones.
  <info>resource</info>  <strong>$data</strong>                    Ressource de données d'entrainement du réseau de neurones.
  <info>int</info>       <strong>$max_epochs</strong>              Le nombre maximal d'époques que l'entrainement doit durer
  <info>int</info>       <strong>$epochs_between_reports</strong>  Le nombre d'époques entre les appels à la fonction de rappel.
                                     Une valeur de zéro signifie que la fonction utilisateur ne sera
                                     jamais appelée.
  <info>float</info>     <strong>$desired_error</strong>           Le <strong>fann_get_MSE()</strong> ou le <strong>fann_get_bit_fail()</strong> voulu, suivant la
                                     fonction d'arrêt choisie par la fonction
                                     <strong>fann_set_train_stop_function()</strong>

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_train_on_file()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_train_stop_function()</strong>
   * <strong>fann_set_training_algorithm()</strong>
   * <strong>fann_set_callback()</strong>


id: fann_train_on_file
type: function
doc:
<comment>Description:</comment>
  Effectue un entrainement sur un jeu complet de données,
     qui peut être lu depuis un fichier, pour une période de temps
  
  Effectue un entrainement sur un jeu complet de données, qui peut être lu depuis un fichier, pour
  une période de temps.
  
  Cet entrainement utilise l'algorithme d'entrainement choisi par la fonction
  <strong>fann_set_training_algorithm()</strong> et le jeu de paramètres pour ces algorithmes d'entrainement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$ann</strong>                     Ressource de réseau de neurones.
  <info>string</info>    <strong>$filename</strong>                Le fichier contenant les données d'entrainement
  <info>int</info>       <strong>$max_epochs</strong>              Le nombre maximal d'époques que l'entrainement doit traiter
  <info>int</info>       <strong>$epochs_between_reports</strong>  Le nombre maximal d'époques entre l'appel à la fonction
                                     utilisateur. Une valeur de zéro signifie que la fonction
                                     utilisateur n'est pas appelée.
  <info>float</info>     <strong>$desired_error</strong>           Le <strong>fann_get_MSE()</strong> ou le <strong>fann_get_bit_fail()</strong> voulu, suivant la
                                     fonction d'arrêt choisi par la fonction
                                     <strong>fann_set_train_stop_function()</strong>

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>fann_train_on_data()</strong>
   * <strong>fann_train_epoch()</strong>
   * <strong>fann_get_bit_fail()</strong>
   * <strong>fann_get_MSE()</strong>
   * <strong>fann_set_train_stop_function()</strong>
   * <strong>fann_set_training_algorithm()</strong>
   * <strong>fann_set_callback()</strong>


id: fastcgi_finish_request
type: function
doc:
<comment>Description:</comment>
  Affiche toutes les données de la réponse au client
  
  Cette fonction affiche toutes les données de la réponse au client et termine la requête. Ceci
  permet pour les tâches consommatrices en temps d'être effectuées sans laisser la connexion avec le
  client ouverte.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: fbird_add_user
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_add_user
  
  Cette fonction est un alias de :  <strong>ibase_add_user()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_modify_user()</strong>
   * <strong>fbird_delete_user()</strong>


id: fbird_affected_rows
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_affected_rows
  
  Cette fonction est un alias de :  <strong>ibase_affected_rows()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_query()</strong>
   * <strong>fbird_execute()</strong>


id: fbird_backup
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_backup
  
  Cette fonction est un alias de :  <strong>ibase_backup()</strong>.


id: fbird_blob_add
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_blob_add
  
  Cette fonction est un alias de :  <strong>ibase_blob_add()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_import()</strong>


id: fbird_blob_cancel
type: function
doc:
<comment>Description:</comment>
  Annule la création d'un blob
  
  Cette fonction jetera un BLOB s'il n'a pas encore était fermé par <strong>fbird_blob_close()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$blob_handle</strong>  Un gestionnaire de BLOB ouvert avec <strong>fbird_blob_create()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_import()</strong>


id: fbird_blob_close
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_blob_close
  
  Cette fonction est un alias de :  <strong>ibase_blob_close()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_blob_create()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_import()</strong>


id: fbird_blob_create
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_blob_create
  
  Cette fonction est un alias de :  <strong>ibase_blob_create()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_blob_add()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_import()</strong>


id: fbird_blob_echo
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_blob_echo
  
  Cette fonction est un alias de :  <strong>ibase_blob_echo()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_get()</strong>


id: fbird_blob_get
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_blob_get
  
  Cette fonction est un alias de :  <strong>ibase_blob_get()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_blob_open()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_echo()</strong>


id: fbird_blob_import
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_blob_import
  
  Cette fonction est un alias de :  <strong>ibase_blob_import()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_blob_add()</strong>
   * <strong>fbird_blob_cancel()</strong>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_create()</strong>


id: fbird_blob_info
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_blob_info
  
  Cette fonction est un alias de :  <strong>ibase_blob_info()</strong>.


id: fbird_blob_open
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_blob_open
  
  Cette fonction est un alias de :  <strong>ibase_blob_open()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_blob_close()</strong>
   * <strong>fbird_blob_echo()</strong>
   * <strong>fbird_blob_get()</strong>


id: fbird_close
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_close
  
  Cette fonction est un alias de :  <strong>ibase_close()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_connect()</strong>
   * <strong>fbird_pconnect()</strong>


id: fbird_commit
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_commit
  
  Cette fonction est un alias de :  <strong>ibase_commit()</strong>.


id: fbird_commit_ret
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_commit_ret
  
  Cette fonction est un alias de :  <strong>ibase_commit_ret()</strong>.


id: fbird_connect
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_connect
  
  Cette fonction est un alias de :  <strong>ibase_connect()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_pconnect()</strong>
   * <strong>fbird_close()</strong>


id: fbird_db_info
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_db_info
  
  Cette fonction est un alias de :  <strong>ibase_db_info()</strong>.


id: fbird_delete_user
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_delete_user
  
  Cette fonction est un alias de :  <strong>ibase_delete_user()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_add_user()</strong>
   * <strong>fbird_modify_user()</strong>


id: fbird_drop_db
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_drop_db
  
  Cette fonction est un alias de :  <strong>ibase_drop_db()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_connect()</strong>
   * <strong>fbird_pconnect()</strong>


id: fbird_errcode
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_errcode
  
  Cette fonction est un alias de :  <strong>ibase_errcode()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_errmsg()</strong>


id: fbird_errmsg
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_errmsg
  
  Cette fonction est un alias de :  <strong>ibase_errmsg()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_errcode()</strong>


id: fbird_execute
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_execute
  
  Cette fonction est un alias de :  <strong>ibase_execute()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_query()</strong>


id: fbird_fetch_assoc
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_fetch_assoc
  
  Cette fonction est un alias de :  <strong>ibase_fetch_assoc()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_object()</strong>


id: fbird_fetch_object
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_fetch_object
  
  Cette fonction est un alias de :  <strong>ibase_fetch_object()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_assoc()</strong>


id: fbird_fetch_row
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_fetch_row
  
  Cette fonction est un alias de :  <strong>ibase_fetch_row()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_fetch_assoc()</strong>
   * <strong>fbird_fetch_object()</strong>


id: fbird_field_info
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_field_info
  
  Cette fonction est un alias de :  <strong>ibase_field_info()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_num_fields()</strong>


id: fbird_free_event_handler
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_free_event_handler
  
  Cette fonction est un alias de :  <strong>ibase_free_event_handler()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_set_event_handler()</strong>


id: fbird_free_query
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_free_query
  
  Cette fonction est un alias de :  <strong>ibase_free_query()</strong>.


id: fbird_free_result
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_free_result
  
  Cette fonction est un alias de :  <strong>ibase_free_result()</strong>.


id: fbird_gen_id
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_gen_id
  
  Cette fonction est un alias de :  <strong>ibase_gen_id()</strong>.


id: fbird_maintain_db
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_maintain_db
  
  Cette fonction est un alias de :  <strong>ibase_maintain_db()</strong>.


id: fbird_modify_user
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_modify_user
  
  Cette fonction est un alias de :  <strong>ibase_modify_user()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_add_user()</strong>
   * <strong>fbird_delete_user()</strong>


id: fbird_name_result
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_name_result
  
  Cette fonction est un alias de :  <strong>ibase_name_result()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_prepare()</strong>
   * <strong>fbird_execute()</strong>


id: fbird_num_fields
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_num_fields
  
  Cette fonction est un alias de :  <strong>ibase_num_fields()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_field_info()</strong>


id: fbird_num_params
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_num_params
  
  Cette fonction est un alias de :  <strong>ibase_num_params()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_prepare()</strong>
   * <strong>fbird_param_info()</strong>


id: fbird_param_info
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_param_info
  
  Cette fonction est un alias de :  <strong>ibase_param_info()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_field_info()</strong>
   * <strong>fbird_num_params()</strong>


id: fbird_pconnect
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_pconnect
  
  Cette fonction est un alias de :  <strong>ibase_pconnect()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_close()</strong>
   * <strong>fbird_connect()</strong>


id: fbird_prepare
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_prepare
  
  Cette fonction est un alias de :  <strong>ibase_prepare()</strong>.


id: fbird_query
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_query
  
  Cette fonction est un alias de :  <strong>ibase_query()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_errmsg()</strong>
   * <strong>fbird_fetch_row()</strong>
   * <strong>fbird_fetch_object()</strong>
   * <strong>fbird_free_result()</strong>


id: fbird_restore
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_restore
  
  Cette fonction est un alias de :  <strong>ibase_restore()</strong>.


id: fbird_rollback
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_rollback
  
  Cette fonction est un alias de :  <strong>ibase_rollback()</strong>.


id: fbird_rollback_ret
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_rollback_ret
  
  Cette fonction est un alias de :  <strong>ibase_rollback_ret()</strong>.


id: fbird_server_info
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_server_info
  
  Cette fonction est un alias de :  <strong>ibase_server_info()</strong>.


id: fbird_service_attach
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_service_attach
  
  Cette fonction est un alias de :  <strong>ibase_service_attach()</strong>.


id: fbird_service_detach
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_service_detach
  
  Cette fonction est un alias de :  <strong>ibase_service_detach()</strong>.


id: fbird_set_event_handler
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_set_event_handler
  
  Cette fonction est un alias de :  <strong>ibase_set_event_handler()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_free_event_handler()</strong>
   * <strong>fbird_wait_event()</strong>


id: fbird_trans
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_trans
  
  Cette fonction est un alias de :  <strong>ibase_trans()</strong>.


id: fbird_wait_event
type: function
doc:
<comment>Description:</comment>
  Alias de ibase_wait_event
  
  Cette fonction est un alias de :  <strong>ibase_wait_event()</strong>.

<comment>See Also:</comment>
   * <strong>fbird_set_event_handler()</strong>
   * <strong>fbird_free_event_handler()</strong>


id: fclose
type: function
doc:
<comment>Description:</comment>
  Ferme un fichier
  
  Ferme le fichier représenté par le pointeur <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Le pointeur de fichier doit être valide et doit avoir été correctement ouvert
                     par la fonction <strong>fopen()</strong> ou la fonction <strong>fsockopen()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>fsockopen()</strong>


id: fdatasync
type: function
doc:
<comment>Description:</comment>
  Synchronise les données (mais pas les métadonnées) avec le fichier
  
  Cette fonction synchronise le contenu du <strong>$stream</strong> sur le support de stockage, tout comme <strong>fsync()</strong> le
  fait, mais elle ne synchronise pas les métadonnées des fichiers. Il est à noter que que cette
  fonction est différente seulement dans les systèmes POSIX. Sous Windows, cette fonction est un
  alias de <strong>fsync()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Le pointeur de fichier doit être valide et pointer
                     sur un fichier ouvert avec succès par <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (et pas encore fermé par <strong>fclose()</strong>).

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fflush()</strong>
   * <strong>fsync()</strong>


id: fdf_add_doc_javascript
type: function
doc:
<comment>Description:</comment>
  Ajoute du code javascript dans un document FDF
  
  Ajoute le code javascript <strong>$script_code</strong> dans le document <strong>$fdfdoc</strong>, qu'Acrobat ajoutera aux scripts
  de niveau document, une fois le FDF importé.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$script_name</strong>   Le nom du script.
  <info>string</info>    <strong>$script_code</strong>   Le code du script. Il est fortement recommandé d'utiliser '\r' comme
                           séparateur de lignes dans le code <strong>$script_code</strong>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: fdf_add_template
type: function
doc:
<comment>Description:</comment>
  Ajoute un template dans le document FDF
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>bool</info>  


id: fdf_close
type: function
doc:
<comment>Description:</comment>
  Ferme un document FDF
  
  Ferme le document FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.

<comment>See Also:</comment>
   * <strong>fdf_open()</strong>


id: fdf_create
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau document FDF
  
  Crée un nouveau document FDF.
  
  Cette fonction est nécessaire pour ceux qui veulent préremplir les champs d'un formulaire dans un
  fichier PDF.

<comment>Return:</comment>
  <info>resource</info>  Retourne un gestionnaire de document FDF, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_close()</strong>
   * <strong>fdf_save()</strong>
   * <strong>fdf_open()</strong>


id: fdf_enum_values
type: function
doc:
<comment>Description:</comment>
  Appelle une fonction utilisateur à chaque valeur FDF
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>bool</info>  


id: fdf_errno
type: function
doc:
<comment>Description:</comment>
  Retourne le code d'erreur de la dernière opération FDF
  
  Récupère le code d'erreur de la dernière opération FDF.
  
  Un message d'erreur est accessible via la fonction <strong>fdf_error()</strong> function.

<comment>Return:</comment>
  <info>int</info>  Retourne le code erreur sous la forme d'un entier ou <return>0</return> si aucune erreur n'est survenue.

<comment>See Also:</comment>
   * <strong>fdf_error()</strong>


id: fdf_error
type: function
doc:
<comment>Description:</comment>
  Retourne le message d'erreur FDF
  
  Retourne le message d'erreur FDF.

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  Un code erreur obtenu avec la fonction <strong>fdf_errno()</strong>. S'il n'est pas fourni, cette
                    fonction utilise le code erreur interne défini par la dernière opération.

<comment>Return:</comment>
  <info>string</info>  Retourne le message d'erreur sous la forme d'une chaîne de caractères ou la chaîne <return>no
          error</return> s'il n'y en a pas.

<comment>See Also:</comment>
   * <strong>fdf_errno()</strong>


id: fdf_get_ap
type: function
doc:
<comment>Description:</comment>
  Lit l'apparence d'un champ
  
  Lit l'apparence du champ <strong>$field</strong> (i.e. la valeur de la clé /AP) et le stocke dans le fichier
  <strong>$filename</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$field</strong>         
  <info>int</info>       <strong>$face</strong>          Les valeurs possibles sont <info>FDFNormalAP</info>, <info>FDFRolloverAP</info> et <info>FDFDownAP</info>.
  <info>string</info>    <strong>$filename</strong>      L'apparence sera stockée dans ce paramètre.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: fdf_get_attachment
type: function
doc:
<comment>Description:</comment>
  Extrait un fichier intégré dans un document FDF
  
  Extrait le fichier <strong>$fieldname</strong> téléchargé par le biais du champ <return>"file selection"</return>,  puis le stocke
  dans le fichier <strong>$savepath</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     
  <info>string</info>    <strong>$savepath</strong>      Peut être le nom d'un fichier ou bien un dossier dans lequel le fichier
                           téléchargé sera créé sous son nom original. Tout fichier déjà existant
                           avec le même nom sera écrasé.
                           
                           Il semble qu'il n'y ait pas d'autre moyen pour connaître le nom du
                           fichier téléchargé que de le stocker dans un dossier avec <strong>$savepath</strong> puis
                           de lire son nom dans le dossier.

<comment>Return:</comment>
  <info>array</info>  Le tableau retourné contient les champs suivants : <strong>$path</strong> - chemin de stockage du
         dossier<strong>$size</strong> - taille du fichier stocké en octets<strong>$type</strong> - Type MIMI du fichier, s'il a été
         fourni dans le document FDF
         
         <strong>$path</strong> - chemin de stockage du dossier
         
         <strong>$size</strong> - taille du fichier stocké en octets
         
         <strong>$type</strong> - Type MIMI du fichier, s'il a été fourni dans le document FDF


id: fdf_get_encoding
type: function
doc:
<comment>Description:</comment>
  Lit la valeur de la clé /Encoding
  
  Récupère la valeur de la clé <return>/Encoding</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retourne l'encodage, sous la forme d'une chaîne de caractères. Une chaîne vide est
          retournée si le schéma <return>PDFDocEncoding/Unicode</return> est utilisé.

<comment>See Also:</comment>
   * <strong>fdf_set_encoding()</strong>


id: fdf_get_file
type: function
doc:
<comment>Description:</comment>
  Lit la valeur de la clé /F
  
  Lit la valeur de la clé <return>/F</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retourne la valeur de la clé, sous la forme d'une chaîne de caractères.

<comment>See Also:</comment>
   * <strong>fdf_set_file()</strong>


id: fdf_get_flags
type: function
doc:
<comment>Description:</comment>
  Lit les attributs d'un champ FDF
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int</info>  


id: fdf_get_opt
type: function
doc:
<comment>Description:</comment>
  Lit une valeur dans un tableau de valeur d'un champ FDF
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>mixed</info>  


id: fdf_get_status
type: function
doc:
<comment>Description:</comment>
  Lit la valeur de la clé /STATUS
  
  Lit la valeur de la clé <return>/STATUS</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retourne la valeur de la clé, sous la forme d'une chaîne de caractères.

<comment>See Also:</comment>
   * <strong>fdf_set_status()</strong>


id: fdf_get_value
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur d'un champ FDF
  
  Retourne la valeur d'un champ FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Nom du champ FDF, sous la forme d'une chaîne de caractères.
  <info>int</info>       <strong>$which</strong>         Les éléments d'un champ tableau peuvent être lus en fournissant ce
                           paramètre optionnel, sous la forme d'un entier dont la plus petite valeur
                           sera <return>0</return>. Pour les champs qui ne sont pas des tableaux, ce paramètre
                           optionnel sera ignoré.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur du champ.

<comment>See Also:</comment>
   * <strong>fdf_set_value()</strong>


id: fdf_get_version
type: function
doc:
<comment>Description:</comment>
  Lit le numéro de version de l'API FDF
  
  Retourne le numéro de version FDF pour le document <strong>$fdf_document</strong>, pour l'API si aucun paramètre
  n'est donné.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document, retourné par la fonction <strong>fdf_create()</strong>, la
                           fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retourne la version, sous la forme d'une chaîne de caractères. Pour la version actuelle du
          FDF toolkit 5.0, le numéro de version est <return>5.0</return> et le numéro de version de document est <return>1.2</return>,
          <return>1.3</return> ou <return>1.4</return>.

<comment>See Also:</comment>
   * <strong>fdf_set_version()</strong>


id: fdf_header
type: function
doc:
<comment>Description:</comment>
  Émet les en-têtes HTTP spécifiques à FDF
  
  fdf_header est une fonction de confort, pour émettre les en-têtes HTTP spécifiques à FDF. Elle
  permet  d'envoyer le type <return>Content-type:</return> avec la valeur <return>application/vnd.fdf</return>.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.


id: fdf_next_field_name
type: function
doc:
<comment>Description:</comment>
  Lit le nom du champ FDF suivant
  
  Lit le nom du champ FDF suivant. Ce nom pourra être utilisé dans plusieurs fonctions.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Nom du champ FDF, sous la forme d'une chaîne de caractères. S'il n'est
                           pas fournis, le premier champ sera retourné.

<comment>Return:</comment>
  <info>string</info>  Retourne le nom du champ, sous la forme d'une chaîne de caractères.

<comment>See Also:</comment>
   * <strong>fdf_get_value()</strong>


id: fdf_open
type: function
doc:
<comment>Description:</comment>
  Ouvre un document FDF
  
  Ouvre un document FDF.
  
  Vous pouvez également utiliser la fonction <strong>fdf_open_string()</strong> pour traiter le résultat d'un
  formulaire PDF issue d'une méthode POST.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Chemin vers le fichier FDF. Ce fichier doit contenir les données telles que
                     retournées par un formulaire PDF ou créées en utilisant les fonctions
                     <strong>fdf_create()</strong> et <strong>fdf_save()</strong>.

<comment>Return:</comment>
  <info>resource</info>  Retourne un gestionnaire de document FDF, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_open_string()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save()</strong>


id: fdf_open_string
type: function
doc:
<comment>Description:</comment>
  Lit un document FDF à partir d'une chaîne de caractères
  
  Lit un document FDF à partir d'une chaîne de caractères.
  
  Vous pouvez utiliser <strong>fdf_open_string()</strong> avec la variable $HTTP_FDF_DATA pour traiter des données de
  formulaires issues de clients distants.

<comment>Param:</comment>
  <info>string</info>  <strong>$fdf_data</strong>  Les données, comme retournés depuis un formulaire PDF ou créés en utilisant les
                     fonctions <strong>fdf_create()</strong> et <strong>fdf_save_string()</strong>.

<comment>Return:</comment>
  <info>resource</info>  Retourne un gestionnaire de document FDF, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_open()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save_string()</strong>


id: fdf_remove_item
type: function
doc:
<comment>Description:</comment>
  Configure le cadre FDF de destination pour le formulaire
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>bool</info>  


id: fdf_save
type: function
doc:
<comment>Description:</comment>
  Sauvegarde un document FDF
  
  Sauvegarde un document FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$filename</strong>      Si fourni, le FDF résultant sera écrit dans ce paramètre. Sinon, cette
                           fonction écrira le FDF dans la sortie standard PHP.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save_string()</strong>


id: fdf_save_string
type: function
doc:
<comment>Description:</comment>
  Retourne un document FDF sous forme d'une chaîne de caractères
  
  Retourne un document FDF sous forme d'une chaîne de caractères.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retourne le document, sous la forme d'une chaîne de caractères, ou <info>false</info> si une erreur
          survient.

<comment>See Also:</comment>
   * <strong>fdf_open_string()</strong>
   * <strong>fdf_close()</strong>
   * <strong>fdf_create()</strong>
   * <strong>fdf_save()</strong>


id: fdf_set_ap
type: function
doc:
<comment>Description:</comment>
  Fixe l'apparence d'un champ FDF
  
  Fixe l'apparence d'un champ FDF (i.e. la valeur de la clé <return>/AP</return>).

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$field_name</strong>    
  <info>int</info>       <strong>$face</strong>          Les valeurs possibles sont : <info>FDFNormalAP</info>, <info>FDFRolloverAP</info> et <info>FDFDownAP</info>.
  <info>string</info>    <strong>$filename</strong>      
  <info>int</info>       <strong>$page_number</strong>   

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: fdf_set_encoding
type: function
doc:
<comment>Description:</comment>
  Modifie l'encodage des caractères
  
  Modifie l'encodage des caractères du document FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$encoding</strong>      Le nom de l'encodage. Les valeurs suivantes sont supportées :
                           "<return>Shift-JIS</return>", "<return>UHC</return>", "<return>GBK</return>" et "<return>BigFive</return>".
                           
                           Une chaîne de caractères vide replace la valeur par défaut de l'encodage
                           au schéma <return>PDFDocEncoding/Unicode</return>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: fdf_set_file
type: function
doc:
<comment>Description:</comment>
  Crée un document PDF pour y afficher des données FDF
  
  Crée un document PDF pour y afficher des données FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$url</strong>           Doit être fourni sous la forme d'une URL absolue.
  <info>string</info>    <strong>$target_frame</strong>  Utilisez ce paramètre pour spécifier la frame dans laquelle le document
                           sera affiché. Vous pouvez également définir la valeur par défaut de ce
                           paramètre en utilisant la fonction <strong>fdf_set_target_frame()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_get_file()</strong>
   * <strong>fdf_set_target_frame()</strong>


id: fdf_set_flags
type: function
doc:
<comment>Description:</comment>
  Modifie une option d'un champ
  
  Modifie une option d'un champ.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Nom du champ FDF, sous la forme d'une chaîne de caractères.
  <info>int</info>       <strong>$whichFlags</strong>    
  <info>int</info>       <strong>$newFlags</strong>      

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_set_opt()</strong>


id: fdf_set_javascript_action
type: function
doc:
<comment>Description:</comment>
  Modifie l'action javascript d'un champ
  
  Modifie l'action javascript d'un champ donné.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Nom du champ FDF, sous la forme d'une chaîne de caractères.
  <info>int</info>       <strong>$trigger</strong>       
  <info>string</info>    <strong>$script</strong>        

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_set_submit_form_action()</strong>


id: fdf_set_on_import_javascript
type: function
doc:
<comment>Description:</comment>
  Ajoute du code Javascript à être exécuté lorsque Acrobat ouvre un FDF
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * <strong>fdf_add_doc_javascript()</strong>
   * <strong>fdf_set_javascript_action()</strong>


id: fdf_set_opt
type: function
doc:
<comment>Description:</comment>
  Modifie une option d'un champ
  
  Modifie une option d'un champ donné.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Nom du champ FDF, sous la forme d'une chaîne de caractères.
  <info>int</info>       <strong>$element</strong>       
  <info>string</info>    <strong>$str1</strong>          
  <info>string</info>    <strong>$str2</strong>          

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_set_flags()</strong>


id: fdf_set_status
type: function
doc:
<comment>Description:</comment>
  Fixe la valeur de la clé /STATUS
  
  Fixe la valeur de la clé <return>/STATUS</return>. Lorsqu'un client reçoit un FDF avec un statut positionné, sa
  valeur sera présenté dans une boîte d'alerte.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$status</strong>        

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_get_status()</strong>


id: fdf_set_submit_form_action
type: function
doc:
<comment>Description:</comment>
  Modifie l'action d'un formulaire
  
  Modifie l'action d'un formulaire.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document, retourné par la fonction <strong>fdf_create()</strong>, la
                           fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Nom du champ FDF, sous la forme d'une chaîne de caractères.
  <info>int</info>       <strong>$trigger</strong>       
  <info>string</info>    <strong>$script</strong>        
  <info>int</info>       <strong>$flags</strong>         

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_set_javascript_action()</strong>


id: fdf_set_target_frame
type: function
doc:
<comment>Description:</comment>
  Configure le cadre de destination pour l'affichage du formulaire
  
  Configure le cadre de destination pour l'affichage du résultat PDF défini par <strong>fdf_save_file()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$frame_name</strong>    Le nom du cadre, sous la forme d'une chaîne de caractères.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_save_file()</strong>


id: fdf_set_value
type: function
doc:
<comment>Description:</comment>
  Modifie la valeur d'un champ FDF
  
  Modifie la valeur d'un champ FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$fieldname</strong>     Nom du champ FDF, sous la forme d'une chaîne de caractères.
  <info>mixed</info>     <strong>$value</strong>         Ce paramètre devra être stocké comme une chaîne de caractères même si
                           c'est un tableau. Dans ce cas, tous les éléments du tableau seront
                           stockés comme un tableau de valeur.
  <info>int</info>       <strong>$isName</strong>        Dans les anciennes versions de la suite FDF, le dernier paramètre
                           déterminait si la valeur du champs devait être convertie en un nom PDF
                           (<strong>$isname</strong> = 1) ou positionnée comme une chaîne de caractères (<strong>$isname</strong> =
                           0).
                           
                           La valeur n'est plus dans la suite actuelle, version 5.0. Pour des
                           raisons de compatibilité,  cela est toujours supporté comme un paramètre
                           optionnel, mais ignoré en interne.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_get_value()</strong>
   * <strong>fdf_remove_item()</strong>


id: fdf_set_version
type: function
doc:
<comment>Description:</comment>
  Modifie le numéro de version du fichier FDF
  
  Modifie le numéro de version du document FDF courant.
  
  Certaines fonctionnalités supportées par cette extension ne sont  disponibles que pour les
  nouvelles versions de FDF.

<comment>Param:</comment>
  <info>resource</info>  <strong>$fdf_document</strong>  Le gestionnaire de document FDF, retourné par la fonction <strong>fdf_create()</strong>,
                           la fonction <strong>fdf_open()</strong> ou la fonction <strong>fdf_open_string()</strong>.
  <info>string</info>    <strong>$version</strong>       Le numéro de version. Pour le toolkit FDF courant, ce peut être <return>1.2</return>, <return>1.3</return>
                           ou <return>1.4</return>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdf_get_version()</strong>


id: fdiv
type: function
doc:
<comment>Description:</comment>
  Divides two numbers, according to IEEE 754
  
  Returns the floating point result of dividing the <strong>$num1</strong> by the <strong>$num2</strong>. If the <strong>$num2</strong> is zero, then
  one of <return>INF</return>, <return>-INF</return>, or <return>NAN</return> will be returned.
  
  Note that in comparisons, <return>NAN</return> will never == or ===, any value, including itself.

<comment>Param:</comment>
  <info>float</info>  <strong>$num1</strong>  The dividend (numerator)
  <info>float</info>  <strong>$num2</strong>  The divisor

<comment>Return:</comment>
  <info>float</info>  The floating point result of <strong>$num1</strong>/<strong>$num2</strong>

<comment>See Also:</comment>
   * <return>/</return> - Floating-point division
   * <strong>intdiv()</strong> - Integer division
   * <strong>fmod()</strong> - Modulus


id: feof
type: function
doc:
<comment>Description:</comment>
  Teste la fin du fichier
  
  Teste la fin du fichier.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Le pointeur de fichier doit être valide et pointer
                     sur un fichier ouvert avec succès par <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (et pas encore fermé par <strong>fclose()</strong>).

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le pointeur <strong>$handle</strong> est à la fin du fichier ou si une erreur survient,
        sinon, retourne <info>false</info>.


id: fflush
type: function
doc:
<comment>Description:</comment>
  Envoie tout le contenu généré dans un fichier
  
  Force l'écriture de toutes les données bufferisées dans le fichier désigné par <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Le pointeur de fichier doit être valide et pointer
                     sur un fichier ouvert avec succès par <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (et pas encore fermé par <strong>fclose()</strong>).

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>clearstatcache()</strong>
   * <strong>fwrite()</strong>


id: fgetc
type: function
doc:
<comment>Description:</comment>
  Lit un caractère dans un fichier
  
  Lit un caractère dans un fichier.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Le pointeur de fichier doit être valide et pointer
                     sur un fichier ouvert avec succès par <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (et pas encore fermé par <strong>fclose()</strong>).

<comment>Return:</comment>
  <info>string|false</info>  Retourne une chaîne contenant un seul caractère, lu depuis le fichier pointé par
                <strong>$stream</strong>. Retourne <info>false</info> à la fin du fichier.
                
                Cette fonction peut retourner <info>false</info>, mais elle peut aussi retourner une valeur
                équivalent à <info>false</info>. Veuillez lire la section sur les booléens pour plus
                d'informations. Utilisez l'opérateur === pour tester la valeur de retour exacte de
                cette fonction.

<comment>See Also:</comment>
   * <strong>fread()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>fgets()</strong>


id: fgetcsv
type: function
doc:
<comment>Description:</comment>
  Obtient une ligne depuis un pointeur de fichier et l'analyse pour des champs CSV
  
  Similaire à <strong>fgets()</strong> mais <strong>fgetcsv()</strong> analyse la ligne qu'il lit et recherche les champs CSV, qu'il
  va retourner dans un tableau les contenant.
  
  La définition des locales entre en jeu avec cette fonction. Si <return>LC_CTYPE</return> vaut, par exemple
  <return>en_US.UTF-8</return>, les fichiers encodés avec un encodage d'un octet peuvent être mal lus par cette
  fonction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>     Un pointeur valide sur un fichier ouvert avec <strong>fopen()</strong>, <strong>popen()</strong> ou
                        <strong>fsockopen()</strong>.
  <info>int|null</info>  <strong>$length</strong>     Doit être plus grand que la plus grande ligne (en terme de caractères)  à
                        lire dans le fichier (y compris le caractère de fin de ligne). Dans le cas
                        contraire la ligne sera scindée en tranches de <strong>$length</strong> caractères, sauf si
                        la scission se produit à l'intérieur d'un encadrement.
                        
                        Omettre ce paramètre (ou le définir à 0, ou <info>null</info> en PHP 8.0.0 ou ultérieur)
                        fait que la longueur maximale de la ligne n'est pas limitée, ce qui est
                        légèrement plus lent.
  <info>string</info>    <strong>$separator</strong>  Le paramètre optionnel <strong>$separator</strong> définit le séparateur de champ (un
                        caractère d'un seul octet).
  <info>string</info>    <strong>$enclosure</strong>  Le paramètre optionnel <strong>$enclosure</strong> définit le caractère d'encadrement de
                        texte (un caractère d'un seul octet).
  <info>string</info>    <strong>$escape</strong>     Le paramètre optionnel <strong>$escape</strong> définit le caractère d'échappement (au plus
                        un caractère d'un seul octet). Une chaîne de caractères vide (<return>""</return>) désactive
                        le mécanisme d'échappement propriétaire.
                        
                        En général un caractère d'encadrement <strong>$enclosure</strong> est échappé à l'intérieur
                        d'un champ en le dédoublant ; Cependant, le caractère d'échappement <strong>$escape</strong>
                        peut être utilisé comme une alternative. Donc pour la valeur par défaut <return>""</return>
                        et <return>\"</return> ont la même signification. Outre échapper le caractère d'encadrement
                        <strong>$enclosure</strong> le caractère d'échappement <strong>$escape</strong> n'a pas de signification
                        spéciale ; même pas de s'échapper lui-même.

<comment>Return:</comment>
  <info>array|false</info>  Retourne un tableau indexé contenant les champs lus en cas de succès,  ou <info>false</info> si
               une erreur survient.
               
               Une ligne vide dans un fichier CSV sera retournée sous la  forme d'un tableau
               contenant la valeur <info>null</info> et ne sera pas traitée  comme une erreur.
               
               Si PHP ne reconnaît pas correctement les fins de lignes lors de la lecture de
               fichiers qui ont été créés ou lus sur un Macintosh, l'activation de l'option de
               configuration auto_detect_line_endings peut régler le problème.

<comment>See Also:</comment>
   * <strong>str_getcsv()</strong>
   * <strong>explode()</strong>
   * <strong>file()</strong>
   * <strong>pack()</strong>
   * <strong>fputcsv()</strong>


id: fgets
type: function
doc:
<comment>Description:</comment>
  Récupère la ligne courante à partir de l'emplacement du pointeur sur fichier
  
  Récupère la ligne courante à partir de l'emplacement du pointeur sur fichier.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Le pointeur de fichier doit être valide et pointer
                     sur un fichier ouvert avec succès par <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (et pas encore fermé par <strong>fclose()</strong>).
  <info>int|null</info>  <strong>$length</strong>  Lit jusqu'à la taille <strong>$length</strong> - 1 octet depuis le pointeur de fichier <strong>$stream</strong>,
                     ou bien la fin du fichier, ou une nouvelle ligne (qui est inclue dans la valeur
                     retournée), ou encore un EOF (celui qui arrive en premier). Si aucune longueur
                     n'est fournie, la fonction lira le flux jusqu'à la fin de la ligne.

<comment>Return:</comment>
  <info>string|false</info>  Retourne une chaîne de caractères contenant les <strong>$length</strong> premiers caractères, moins 1
                octet depuis le pointeur de fichier <strong>$stream</strong>. <info>false</info> est retourné s'il n'y a plus de
                données à lire.
                
                Si une erreur survient, la fonction retourne <info>false</info>.

<comment>See Also:</comment>
   * <strong>fgetss()</strong>
   * <strong>fread()</strong>
   * <strong>fgetc()</strong>
   * <strong>stream_get_line()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>stream_set_timeout()</strong>


id: fgetss
type: function
doc:
<comment>Description:</comment>
  Renvoie la ligne courante du fichier et élimine les balises HTML
  
  Identique à <strong>fgets()</strong>, sauf que la fonction <strong>fgetss()</strong> supprime tous les octets nuls, toutes les
  balises HTML et PHP qu'il trouve dans le texte lu. La fonction conserve l'état de l'analyse
  d'appel en appel, et ainsi n'est pas équivalent à l'appel de <strong>strip_tags()</strong> sur la valeur de retour
  de <strong>fgets()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>          Le pointeur de fichier doit être valide et pointer
                             sur un fichier ouvert avec succès par <strong>fopen()</strong> ou
                             <strong>fsockopen()</strong> (et pas encore fermé par <strong>fclose()</strong>).
  <info>int</info>       <strong>$length</strong>          Taille des données à récupérer.
  <info>string</info>    <strong>$allowable_tags</strong>  Vous pouvez utiliser ce paramètre optionnel pour spécifier les balises
                             qui ne doivent pas être supprimées. Voir <strong>strip_tags()</strong> pour plus de
                             détails concernant <strong>$allowable_tags</strong>.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de taille <strong>$length</strong> - 1 octet lu depuis le fichier pointé par <strong>$handle</strong>,
          dont les balises HTML et PHP ont été échappées.
          
          Si une erreur survient, la fonction retourne <info>false</info>.

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>strip_tags()</strong>
   * SplFileObject::fgetss
   * Le filtre string.strip_tags


id: file
type: function
doc:
<comment>Description:</comment>
  Lit le fichier et renvoie le résultat dans un tableau
  
  Lit le fichier et renvoie le résultat dans un tableau.
  
  Vous pouvez utiliser la fonction <strong>file_get_contents()</strong> pour retourner le contenu d'un fichier dans
  une chaîne de caractères.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>  Chemin vers le fichier.
                            
                            Vous pouvez utiliser une URL comme nom de fichier avec cette fonction,
                            si le gestionnaire fopen a été activé. Voyez <strong>fopen()</strong> pour plus de
                            détails sur la façon de spécifier le nom du fichier. Reportez-vous aux
                            pour plus d'informations sur les capacités des différents gestionnaires,
                            les notes sur leur utilisation, ainsi que les informations sur les
                            variables prédéfinies qu'elles fournissent.
  <info>int</info>            <strong>$flags</strong>     Le paramètre optionnel <strong>$flags</strong> peut être une ou plusieurs des constantes
                            suivantes : <info>FILE_USE_INCLUDE_PATH</info> Recherche le fichier dans
                            l'include_path. <info>FILE_IGNORE_NEW_LINES</info> N'ajoute pas de nouvelle ligne à
                            la fin de chaque élément du tableau. <info>FILE_SKIP_EMPTY_LINES</info> Ignore les
                            lignes vides. <info>FILE_NO_DEFAULT_CONTEXT</info> N'utilise pas le contexte par
                            défaut.
                            
                            Recherche le fichier dans l'include_path.
                            
                            N'ajoute pas de nouvelle ligne à la fin de chaque élément du tableau.
                            
                            Ignore les lignes vides.
                            
                            N'utilise pas le contexte par défaut.
  <info>resource|null</info>  <strong>$context</strong>   Une <info>resource</info> de contexte de flux.

<comment>Return:</comment>
  <info>array|false</info>  Retourne le fichier dans un tableau. Chaque élément du tableau correspond à une ligne
               du fichier, et les retours-chariot sont placés en fin de ligne. Si une erreur
               survient, <strong>file()</strong> retournera <info>false</info>.
               
               Chaque ligne du tableau résultant inclura une fin de ligne, à moins que
               <info>FILE_IGNORE_NEW_LINES</info> soit utilisé.
               
               Si PHP ne reconnaît pas correctement les fins de lignes lors de la lecture de
               fichiers qui ont été créés ou lus sur un Macintosh, l'activation de l'option de
               configuration auto_detect_line_endings peut régler le problème.

<comment>See Also:</comment>
   * <strong>file_get_contents()</strong>
   * <strong>readfile()</strong>
   * <strong>fopen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>popen()</strong>
   * <strong>include()</strong>
   * <strong>stream_context_create()</strong>


id: file_exists
type: function
doc:
<comment>Description:</comment>
  Vérifie si un fichier ou un dossier existe
  
  Vérifie si un fichier ou un dossier existe.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Chemin vers le fichier ou le dossier.
                     
                     Sous Windows, utilisez le format de chemin //computername/share/filename ou
                     \\\\computername\share\filename pour vérifier qu'un fichier est disponible sur
                     le partage réseau.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le fichier ou le dossier spécifié par le paramètre <strong>$filename</strong> existe ; <info>false</info>
        sinon.
        
        Retourne <info>false</info> pour les liens symboliques pointant vers un fichier qui n'existe pas.
        
        La vérification est effectuée en utilisant l'UID/GID réel au lieu de l'effectif.
        
        Comme le type entier de PHP est signé et que de nombreuses plates-formes utilisent des
        entiers de 32 bits, certaines fonctions relatives au système de fichiers peuvent retourner
        des résultats étranges pour les fichiers de taille supérieure à 2 Go.

<comment>See Also:</comment>
   * <strong>is_readable()</strong>
   * <strong>is_writable()</strong>
   * <strong>is_file()</strong>
   * <strong>file()</strong>
   * <class>SplFileInfo</class>


id: file_get_contents
type: function
doc:
<comment>Description:</comment>
  Lit tout un fichier dans une chaîne
  
  Identique à la fonction <strong>file()</strong>, hormis le fait que <strong>file_get_contents()</strong> retourne le fichier
  <strong>$filename</strong> dans une chaîne, à partir de la position <strong>$offset</strong>, et jusqu'à <strong>$length</strong> octets. En cas
  d'erreur, <strong>file_get_contents()</strong> retourne <info>false</info>.
  
  <strong>file_get_contents()</strong> est la façon recommandée pour lire le contenu d'un fichier dans une chaîne de
  caractères. Elle utilisera un buffer en mémoire si ce mécanisme est supporté par votre système,
  afin d'améliorer les performances.
  
  Si vous ouvrez une URI avec des caractères spéciaux, comme des espaces, vous devez encoder cette
  URI avec la fonction <strong>urlencode()</strong>.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>          Nom du fichier à lire.
  <info>bool</info>           <strong>$use_include_path</strong>  La constante <info>FILE_USE_INCLUDE_PATH</info> peut être utilisée pour
                                    déclencher la recherche dans le chemin d'inclusion. Ceci est
                                    impossible si strict typing est activé, car
                                    <info>FILE_USE_INCLUDE_PATH</info> est un <info>int</info>. Utilisez <info>true</info> à la place.
  <info>resource|null</info>  <strong>$context</strong>           Une ressource de contexte valide, créée avec la fonction
                                    <strong>stream_context_create()</strong>. Si vous n'avez pas besoin d'utiliser un
                                    contexte particulier, vous pouvez ignorer ce paramètre en
                                    affectant la valeur <info>null</info>.
  <info>int</info>            <strong>$offset</strong>            La position à partir de laquelle on commence à lire dans le flux
                                    original. Une position négative compte à partir de la fin du
                                    flux.
                                    
                                    Le déplacement dans le fichier (<strong>$offset</strong>) n'est pas supporté sur
                                    des fichiers distants. Si vous tentez de vous déplacer dans un
                                    fichier qui n'est pas un fichier local peut fonctionner sur les
                                    petits déplacements, mais le comportement peut ne pas être
                                    attendu car le processus utilise le flux du buffer.
  <info>int|null</info>       <strong>$length</strong>            La taille maximale des données à lire. Le comportement par
                                    défaut est de lire jusqu'à la fin du fichier. Ce paramètre
                                    s'applique sur le flux traité par les filtres.

<comment>Return:</comment>
  <info>string|false</info>  Retourne les données lues  ou <info>false</info> si une erreur survient.
                
                Cette fonction peut retourner <info>false</info>, mais elle peut aussi retourner une valeur
                équivalent à <info>false</info>. Veuillez lire la section sur les booléens pour plus
                d'informations. Utilisez l'opérateur === pour tester la valeur de retour exacte de
                cette fonction.

<comment>See Also:</comment>
   * <strong>file()</strong>
   * <strong>fgets()</strong>
   * <strong>fread()</strong>
   * <strong>readfile()</strong>
   * <strong>file_put_contents()</strong>
   * <strong>stream_get_contents()</strong>
   * <strong>stream_context_create()</strong>
   * $http_response_header


id: file_put_contents
type: function
doc:
<comment>Description:</comment>
  Écrit des données dans un fichier
  
  Revient à appeler les fonctions <strong>fopen()</strong>,  <strong>fwrite()</strong> et <strong>fclose()</strong>  successivement.
  
  Si le fichier <strong>$filename</strong> n'existe pas, il sera créé. Sinon, le fichier existant sera écrasé, si
  l'option <info>FILE_APPEND</info> n'est pas définie.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>  Chemin vers le fichier dans lequel on doit écrire les données.
  <info>mixed</info>          <strong>$data</strong>      Les données à écrire. Peut être soit une chaîne de caractères, un
                            tableau ou une ressource de flux (explication plus bas).
                            
                            Si <strong>$data</strong> est une ressource de type <info>stream</info>, le buffer restant de ce flux
                            sera copié dans le fichier spécifié. Cela revient à utiliser la fonction
                            <strong>stream_copy_to_stream()</strong>.
                            
                            Vous pouvez également spécifier le paramètre <strong>$data</strong> en tant qu'un tableau
                            à une seule dimension. C'est l'équivalent à <return>file_put_contents($filename,
                            implode('', $array))</return>.
  <info>int</info>            <strong>$flags</strong>     La valeur du paramètre <strong>$flags</strong> peut être n'importe quelle combinaison des
                            drapeaux suivants, liés par l'opérateur binaire OU (<return>|</return>).
                            
                            Drapeaux disponiblesDrapeauDescription<info>FILE_USE_INCLUDE_PATH</info> Recherche le
                            fichier <strong>$filename</strong> dans le dossier d'inclusion. Voir include_path pour
                            plus d'informations. <info>FILE_APPEND</info> Si le fichier <strong>$filename</strong> existe déjà,
                            cette option permet d'ajouter les données au fichier au lieu de
                            l'écraser. <info>LOCK_EX</info> Acquiert un verrou exclusif sur le fichier lors de
                            l'opération d'écriture. En d'autre terme, un appel à la fonction <strong>flock()</strong>
                            survient entre l'appel à la fonction <strong>fopen()</strong> et l'appel à la fonction
                            <strong>fwrite()</strong>. Ce comportement n'est pas identique à un appel à la fonction
                            <strong>fopen()</strong> avec le mode "x".
  <info>resource|null</info>  <strong>$context</strong>   Une ressource de contexte valide créée avec la fonction
                            <strong>stream_context_create()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  Retourne le nombre d'octets qui ont été écrits au fichier, ou <info>false</info> si une erreur
             survient.
             
             Cette fonction peut retourner <info>false</info>, mais elle peut aussi retourner une valeur
             équivalent à <info>false</info>. Veuillez lire la section sur les booléens pour plus d'informations.
             Utilisez l'opérateur === pour tester la valeur de retour exacte de cette fonction.

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>fwrite()</strong>
   * <strong>file_get_contents()</strong>
   * <strong>stream_context_create()</strong>


id: fileatime
type: function
doc:
<comment>Description:</comment>
  Renvoie la date à laquelle le fichier a été accédé pour la dernière fois
  
  Renvoie la date à laquelle le fichier a été accédé pour la dernière fois.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Chemin vers le fichier.

<comment>Return:</comment>
  <info>int|false</info>  Renvoie la date à laquelle le fichier a été accédé pour la dernière fois ou <info>false</info> si
             une erreur survient. La date est retournée sous la forme d'un timestamp Unix.

<comment>See Also:</comment>
   * <strong>filemtime()</strong>
   * <strong>fileinode()</strong>
   * <strong>date()</strong>


id: filectime
type: function
doc:
<comment>Description:</comment>
  Renvoie la date de dernière modification de l'inode d'un fichier
  
  Renvoie la date de dernière modification de l'inode d'un fichier.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Chemin vers le fichier.

<comment>Return:</comment>
  <info>int|false</info>  Renvoie la date à laquelle l'inode a été modifié pour la dernière fois  ou <info>false</info> si une
             erreur survient. L'heure est retournée sous la forme d'un timestamp Unix.

<comment>See Also:</comment>
   * <strong>filemtime()</strong>


id: filegroup
type: function
doc:
<comment>Description:</comment>
  Lire le nom du groupe
  
  Lit le nom du groupe. L'identifiant de groupe est retourné au format numérique, utilisez
  <strong>posix_getgrgid()</strong> pour retrouver le nom du groupe.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Chemin vers le fichier.

<comment>Return:</comment>
  <info>int|false</info>  Retourne le groupe qui possède le fichier <strong>$filename</strong>, ou <info>false</info> si une erreur survient.
             L'identifiant de groupe est retourné au format numérique, utilisez <strong>posix_getgrgid()</strong>
             pour retrouver le nom du groupe. En cas d'erreur, <info>false</info> est retourné.

<comment>See Also:</comment>
   * <strong>fileowner()</strong>
   * <strong>posix_getgrgid()</strong>


id: fileinode
type: function
doc:
<comment>Description:</comment>
  Lit le numéro d'inode du fichier
  
  Lit le numéro d'inode du fichier.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Chemin vers le fichier.

<comment>Return:</comment>
  <info>int|false</info>  Retourne le numéro d'inode du fichier,  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>getmyinode()</strong>
   * <strong>stat()</strong>


id: filemtime
type: function
doc:
<comment>Description:</comment>
  Lit la date de dernière modification du fichier
  
  Lit la date à laquelle le fichier a été modifié pour la dernière fois.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Chemin vers le fichier.

<comment>Return:</comment>
  <info>int|false</info>  Renvoie le timestamp Unix de dernière modification du fichier <strong>$filename</strong>  ou <info>false</info> si
             une erreur survient. Utilisez <strong>date()</strong> sur ce résultat pour obtenir une date de
             modification humainement lisible.

<comment>See Also:</comment>
   * <strong>filectime()</strong>
   * <strong>stat()</strong>
   * <strong>touch()</strong>
   * <strong>getlastmod()</strong>


id: fileowner
type: function
doc:
<comment>Description:</comment>
  Lit l'identifiant du propriétaire d'un fichier
  
  Lit l'identifiant du propriétaire d'un fichier.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Chemin vers le fichier.

<comment>Return:</comment>
  <info>int|false</info>  Renvoie l'identifiant du propriétaire du fichier <strong>$filename</strong>,  ou <info>false</info> si une erreur
             survient. L'identifiant du propriétaire est numérique : il faut utiliser
             <strong>posix_getpwuid()</strong> pour retrouver le nom d'utilisateur.

<comment>See Also:</comment>
   * <strong>filegroup()</strong>
   * <strong>stat()</strong>
   * <strong>posix_getpwuid()</strong>


id: fileperms
type: function
doc:
<comment>Description:</comment>
  Lit les droits d'un fichier
  
  Lit les droits du fichier donné.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Chemin vers le fichier.

<comment>Return:</comment>
  <info>int|false</info>  Retourne les permissions du fichier sous forme numérique. Les bits de poids faible sont
             les mêmes que ceux des permissions dans <strong>chmod()</strong>, cependant certaines plateformes
             incluent dans le retour des informations sur le type de fichier donné dans <strong>$filename</strong>.
             Les exemples qui suivent montrent comment tester la valeur de retour concernant les
             permissions et le type de fichier sur des systèmes POSIX comme Linux ou macOS.
             
             Pour les fichiers locaux, la valeur spécifique <return>st_mode</return> de la structure C retournée par
             la fonction <strong>stat()</strong> est utilisée. Les bits affectés peuvent changer en fonction de la
             plateforme et vous devriez vous renseigner à son sujet si vous devez analyser les bits
             ne concernant pas la permission.
             
             Returns <info>false</info> on failure.

<comment>See Also:</comment>
   * <strong>chmod()</strong>
   * <strong>is_readable()</strong>
   * <strong>stat()</strong>


id: filesize
type: function
doc:
<comment>Description:</comment>
  Lit la taille d'un fichier
  
  Lit la taille du fichier donné.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Chemin vers le fichier.

<comment>Return:</comment>
  <info>int|false</info>  Renvoie la taille du fichier <strong>$filename</strong> en octets, ou <info>false</info> (et génère une erreur de
             niveau <info>E_WARNING</info>) en cas d'erreur.
             
             Comme le type entier de PHP est signé et que de nombreuses plates-formes utilisent des
             entiers de 32 bits, certaines fonctions relatives au système de fichiers peuvent
             retourner des résultats étranges pour les fichiers de taille supérieure à 2 Go.

<comment>See Also:</comment>
   * <strong>file_exists()</strong>


id: filetype
type: function
doc:
<comment>Description:</comment>
  Retourne le type de fichier
  
  Retourne le type d'un fichier donné.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Chemin vers le fichier.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le type du fichier. Les réponses possibles sont : <return>fifo</return>, <return>char</return>, <return>dir</return>, <return>block</return>,
                <return>link</return>, <return>file</return> <return>socket</return> et <return>unknown</return>.
                
                Retourne <info>false</info> en cas d'erreur. <strong>filetype()</strong> va aussi émettre une erreur <info>E_NOTICE</info> si
                l'appel stat échoue, ou si le type de fichier est inconnu.

<comment>See Also:</comment>
   * <strong>is_dir()</strong>
   * <strong>is_file()</strong>
   * <strong>is_link()</strong>
   * <strong>file_exists()</strong>
   * <strong>mime_content_type()</strong>
   * <strong>pathinfo()</strong>
   * <strong>stat()</strong>


id: filter_has_var
type: function
doc:
<comment>Description:</comment>
  Vérifie si une variable d'un type spécifique existe

<comment>Param:</comment>
  <info>int</info>     <strong>$input_type</strong>  Une constante parmi <info>INPUT_GET</info>, <info>INPUT_POST</info>, <info>INPUT_COOKIE</info>, <info>INPUT_SERVER</info> ou
                       <info>INPUT_ENV</info>.
  <info>string</info>  <strong>$var_name</strong>    Nom de la variable à vérifier.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: filter_id
type: function
doc:
<comment>Description:</comment>
  Retourne l'identifiant d'un filtre nommé

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Nom du filtre à récupérer.

<comment>Return:</comment>
  <info>int|false</info>  Identifiant du filtre en cas de succès, ou <info>false</info> si le filtre n'existe pas.

<comment>See Also:</comment>
   * <strong>filter_list()</strong>


id: filter_input
type: function
doc:
<comment>Description:</comment>
  Récupère une variable externe et la filtre

<comment>Param:</comment>
  <info>int</info>        <strong>$type</strong>      Une constante parmi <info>INPUT_GET</info>, <info>INPUT_POST</info>, <info>INPUT_COOKIE</info>, <info>INPUT_SERVER</info> ou
                        <info>INPUT_ENV</info>.
  <info>string</info>     <strong>$var_name</strong>  Nom de la variable à récupérer.
  <info>int</info>        <strong>$filter</strong>    L'ID du filtre à appliquer. La  page du manuel liste les filtres
                        disponibles.
                        
                        Si non spécifié, <info>FILTER_DEFAULT</info> sera utilisé, ce qui est équivalent à
                        <info>FILTER_UNSAFE_RAW</info>. Cela reviendra à n'avoir aucun filtre en place par
                        défaut.
  <info>array|int</info>  <strong>$options</strong>   Tableau associatif d'options ou des drapeaux. Si le filtre accepte les
                        options, les drapeaux peuvent être fournis dans le champ "flags" du tableau.

<comment>Return:</comment>
  <info>mixed</info>  Valeur de la variable demandée en cas de succès, <info>false</info> si le filtre échoue, ou <info>null</info> si la
         variable <strong>$var_name</strong> n'est pas définie. Si le drapeau <info>FILTER_NULL_ON_FAILURE</info> est utilisé, la
         fonction retournera <info>false</info> si la variable n'est pas définie et <info>null</info> si le filtre échoue.

<comment>See Also:</comment>
   * <strong>filter_var()</strong>
   * <strong>filter_input_array()</strong>
   * <strong>filter_var_array()</strong>
   * 


id: filter_input_array
type: function
doc:
<comment>Description:</comment>
  Récupère plusieurs valeurs externes et les filtre
  
  Cette fonction est utile pour récupérer plusieurs valeurs sans avoir à appeler plusieurs fois la
  fonction <strong>filter_input()</strong>.

<comment>Param:</comment>
  <info>int</info>        <strong>$type</strong>       Une constante parmi <info>INPUT_GET</info>, <info>INPUT_POST</info>, <info>INPUT_COOKIE</info>, <info>INPUT_SERVER</info> ou
                         <info>INPUT_ENV</info>.
  <info>array|int</info>  <strong>$options</strong>    Un tableau définissant les arguments. Une clé valide est une chaîne de
                         caractères contenant le nom de la variable et une valeur valide est soit le
                         type d'un filtre, soit un tableau spécifiant le filtre, les drapeaux et les
                         options. Si la valeur est un tableau, les clés valides sont <return>filter</return> qui
                         spécifie le type du filtre, <return>flags</return> qui spécifie tous les drapeaux à
                         appliquer au filtre, et <return>options</return> qui spécifie toutes les options à appliquer
                         au filtre. Voir l'exemple ci-dessous pour une meilleure compréhension.
                         
                         Ce paramètre peut également être un entier contenant une constante de
                         filtre. Ensuite, toutes les valeurs du tableau d'entrée seront filtrées par
                         ce filtre.
  <info>bool</info>       <strong>$add_empty</strong>  Ajout des clés manquantes à la valeur <info>null</info> dans la valeur retournée.

<comment>Return:</comment>
  <info>array|false|null</info>  Un tableau contenant les valeurs des variables demandées en cas de succès. Si le
                    tableau d'entrée désigné par <strong>$type</strong> n'est pas populé, la fonction retourne <info>null</info>
                    si le drapeau <info>FILTER_NULL_ON_FAILURE</info> n'est pas donnée, sinon <info>false</info> dans le cas
                    contraire. Pour les autres échecs, <info>false</info> est retourné.
                    
                    Un tableau de valeurs peut valoir <info>false</info> si le filtre échoue, ou <info>null</info> si la
                    variable n'est pas définie. Ou, si le drapeau <info>FILTER_NULL_ON_FAILURE</info> est
                    utilisé, la fonction retournera <info>false</info> si la variable n'est pas définie et <info>null</info>
                    si le filtre échoue. Si le paramètre <strong>$add_empty</strong> est <info>false</info>, aucun élément du
                    tableau sera ajouté pour les variables non définie.

<comment>See Also:</comment>
   * <strong>filter_input()</strong>
   * <strong>filter_var_array()</strong>
   * 


id: filter_list
type: function
doc:
<comment>Description:</comment>
  Retourne une liste de tous les filtres supportés

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau de noms de tous les filtres supportés, un tableau vide s'il n'y a pas
         de filtre. Les index de ce tableau ne sont pas les identifiants des filtres, ils peuvent
         être obtenus avec la fonction <strong>filter_id()</strong> à partir du nom.


id: filter_var
type: function
doc:
<comment>Description:</comment>
  Filtre une variable avec un filtre spécifique

<comment>Param:</comment>
  <info>mixed</info>      <strong>$value</strong>    Valeur à filtrer. Notez que les valeurs scalaires sont converties en chaîne
                       de caractères en interne avant qu'elles ne soient filtrées.
  <info>int</info>        <strong>$filter</strong>   L'ID du filtre à appliquer. La  page du manuel liste les filtres disponibles.
                       
                       Si non spécifié, <info>FILTER_DEFAULT</info> sera utilisé, ce qui est équivalent à
                       <info>FILTER_UNSAFE_RAW</info>. Cela reviendra à n'avoir aucun filtre en place par défaut.
  <info>array|int</info>  <strong>$options</strong>  Tableau associatif d'options ou des drapeaux. Si le filtre accepte les
                       options, les drapeaux peuvent être fournis dans le champ "flags" du tableau.
                       Pour les fonctions de rappel, le type <info>callable</info> devra être passé. La fonction
                       de rappel doit accepter un seul argument ; la valeur à filtrer et retournera
                       la valeur, une fois le filtre appliqué.
                       
                        array( 'default' => 3, // valeur à retourner si le filtre échoue // autres
                       options ici... 'min_range' => 0 ), 'flags' => FILTER_FLAG_ALLOW_OCTAL,
                       );
                       $var = filter_var('0755', FILTER_VALIDATE_INT, $options);
                       
                       // Pour les filtres qui n'acceptent que des drapeaux,
                       // vous pouvez les passer directement
                       $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, FILTER_NULL_ON_FAILURE);
                       
                       // Pour les filtres qui n'acceptent que des drapeaux,
                       // vous pouvez également les passer sous forme de tableau
                       $var = filter_var('oops', FILTER_VALIDATE_BOOLEAN, array('flags' =>
                       FILTER_NULL_ON_FAILURE));
                       
                       // Fonction de rappel du filtre
                       function foo($value)
                       { // Format attendu: Surname, GivenNames if (strpos($value, ", ") === false)
                       return false; list($surname, $givennames) = explode(", ", $value, 2); $empty
                       = (empty($surname) || empty($givennames)); $notstrings =
                       (!is_string($surname) || !is_string($givennames)); if ($empty || $notstrings)
                       { return false; } else { return $value; }
                       }
                       $var = filter_var('Doe, Jane Sue', FILTER_CALLBACK, array('options' =>
                       'foo'));
                       ?> ]]>

<comment>Return:</comment>
  <info>mixed</info>  Retourne les données filtrées, ou <info>false</info> si le filtre échoue.

<comment>See Also:</comment>
   * <strong>filter_var_array()</strong>
   * <strong>filter_input()</strong>
   * <strong>filter_input_array()</strong>
   * 


id: filter_var_array
type: function
doc:
<comment>Description:</comment>
  Récupère plusieurs variables et les filtre
  
  Cette fonction est utile pour récupérer plusieurs valeurs sans appeler plusieurs fois la fonction
  <strong>filter_var()</strong>.

<comment>Param:</comment>
  <info>array</info>      <strong>$array</strong>      Un tableau avec les clés contenant les données à filtrer.
  <info>array|int</info>  <strong>$options</strong>    Un tableau définissant les arguments. Une clé valide est une chaîne de
                         caractères contenant le nom de la variable et une valeur valide est soit le
                         type d'un filtre, soit un tableau spécifiant le filtre, les drapeaux et les
                         options. Si la valeur est un tableau, les clés valides sont <return>filter</return> qui
                         spécifie le type du filtre, <return>flags</return> qui spécifie tous les drapeaux à
                         appliquer au filtre, et <return>options</return> qui spécifie toutes les options à appliquer
                         au filtre. Voir l'exemple ci-dessous pour une meilleure compréhension.
                         
                         Ce paramètre peut également être un entier contenant une constante de
                         filtre. Ensuite, toutes les valeurs du tableau d'entrée seront filtrées par
                         ce filtre.
  <info>bool</info>       <strong>$add_empty</strong>  Ajout des clés manquantes à la valeur <info>null</info> dans la valeur retournée.

<comment>Return:</comment>
  <info>array|false|null</info>  Un tableau contenant les valeurs des variables demandées en cas de succès, ou
                    <info>false</info> si une erreur survient. Un tableau de valeurs peut valoir <info>false</info> si le
                    filtre échoue, ou <info>null</info> si la variable n'est pas définie.

<comment>See Also:</comment>
   * <strong>filter_input_array()</strong>
   * <strong>filter_var()</strong>
   * <strong>filter_input()</strong>
   * 


id: finfo
type: class
doc:
<comment>Description:</comment>
  Cette classe fournit une interface orientée objet aux fonctions fileinfo.


id: finfo::__construct
type: function
doc:
<comment>Description:</comment>
  Alias de finfo_open
  
  Cette fonction est un alias de :  <strong>finfo_open()</strong>


id: finfo::buffer
type: function
doc:
<comment>Description:</comment>
  Alias de finfo_buffer()
  
  Cette fonction est un alias de :  finfo_buffer()

<comment>Return:</comment>
  <info>string|false</info>  


id: finfo::file
type: function
doc:
<comment>Description:</comment>
  Alias de finfo_file()
  
  Cette fonction est un alias de :  finfo_file()

<comment>Return:</comment>
  <info>string|false</info>  


id: finfo::set_flags
type: function
doc:
<comment>Description:</comment>
  Alias de finfo_set_flags()
  
  Cette fonction est un alias de :  finfo_set_flags()

<comment>Return:</comment>
  <info>bool</info>  


id: finfo_buffer
type: function
doc:
<comment>Description:</comment>
  Retourne des informations à propos d'une chaîne de caractères tampon
  
  Style procédural
  
  Style orienté objet
  
  Cette fonction est utilisée pour récupérer des informations à propos de données binaires dans une
  chaîne de caractères.

<comment>Param:</comment>
  <info>finfo</info>          <strong>$finfo</strong>    Une instance <class>finfo</class>, retourné par <strong>finfo_open()</strong>.
  <info>string</info>         <strong>$string</strong>   Contenu d'un fichier à être vérifié.
  <info>int</info>            <strong>$flags</strong>    Une ou une union de plusieurs constantes Fileinfo.
  <info>resource|null</info>  <strong>$context</strong>  

<comment>Return:</comment>
  <info>string|false</info>  Retourne une description textuelle de l'argument <strong>$string</strong> ou <info>false</info> si une erreur
                s'est produite.

<comment>See Also:</comment>
   * <strong>finfo_file()</strong>


id: finfo_close
type: function
doc:
<comment>Description:</comment>
  Ferme une instance finfo
  
  Cette fonction ferme l'instance ouverte par <strong>finfo_open()</strong>.

<comment>Param:</comment>
  <info>finfo</info>  <strong>$finfo</strong>  Une instance <class>finfo</class>, retourné par <strong>finfo_open()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: finfo_file
type: function
doc:
<comment>Description:</comment>
  Retourne des informations à propos d'un fichier
  
  Style procédural
  
  Style orienté objet
  
  Cette fonction est utilisée pour récupérer des informations à propos d'un fichier.

<comment>Param:</comment>
  <info>finfo</info>          <strong>$finfo</strong>     Une instance <class>finfo</class>, retourné par <strong>finfo_open()</strong>.
  <info>string</info>         <strong>$filename</strong>  Nom d'un fichier à vérifier.
  <info>int</info>            <strong>$flags</strong>     Une ou une union de plusieurs constantes Fileinfo.
  <info>resource|null</info>  <strong>$context</strong>   Pour une description de <return>contexts</return>, référez-vous à .

<comment>Return:</comment>
  <info>string|false</info>  Retourne une description textuelle du contenu de l'argument <strong>$filename</strong> ou <info>false</info> si
                une erreur s'est produite.

<comment>See Also:</comment>
   * <strong>finfo_buffer()</strong>


id: finfo_open
type: function
doc:
<comment>Description:</comment>
  Crée une nouvelle instance finfo
  
  Style procédural
  
  Style orienté objet (constructor):
  
  Cette fonction ouvre une base de données magique et retourne son instance.

<comment>Param:</comment>
  <info>int</info>          <strong>$flags</strong>           Une ou une union de plusieurs constantes Fileinfo.
  <info>string|null</info>  <strong>$magic_database</strong>  Nom de fichier d'une base de données magique, normalement quelque
                                chose comme /path/to/magic.mime. Si non spécifié, la variable
                                d'environnement <return>MAGIC</return> est utilisée. Si la variable d'environnement
                                n'est pas définie, la base de données magique embarquée à PHP sera
                                utilisée.
                                
                                Le fait de passer <info>null</info> ou une chaîne de caractères vide équivaut à
                                utiliser la valeur par défaut.

<comment>Return:</comment>
  <info>finfo|false</info>  (Uniquement en mode procédural) Retourne une instance de <class>finfo</class> en cas de succès, ou
               <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>finfo_close()</strong>


id: finfo_set_flags
type: function
doc:
<comment>Description:</comment>
  Fixe des options de configuration libmagic
  
  Style procédural
  
  Style orienté objet
  
  Cette fonction fixe diverses options de Fileinfo. Les options peuvent être aussi fixées
  directement dans <strong>finfo_open()</strong> ou par d'autres fonctions Fileinfo.

<comment>Param:</comment>
  <info>finfo</info>  <strong>$finfo</strong>  Une instance <class>finfo</class>, retourné par <strong>finfo_open()</strong>.
  <info>int</info>    <strong>$flags</strong>  Une ou une union de plusieurs constantes Fileinfo.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: floatval
type: function
doc:
<comment>Description:</comment>
  Convertit une chaîne en nombre à virgule flottante
  
  <strong>floatval()</strong> retourne la valeur de type <info>float</info>  (nombre à virgule flottante), extraite à partir du
  paramètre <strong>$value</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Peut être de n'importe quel type scalaire. <strong>floatval()</strong> ne doit pas être utilisé sur
                 les objets ; si tel est le cas, une alerte de niveau <info>E_WARNING</info> sera émise et la
                 fonction retournera 1.

<comment>Return:</comment>
  <info>float</info>  La valeur flottante de la variable donnée. Un tableau vide retourne 0, alors qu'un tableau
         non-vide retourne 1.
         
         Les chaînes de caractères retourneront la plupart du temps 0, mais cela dépend du caractère
         le plus à gauche de la chaîne. Les règles classiques de transtypage d'un nombre à virgule
         flottante sont appliquées.

<comment>See Also:</comment>
   * <strong>boolval()</strong>
   * <strong>intval()</strong>
   * <strong>strval()</strong>
   * <strong>settype()</strong>
   * Transtypage


id: flock
type: function
doc:
<comment>Description:</comment>
  Verrouille le fichier
  
  <strong>flock()</strong> permet de réaliser un système simple de verrous écriture/lecture, qui peut être utilisé
  sur n'importe quelle plate-forme (Unix et Windows compris).
  
  Le verrou est également levé avec <strong>fclose()</strong>, ou quand <strong>$stream</strong> est ramassé par le ramasse-miette.
  
  PHP dispose d'un système complet de verrouillage de fichiers. Tous les programmes qui accèdent au
  fichier doivent utiliser la même méthode de verrouillage pour qu'il soit efficace. Par défaut,
  cette fonction se bloquera tant que le verrou demandé ne sera pas acquis ; ce comportement peut
  être contrôlé avec l'option <info>LOCK_NB</info> dont vous trouverez la documentation ci-dessous.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>       Un pointeur de système de fichiers de type ressource
                          qui est habituellement créé en utilisant la fonction <strong>fopen()</strong>.
  <info>int</info>       <strong>$operation</strong>    <strong>$operation</strong> peut prendre une des valeurs suivantes : <info>LOCK_SH</info> pour acquérir
                          un verrou partagé (lecture). <info>LOCK_EX</info> pour acquérir un verrou exclusif
                          (écriture). <info>LOCK_UN</info> pour libérer un verrou (partagé ou exclusif).
                          
                          <info>LOCK_SH</info> pour acquérir un verrou partagé (lecture).
                          
                          <info>LOCK_EX</info> pour acquérir un verrou exclusif (écriture).
                          
                          <info>LOCK_UN</info> pour libérer un verrou (partagé ou exclusif).
                          
                          Il est également possible d'ajouter <info>LOCK_NB</info> comme masque d'une des
                          opérations précédentes si vous ne voulez pas que la fonction <strong>flock()</strong>
                          bloque durant le verrouillage.
  <info>int</info>       <strong>$would_block</strong>  Ce troisième argument optionnel est défini à 1 si le verrou doit bloquer
                          le script (condition d'erreur <return>EWOULDBLOCK</return>).

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: floor
type: function
doc:
<comment>Description:</comment>
  Arrondit à l'entier inférieur
  
  Retourne la valeur entière suivante la plus basse (en tant que float) en  arrondissant la valeur
  <strong>$num</strong> si nécessaire.

<comment>Param:</comment>
  <info>int|float</info>  <strong>$num</strong>  La valeur numérique à arrondir

<comment>Return:</comment>
  <info>float</info>  <strong>floor()</strong> retourne l'entier inférieur du nombre <strong>$num</strong>. La valeur retournée est un nombre à
         virgule flottante (nombre décimal).

<comment>See Also:</comment>
   * <strong>ceil()</strong>
   * <strong>round()</strong>


id: flush
type: function
doc:
<comment>Description:</comment>
  Vide les tampons de sortie du système
  
  Vide les tampons d'écriture système de PHP et tous ceux que PHP utilisait  (CGI, un serveur web,
  etc.). Cette fonction tente d'envoyer tout l'affichage courant au navigateur, sous quelques
  conditions.
  
  <strong>flush()</strong> peut ne pas être capable d'écraser le schéma du tampon de votre serveur web et ceci n'aura
  aucun effet sur le tampon du navigateur côté client. De plus, cette fonction n'affecte pas le
  mécanisme d'affichage du tampon de l'espace utilisateur de PHP. Cela signifie que <strong>ob_flush()</strong>
  devrait être appelé avant <strong>flush()</strong> pour vider les tampons de sortie s'ils sont utilisés.
  
  De nombreux serveurs, essentiellement sous Windows, continueront à temporiser l'affichage de votre
  script jusqu'à ce qu'il soit terminé, avant de transmettre les résultats à l'internaute.
  
  Des modules Apache comme mod_gzip utilisent leur propre temporisation, ce qui fait que <strong>flush()</strong>
  n'enverra pas les données jusqu'au navigateur client immédiatement.
  
  Même le navigateur peut réaliser une temporisation avant de l'afficher. Netscape, par exemple, met
  en cache le texte jusqu'à ce qu'il reçoive une fin de ligne, ou un début d'une balise et il
  n'affichera pas les tables tant que la balise \</table&gt; la plus externe ne soit vue.
  
  Certaines versions de Microsoft Internet Explorer ne commenceront l'affichage de la page qu'après
  avoir reçu 256 octets d'affichage. Cela vous obligera à envoyer des espaces supplémentaires pour
  afficher la page.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.

<comment>See Also:</comment>
   * <strong>ob_flush()</strong>
   * <strong>ob_clean()</strong>
   * <strong>ob_end_flush()</strong>
   * <strong>ob_end_clean()</strong>


id: fmod
type: function
doc:
<comment>Description:</comment>
  Retourne le reste de la division
  
  Retourne le reste de la division de <strong>$num1</strong> par <strong>$num2</strong>. Ce reste est un nombre à virgule flottante.
  Le reste (r) est défini par : num1 = i * num2 + r, pour un entier i. Si <strong>$num2</strong> n'est pas nul, r a
  le même signe que <strong>$num1</strong> et une taille inférieure à celle de <strong>$num2</strong>.

<comment>Param:</comment>
  <info>float</info>  <strong>$num1</strong>  Le dividende
  <info>float</info>  <strong>$num2</strong>  Le diviseur

<comment>Return:</comment>
  <info>float</info>  Le reste de la division de <strong>$num1</strong> par <strong>$num2</strong>.

<comment>See Also:</comment>
   * <return>/</return> - Division à virgule flottante
   * <return>%</return> - Modulo d'entier
   * <strong>intdiv()</strong> - Division d'entier


id: fnmatch
type: function
doc:
<comment>Description:</comment>
  Teste un nom de fichier au moyen d'un masque de recherche
  
  <strong>fnmatch()</strong> vérifie si la chaîne <strong>$filename</strong> va passer le masque Shell <strong>$pattern</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>   Le masque Shell.
  <info>string</info>  <strong>$filename</strong>  La chaîne testée. Cette fonction est particulièrement utile pour les noms de
                     fichier, mais peut également être utilisée sur des chaînes régulières.
                     
                     L'utilisateur moyen de Shell peut être familier avec les masques Shell, ou tout
                     au moins, leurs expressions les plus simples, comme <return>'?'</return> et <return>'*'</return>. De cette façon,
                     utiliser  <strong>fnmatch()</strong> au lieu de <strong>preg_match()</strong> pour des recherches peut être plus
                     pratique pour les non-initiés.
  <info>int</info>     <strong>$flags</strong>     La valeur de <strong>$flags</strong> peut être une combinaison des drapeaux suivants, joins avec
                     l' opérateur binaire OR (|).  Liste des drapeaux possibles pour <strong>fnmatch()</strong>
                     <strong>$Flag</strong>Description<info>FNM_NOESCAPE</info> Désactive l'échappement des antislashes.
                     <info>FNM_PATHNAME</info> Un slash dans une chaîne correspond uniquement à un slash dans le
                     masque fourni. <info>FNM_PERIOD</info> Un point en début de chaîne doit correspondre
                     exactement à un point dans le masque fourni. <info>FNM_CASEFOLD</info> Les correspondances
                     ne tiennent pas compte de la casse. Fait parti de l'extension GNU.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> s'il y a des résultats, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>glob()</strong>
   * <strong>preg_match()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: fopen
type: function
doc:
<comment>Description:</comment>
  Ouvre un fichier ou une URL
  
  <strong>fopen()</strong> crée une ressource nommée, spécifiée par le paramètre <strong>$filename</strong>, sous la forme d'un flux.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>          Si <strong>$filename</strong> est de la forme "protocole://", <strong>$filename</strong> est
                                    supposé être une URL, et PHP va rechercher un gestionnaire de
                                    protocole adapté pour lire ce fichier. Si aucun gestionnaire
                                    pour ce protocole n'est disponible, PHP va émettre une alerte
                                    qui vous permettra de savoir que vous avez des problèmes dans
                                    votre script, et il tentera d'exploiter <strong>$filename</strong> comme un
                                    fichier classique.
                                    
                                    Si PHP décide que le fichier <strong>$filename</strong> est un fichier local, il
                                    va essayer d'ouvrir un flux avec ce fichier. Le fichier doit
                                    être accessible à PHP. Il vous faut donc vous assurer que vous
                                    avez les droits d'accès à ce fichier. Si vous activez la
                                    directive open_basedir, d'autres conditions peuvent aussi
                                    s'appliquer.
                                    
                                    Si PHP a décidé que <strong>$filename</strong> spécifie un protocole enregistré,
                                    et que ce protocole est enregistré comme un protocole réseau,
                                    PHP s'assurera que la directive allow_url_fopen est activée. Si
                                    elle est inactive, PHP va émettre une alerte et l'ouverture va
                                    échouer.
                                    
                                    La liste des protocoles supportés est disponible sur . Certains
                                    protocoles (appelés aussi <return>wrappers</return> ou gestionnaires) supportent
                                    des <return>context</return> et/ou des options dans le fichier php.ini.
                                    Référez-vous aux pages du manuel traitant le protocole, pour
                                    connaître la liste des options qui sont disponibles. ( e.g.
                                    l'option de php.ini <return>user_agent</return> est utilisée par le gestionnaire
                                    <return>http</return>).
                                    
                                    Sous Windows, assurez-vous de bien protéger les antislashs
                                    utilisés dans le chemin du fichier, ou bien utilisez des slashs.
                                    ]]>
  <info>string</info>         <strong>$mode</strong>              Le paramètre <strong>$mode</strong> spécifie le type d'accès désiré au flux. Il
                                    peut prendre les valeurs suivantes :  Liste des modes possibles
                                    pour la fonction <strong>fopen()</strong> en utilisant le paramètre <strong>$mode</strong>
                                    <strong>$mode</strong>Description<return>'r'</return> Ouvre en lecture seule et place le pointeur
                                    de fichier au début du fichier. <return>'r+'</return> Ouvre en lecture et
                                    écriture et place le pointeur de fichier au début du fichier.
                                    <return>'w'</return> Ouvre en écriture seule ; place le pointeur de fichier au
                                    début du fichier et réduit la taille du fichier à 0. Si le
                                    fichier n'existe pas, on tente de le créer. <return>'w+'</return> Ouvre en
                                    lecture et écriture ; le comportement est le même que pour <return>'w'</return>.
                                    <return>'a'</return> Ouvre en écriture seule ; place le pointeur de fichier à la
                                    fin du fichier. Si le fichier n'existe pas, on tente de le
                                    créer. Dans ce mode, la fonction <strong>fseek()</strong> n'a aucun effet, les
                                    écritures surviennent toujours. <return>'a+'</return> Ouvre en lecture et
                                    écriture ; place le pointeur de fichier à la fin du fichier. Si
                                    le fichier n'existe pas, on tente de le créer. Dans ce mode, la
                                    fonction <strong>fseek()</strong> n'affecte que la position de lecture, les
                                    écritures sont toujours  ajoutées à la fin. <return>'x'</return> Crée et ouvre le
                                    fichier en écriture seulement ; place le pointeur de fichier au
                                    début du fichier. Si le fichier existe déjà, <strong>fopen()</strong> va échouer,
                                    en retournant <info>false</info> et en générant une erreur de niveau
                                    <info>E_WARNING</info>. Si le fichier n'existe pas, <strong>fopen()</strong> tente de le
                                    créer. Ce mode est l'équivalent des options <return>O_EXCL|O_CREAT</return> pour
                                    l'appel système <return>open(2)</return> sous-jacent. <return>'x+'</return> Crée et ouvre le
                                    fichier pour lecture et écriture ; le comportement est le même
                                    que pour <return>'x'</return>. <return>'c'</return> Ouvre le fichier pour écriture seulement. Si
                                    le fichier n'existe pas, il sera créé, s'il existe, il n'est pas
                                    tronqué (contrairement à <return>'w'</return>) et l'appel à la fonction n'échoue
                                    pas (comme dans le cas de <return>'x'</return>). Le pointeur du fichier est
                                    positionné au début. Ce mode peut être utile pour obtenir un
                                    verrou (voyez <strong>flock()</strong>) avant de tenter de modifier le fichier,
                                    utiliser <return>'w'</return> pourrait tronquer le fichier avant d'obtenir le
                                    verrou (vous pouvez toujours tronquer grâce à <strong>ftruncate()</strong>). <return>'c+'</return>
                                    Ouvre le fichier pour lecture et écriture, le comportement est
                                    le même que pour le mode <return>'c'</return>. <return>'e'</return> Défini l'indicateur
                                    close-on-exec sur le descripteur de fichier  ouvert. Disponible
                                    uniquement en PHP compilé sur les systèmes  conforme
                                    POSIX.1-2008.
                                    
                                    Les systèmes d'exploitation utilisent différents caractères pour
                                    les nouvelles lignes. Lorsque vous écrivez un fichier texte et
                                    insérez une nouvelle ligne, vous devez utiliser le bon caractère
                                    pour votre système d'exploitation. Les systèmes Unix utilisent
                                    <return>\n</return> comme nouvelle ligne, les systèmes Windows utilisent <return>\r\n</return>, et
                                    les systèmes Macintosh (Mac OS Classic) utilisent <return>\r</return>.
                                    
                                    Si vous n'utilisez pas le bon caractère de nouvelle ligne lors
                                    de l'écriture de vos fichiers, vous risquez d'ouvrir vos
                                    fichiers avec des applications qui donneront un aspect 'bizarre'
                                    au texte.
                                    
                                    Windows propose un mode de traduction (<return>'t'</return>), qui va traduire
                                    automatiquement les caractères <return>\n</return> en <return>\r\n</return> lorsque vous
                                    travaillez sur le fichier. À l'inverse, vous pouvez utiliser
                                    l'option <return>'b'</return> pour forcer le fichier à être écrit en mode
                                    binaire, sans traduction des données. Pour utiliser ces options,
                                    ajoutez <return>'b'</return> ou <return>'t'</return> comme dernier caractère du paramètre <strong>$mode</strong>.
                                    
                                    Le mode de traduction par défaut est <return>'b'</return>. Vous pouvez utiliser
                                    <return>'t'</return> lorsque vous écrivez des fichiers de texte et le caractère
                                    <return>\n</return> pour définir vos fin de ligne, dans les scripts, mais que
                                    vous vous attendez à ce que le fichier soit relu par une
                                    application comme les anciennes versions de Notepad. Vous
                                    devriez toujours utiliser l'option <return>'b'</return> dans les autres cas.
                                    
                                    Si vous spécifiez <return>'t'</return> lorsque vous travaillez avec des fichiers
                                    binaires, vous pourriez rencontrer des problèmes avec vos
                                    données, comme des images corrompues ou des caractères <return>\r\n</return>
                                    inopinés.
                                    
                                    Pour des raisons de portabilité, il est fortement recommandé de
                                    réécrire les scripts qui utilisent l'option <return>'t'</return>, pour qu'ils
                                    utilisent le bon caractère de nouvelle ligne et le mode <return>'b'</return>.
                                    
                                    Le <strong>$mode</strong> est ignoré pour les enveloppes de flux php://output,
                                    php://input, php://stdin, php://stdout, php://stderr et
                                    php://fd.
  <info>bool</info>           <strong>$use_include_path</strong>  Le troisième paramètre optionnel <strong>$use_include_path</strong>  peut être
                                    défini à 1 ou à <info>true</info> pour chercher le fichier dans
                                    l'include_path.
  <info>resource|null</info>  <strong>$context</strong>           Une <info>resource</info> de contexte de flux.

<comment>Return:</comment>
  <info>resource|false</info>  Retourne une ressource représentant le pointeur de fichier, ou <info>false</info> si une erreur
                  survient

<comment>See Also:</comment>
   * 
   * <strong>fclose()</strong>
   * <strong>fgets()</strong>
   * <strong>fread()</strong>
   * <strong>fwrite()</strong>
   * <strong>fsockopen()</strong>
   * <strong>file()</strong>
   * <strong>file_exists()</strong>
   * <strong>is_readable()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>popen()</strong>
   * <strong>stream_context_create()</strong>
   * <strong>umask()</strong>
   * <class>SplFileObject</class>


id: forward_static_call
type: function
doc:
<comment>Description:</comment>
  Appelle une méthode statique
  
  Appelle une fonction ou une méthode utilisateur, nommée <strong>$callback</strong>, avec les arguments qui suivent.
  Cette fonction doit être appelée depuis une méthode, et ne peut pas être utilisée hors d'une
  classe. Elle utilise le liage statique.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  La fonction ou la méthode appelée. Ce paramètre peut être un tableau, avec le
                       nom de la classe et de la méthode, ou une chaîne, avec le nom de la fonction.
  <info>mixed</info>     <strong>$args</strong>      Zéro ou plusieurs paramètres à passer à la fonction.

<comment>Return:</comment>
  <info>mixed</info>  Retourne le résultat de la fonction, ou bien <info>false</info> en cas d'erreur.

<comment>See Also:</comment>
   * <strong>forward_static_call_array()</strong>
   * <strong>call_user_func_array()</strong>
   * <strong>call_user_func()</strong>
   * <strong>is_callable()</strong>


id: forward_static_call_array
type: function
doc:
<comment>Description:</comment>
  Appelle une méthode statique et passe les arguments en tableau
  
  Appelle une fonction ou une méthode utilisateur, nommée <strong>$callback</strong>, avec les arguments rassemblés
  dans un tableau. Cette fonction doit être appelée depuis une méthode, et ne peut pas être utilisée
  hors d'une classe. Elle utilise le liage statique. Tous les arguments transmis sont passés par
  valeur dans un tableau, similairement à  <strong>call_user_func_array()</strong>.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>   La fonction ou la méthode appelée. Ce paramètre peut être un tableau, avec
                        le nom de la classe et de la méthode, ou une chaîne, avec le nom de la
                        fonction.
  <info></info>          <strong>$parameter</strong>  Un paramètre, rassemblant tous les paramètres dans un tableau.
                        
                        Notez que les paramètres sont passés par valeur par
                        <strong>forward_static_call_array()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Retourne le résultat de la fonction, et <info>false</info> en cas d'erreur.

<comment>See Also:</comment>
   * <strong>forward_static_call()</strong>
   * <strong>call_user_func()</strong>
   * <strong>call_user_func_array()</strong>
   * <strong>is_callable()</strong>


id: fpassthru
type: function
doc:
<comment>Description:</comment>
  Affiche le reste du fichier
  
  Lit tout le reste d'un fichier jusqu'à la fin et dirige le résultat vers la sortie standard.
  
  Vous devez appeler la fonction <strong>rewind()</strong> pour réinitialiser le pointeur de fichier au début si vous
  avez déjà écrit des données dans le  fichier.
  
  Si vous voulez uniquement copier le contenu d'un fichier dans le buffer de sortie, sans le
  modifier auparavant ou placer le pointeur à un endroit  particulier, vous devriez utiliser la
  fonction <strong>readfile()</strong>, ce  qui vous évite d'appeler la fonction <strong>fopen()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Le pointeur de fichier doit être valide et pointer
                     sur un fichier ouvert avec succès par <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (et pas encore fermé par <strong>fclose()</strong>).

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de caractères lus depuis <strong>$stream</strong> et passés à la sortie standard.

<comment>See Also:</comment>
   * <strong>readfile()</strong>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fsockopen()</strong>


id: fpm_get_status
type: function
doc:
<comment>Description:</comment>
  Retourne l'état actuel du pool FPM
  
  Cette fonction retourne l'état complet du pool de FPM sous la forme d'un tableau associatif. Elle
  retourne toujours l'état complet, y compris les informations d'état par processus. Voir le guide
  de la page d'état FPM pour plus de détails.
  
  Notez que cette fonction ne sera définie que si FPM est utilisé pour servir le script.

<comment>Return:</comment>
  <info>array|false</info>  Tableau associatif contenant l'état complet du pool FPM, ou <info>false</info> si une erreur
               survient.


id: fprintf
type: function
doc:
<comment>Description:</comment>
  Écrit une chaîne formatée dans un flux
  
  Écrit la chaîne produite avec le format <strong>$format</strong> dans le flux représenté par <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Un pointeur de système de fichiers de type ressource
                     qui est habituellement créé en utilisant la fonction <strong>fopen()</strong>.
  <info>string</info>    <strong>$format</strong>  La chaîne de format est composé de zéro ou plusieurs directives : des
                     caractères ordinaires (à l'exception de <return>%</return>) qui sont copiés directement dans le
                     résultat et des spécifications de conversion, chacun ayant pour résultat de
                     récupérer ses propres paramètre.
                     
                     Une spécification de conversion qui suit ce prototype :
                     <return>%[argnum$][flags][width][.precision]specifier</return>.
                     
                     Un entier suivit d'un signe dollar <return>$</return>, pour spécifier quel numéro d'argument à
                     traiter dans la conversion.
                     
                     DrapeauxDrapeauDescription<return>-</return> Justifie le texte à gauche donnée la largeur du
                     champ ; Justification à droite est le comportement par défaut. <return>+</return> Préfixe les
                     nombres positives avec un signe plus <return>+</return> ; Par défaut seul les nombres négatifs
                     sont préfixés avec un signe négatif. <return> </return>(espace) Complète le résultat avec des
                     espaces. Ceci est par défaut. <return>0</return> Complète uniquement les nombres à gauches avec
                     des zéros. Avec le spécificateur <return>s</return> ceci peut aussi compléter à droite avec des
                     zéros. <return>'</return>(char) Complète le résultat avec le caractère (char).
                     
                     Soit un entier indiquant le nombre de caractères (minimum) que cette conversion
                     doit produire, soit <return>*</return>. Si <return>*</return> est utilisé, alors la largeur est fournie en tant
                     que valeur entière supplémentaire précédant celle formatée par le
                     spécificateur.
                     
                     Un point <return>.</return> suivi optionnellement soit d'un entier, soit de <return>*</return>, dont la
                     signification dépend du spécificateur :  Pour les spécificateurs <return>e</return>, <return>E</return>, <return>f</return> et <return>F</return> :
                     ceci est le nombre de chiffres à afficher après la virgule (par défaut, ceci
                     est 6).  Pour les spécificateurs <return>g</return>, <return>G</return>, <return>h</return> et <return>H</return> : ceci est le nombre maximal de
                     chiffres significatifs à afficher. digits to be printed.  Pour le spécificateur
                     <return>s</return> : il agit comme un point de coupure, définissant une limite maximale de
                     caractères de la chaîne.   Si le point est spécifié sans une valeur explicite
                     pour la précision, 0 est assumé. Si <return>*</return> est utilisé, la précision est fournie en
                     tant que valeur entière supplémentaire précédant celle formatée par le
                     spécificateur.
                     
                     Pour les spécificateurs <return>e</return>, <return>E</return>, <return>f</return> et <return>F</return> : ceci est le nombre de chiffres à
                     afficher après la virgule (par défaut, ceci est 6).
                     
                     Pour les spécificateurs <return>g</return>, <return>G</return>, <return>h</return> et <return>H</return> : ceci est le nombre maximal de chiffres
                     significatifs à afficher. digits to be printed.
                     
                     Pour le spécificateur <return>s</return> : il agit comme un point de coupure, définissant une
                     limite maximale de caractères de la chaîne.
                     
                     Si le point est spécifié sans une valeur explicite pour la précision, 0 est
                     assumé. Si <return>*</return> est utilisé, la précision est fournie en tant que valeur entière
                     supplémentaire précédant celle formatée par le spécificateur.
                     
                     SpécificateursSpécificateurDescription<return>%</return> Un caractère de pourcentage littéral.
                     Aucun argument n'est nécessaire. <return>b</return> L'argument est traité comme un entier et
                     présenté comme un nombre binaire. <return>c</return> L'argument est traité comme un entier et
                     présenté comme le caractère de code ASCII correspondant. <return>d</return> L'argument est
                     traité comme un entier et présenté comme un nombre entier décimal (signé). <return>e</return>
                     L'argument est traité comme une notation scientifique (e.g. <return>1.2e+2</return>). <return>E</return> Comme le
                     spécificateur <return>e</return> mais utilise une lettre majuscule (par exemple 1.2E+2). <return>f</return>
                     L'argument est traité comme un nombre à virgule flottante (type nombre décimal)
                     et présenté comme un nombre à virgule flottante (tenant compte de la locale
                     utilisée). <return>F</return> L'argument est traité comme un nombre à virgule flottante (type
                     nombre décimal) et présenté comme un nombre à virgule flottante (ne tenant pas
                     compte de la locale utilisée). <return>g</return> Format général.  Soit P égal à la précision si
                     différent de 0, 6 si la précision est omit ou 1 si la précision est zéro.
                     Alors, si la conversion avec le style E aurait comme exposant X :  Si P &gt; X
                     ≥ −4, la conversion est avec style f et précision P − (X + 1). Sinon, la
                     conversion est avec le style e et précision P - 1. <return>G</return> Comme le spécificateur <return>g</return>
                     mais utilise <return>E</return> et <return>f</return>. <return>h</return> Comme le spécificateur <return>g</return> mais utilise <return>F</return>. Disponible à
                     partir de PHP 8.0.0. <return>H</return> Comme le spécificateur <return>g</return> mais utilise <return>E</return> et <return>F</return>. Disponible
                     à partir de PHP 8.0.0. <return>o</return> L'argument est traité comme un entier et présenté
                     comme un nombre octal. <return>s</return> L'argument est traité et présenté comme une chaîne de
                     caractères. <return>u</return> L'argument est traité comme un entier et présenté comme un nombre
                     décimal non signé. <return>x</return> L'argument est traité comme un entier et présenté comme un
                     nombre hexadécimal (les lettres en minuscules). <return>X</return> L'argument est traité comme
                     un entier et présenté comme un nombre hexadécimal (les lettres en majuscules).
                     
                     Format général.
                     
                     Soit P égal à la précision si différent de 0, 6 si la précision est omit ou 1
                     si la précision est zéro. Alors, si la conversion avec le style E aurait comme
                     exposant X :
                     
                     Si P &gt; X ≥ −4, la conversion est avec style f et précision P − (X + 1).
                     Sinon, la conversion est avec le style e et précision P - 1.
                     
                     Le spécificateur de type <return>c</return> ignore l'alignement et la taille.
                     
                     Le fait de tenter d'utiliser une combinaison d'une chaîne et de spécificateurs
                     avec des jeux de caractères qui nécessitent plus d'un octet par caractères
                     donnera un résultat inattendu.
                     
                     Les variables seront contraints à un type approprié pour le spécificateur :
                     Gestion des typesTypeSpécificateurs<info>string</info><return>s</return><info>int</info><return>d</return>, <return>u</return>, <return>c</return>, <return>o</return>, <return>x</return>, <return>X</return>, <return>b</return><info>float</info><return>e</return>, <return>E</return>, <return>f</return>,
                     <return>F</return>, <return>g</return>, <return>G</return>, <return>h</return>, <return>H</return>
  <info>mixed</info>     <strong>$values</strong>  

<comment>Return:</comment>
  <info>int</info>  Retourne la longueur de la chaîne écrite.

<comment>See Also:</comment>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>
   * <strong>vprintf()</strong>
   * <strong>vsprintf()</strong>
   * <strong>vfprintf()</strong>
   * <strong>sscanf()</strong>
   * <strong>fscanf()</strong>
   * <strong>number_format()</strong>
   * <strong>date()</strong>


id: fputcsv
type: function
doc:
<comment>Description:</comment>
  Formate une ligne en CSV et l'écrit dans un fichier
  
  <strong>fputcsv()</strong> formate la ligne passée sous forme de tableau <strong>$fields</strong>, puis écrit le résultat dans le
  fichier <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>     Le pointeur de fichier doit être valide et pointer
                        sur un fichier ouvert avec succès par <strong>fopen()</strong> ou
                        <strong>fsockopen()</strong> (et pas encore fermé par <strong>fclose()</strong>).
  <info>array</info>     <strong>$fields</strong>     Un tableau de chaînes de caractères <info>string</info>.
  <info>string</info>    <strong>$separator</strong>  Le paramètre optionnel <strong>$separator</strong> spécifie le délimiteur (un caractère d'un
                        seul octet).
  <info>string</info>    <strong>$enclosure</strong>  Le paramètre <strong>$enclosure</strong> spécifie le caractère d'encadrement (un caractère
                        d'un seul octet).
  <info>string</info>    <strong>$escape</strong>     Le paramètre optionnel <strong>$escape</strong> définit le caractère d'échappement (au plus
                        un caractère d'un seul octet). Une chaîne de caractères vide (<return>""</return>) désactive
                        le mécanisme d'échappement propriétaire.
  <info>string</info>    <strong>$eol</strong>        Le paramètre optionnel <strong>$eol</strong> définit une séquence de fin de ligne (End of
                        Line) personnalisé.

<comment>Return:</comment>
  <info>int|false</info>  Retourne la taille de la chaîne écrite  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fgetcsv()</strong>


id: fputs
type: function
doc:
<comment>Description:</comment>
  Alias de fwrite
  
  Cette fonction est un alias de :  <strong>fwrite()</strong>.


id: fread
type: function
doc:
<comment>Description:</comment>
  Lecture du fichier en mode binaire
  
  <strong>fread()</strong> lit jusqu'à <strong>$length</strong> octets dans le fichier référencé par <strong>$stream</strong>. La lecture s'arrête
  lorsqu'une des conditions suivantes apparaît : <strong>$length</strong> octets ont été lus  la fin du fichier est
  atteinte  un paquet devient disponible ou le temps  socket timeout est passé (pour les flux
  réseau)  si le flux est lu depuis le buffer, et qu'il ne représente pas un fichier plein, alors au
  moins une lecture d'un nombre d'octets équivalent à la taille du bloc (habituellement 8192) est
  réalisée ; suivants les données du buffer précédent, la taille des données retournées peut être
  supérieure à la taille du bloc.
  
  <strong>$length</strong> octets ont été lus
  
  la fin du fichier est atteinte
  
  un paquet devient disponible ou le temps  socket timeout est passé (pour les flux réseau)
  
  si le flux est lu depuis le buffer, et qu'il ne représente pas un fichier plein, alors au moins
  une lecture d'un nombre d'octets équivalent à la taille du bloc (habituellement 8192) est réalisée
  ; suivants les données du buffer précédent, la taille des données retournées peut être supérieure
  à la taille du bloc.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Un pointeur de système de fichiers de type ressource
                     qui est habituellement créé en utilisant la fonction <strong>fopen()</strong>.
  <info>int</info>       <strong>$length</strong>  Taille <strong>$length</strong> d'octets à lire.

<comment>Return:</comment>
  <info>string|false</info>  Retourne la chaîne lue,  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fwrite()</strong>
   * <strong>fopen()</strong>
   * <strong>fsockopen()</strong>
   * <strong>popen()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fscanf()</strong>
   * <strong>file()</strong>
   * <strong>fpassthru()</strong>
   * <strong>fseek()</strong>
   * <strong>ftell()</strong>
   * <strong>rewind()</strong>
   * <strong>unpack()</strong>


id: frenchtojd
type: function
doc:
<comment>Description:</comment>
  Convertit une date du calendrier français républicain en nombre
     de jours du calendrier Julien
  
  <strong>frenchtojd()</strong> convertit une date du calendrier français républicain en nombre de jours du
  calendrier Julien.
  
  Ces fonctions convertissent les dates comprises entre l'an 1 et l'an 14 (22 Septembre 1792 à 22
  Septembre 1806 en calendrier grégorien). Cela couvre plus que la durée d'existence de ce
  calendrier.

<comment>Param:</comment>
  <info>int</info>  <strong>$month</strong>  Le mois, sous la forme d'un nombre entre 1 (pour Vendémiaire) à 13 (pour la période
               de 5-6 jours en à la fin de chaque année)
  <info>int</info>  <strong>$day</strong>    Le jour, sous la forme d'un nombre compris entre 1 et 30
  <info>int</info>  <strong>$year</strong>   L'année, sous la forme d'un nombre compris entre 1 et 14

<comment>Return:</comment>
  <info>int</info>  Le jour Julien pour la date fournie du calendrier français républicain, sous la forme d'un
       entier.

<comment>See Also:</comment>
   * <strong>jdtofrench()</strong>
   * <strong>cal_to_jd()</strong>


id: fscanf
type: function
doc:
<comment>Description:</comment>
  Analyse un fichier en fonction d'un format
  
  La fonction <strong>fscanf()</strong> est similaire à la fonction <strong>sscanf()</strong>, sauf qu'elle prend un fichier en
  entrée, représentée par la ressource <strong>$stream</strong> et interprète l'entrée en fonction du format <strong>$format</strong>
  spécifié.
  
  Tous les caractères blancs de la chaîne de formatage correspondent  à autant d'espaces dans le
  flux d'entrée. Cela signifie qu'une tabulation (<return>\t</return>) dans la chaîne de format peut remplacer  un
  espace simple dans le flux d'entrée.
  
  Chaque appel à la fonction <strong>fscanf()</strong> lit une ligne du fichier.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Un pointeur de système de fichiers de type ressource
                     qui est habituellement créé en utilisant la fonction <strong>fopen()</strong>.
  <info>string</info>    <strong>$format</strong>  Le format interprété pour <strong>$string</strong> décrit dans la documentation de la <strong>sprintf()</strong>
                     avec les différences suivantes :  La fonction ne tient pas compte du contexte
                     local. <return>F</return>, <return>g</return>, <return>G</return> et <return>b</return> ne sont pas supportés. <return>D</return> représente un nombre décimal. <return>i</return>
                     représente un nombre entier avec détection de base. <return>n</return> représente le nombre de
                     caractères traités à ce stade. <return>s</return> arrête la lecture à chaque caractère
                     d'espacement. <return>*</return> au lieu de <return>argnum$</return> supprime l'affectation de cette
                     spécification de conversion.
  <info>mixed</info>     <strong>$vars</strong>    Les valeurs optionnelles à assigner.

<comment>Return:</comment>
  <info>array|int|false|null</info>  Si seulement 2 paramètres sont passés à la fonction, la valeur analysée sera
                        retourné sous la forme d'un tableau. Si des paramètres optionnels sont
                        passés, la fonction retournera le nombre de valeurs assignées. Les
                        paramètres optionnels doivent être passés par référence.
                        
                        If there are more substrings expected in the <strong>$format</strong> than there are
                        available within <strong>$string</strong>, <info>null</info> will be returned. On other errors, <info>false</info> will
                        be returned.

<comment>See Also:</comment>
   * <strong>fread()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: fseek
type: function
doc:
<comment>Description:</comment>
  Modifie la position du pointeur de fichier
  
  Modifie le curseur de position dans le fichier <strong>$stream</strong>. La nouvelle position, mesurée en octets, à
  partir du début du fichier, est obtenue en additionnant la distance <strong>$offset</strong> à la position <strong>$whence</strong>.
  
  En général, il est possible de se déplacer au delà de la fin du flux (eof); si des données sont
  écrites dans ce cas, l'espace entre la fin du flux et la position courante sera rempli d'octets
  nuls. Cependant, certains flux ne supportent pas ce comportement, en particulier lorsque l'espace
  de stockage sous-jascent est de taille fixe.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Un pointeur de système de fichiers de type ressource
                     qui est habituellement créé en utilisant la fonction <strong>fopen()</strong>.
  <info>int</info>       <strong>$offset</strong>  La position.
                     
                     Pour se déplacer à une position avant la fin du fichier, vous devez passer une
                     valeur négative à <strong>$offset</strong> et définir le paramètre <strong>$whence</strong> à la valeur <info>SEEK_END</info>.
  <info>int</info>       <strong>$whence</strong>  Les valeurs possibles pour <strong>$whence</strong> sont : <info>SEEK_SET</info> : la position finale vaut
                     <strong>$offset</strong> octets.<info>SEEK_CUR</info> : la position finale sera la position courante, ajoutée
                     à <strong>$offset</strong> octets.<info>SEEK_END</info> : la position finale vaut la position courante par
                     rapport à la fin du fichier, ajoutée de <strong>$offset</strong> octets.

<comment>Return:</comment>
  <info>int</info>  Retourne 0 en cas de succès, et sinon -1.

<comment>See Also:</comment>
   * <strong>ftell()</strong>
   * <strong>rewind()</strong>


id: fsockopen
type: function
doc:
<comment>Description:</comment>
  Ouvre un socket de connexion Internet ou Unix
  
  Initialise une connexion par socket à la ressource spécifiée par <strong>$hostname</strong>.
  
  PHP supporte les cibles dans les domaines Internet et Unix comme décrit dans . Une liste des types
  de transports peut également être trouvée en utilisant la fonction <strong>stream_get_transports()</strong>.
  
  Le socket sera ouvert par défaut en mode bloquant. Vous pouvez changer de mode en utilisant :
  <strong>stream_set_blocking()</strong>.
  
  La fonction <strong>stream_socket_client()</strong> est similaire mais fournit plus d'options, incluant la
  connexion non-bloquante et la possibilité de fournir un contexte de flux.

<comment>Param:</comment>
  <info>string</info>      <strong>$hostname</strong>       Si le support OpenSSL est installé, vous pouvez préfixer <strong>$hostname</strong>
                              avec <return>ssl://</return> ou <return>tls://</return> pour utiliser une connexion cliente SSL ou TLS
                              sur TCP/IP pour vous connectez à l'hôte distant.
  <info>int</info>         <strong>$port</strong>           Le numéro du port. Ce paramètre peut être omis et ignoré en utilisant
                              la valeur <return>-1</return> pour les transports qui n'utilisent pas les ports, comme
                              <return>unix://</return>.
  <info>int</info>         <strong>$error_code</strong>     Si fourni, contient le numéro de l'erreur système qui survient lors de
                              l'appel système à <return>connect()</return>.
                              
                              Si la valeur retournée par <strong>$error_code</strong> est <return>0</return> et que la fonction
                              retourne <info>false</info>, ce peut être une indication laissant penser que
                              l'erreur est survenue avant l'appel à <return>connect()</return>. La plupart du temps,
                              cela est du à un problème d'initialisation du socket.
  <info>string</info>      <strong>$error_message</strong>  Le message d'erreur, sous la forme d'une chaîne de caractères.
  <info>float|null</info>  <strong>$timeout</strong>        Le délai d'attente maximal, en secondes. Si <info>null</info> le paramètre php.ini
                              default_socket_timeout est utilisé.
                              
                              Si vous avez besoin de définir un délai limite pour lire/écrire des
                              données à travers ce socket, utilisez la fonction
                              <strong>stream_set_timeout()</strong>, car le paramètre <strong>$timeout</strong> de la fonction
                              <strong>fsockopen()</strong> est uniquement appliqué lors de la connexion du socket.

<comment>Return:</comment>
  <info>resource|false</info>  <strong>fsockopen()</strong> retourne un pointeur de fichier qui peut être utilisé avec d'autres
                  fonctions fichiers, telles <strong>fgets()</strong>, <strong>fgetss()</strong>, <strong>fputs()</strong>, <strong>fclose()</strong> et <strong>feof()</strong>. Si
                  l'appel échoue, la fonction retourne <info>false</info>.

<comment>See Also:</comment>
   * <strong>pfsockopen()</strong>
   * <strong>stream_socket_client()</strong>
   * <strong>stream_set_blocking()</strong>
   * <strong>stream_set_timeout()</strong>
   * <strong>fgets()</strong>
   * <strong>fgetss()</strong>
   * <strong>fwrite()</strong>
   * <strong>fclose()</strong>
   * <strong>feof()</strong>
   * <strong>socket_connect()</strong>
   * L'extension Curl


id: fstat
type: function
doc:
<comment>Description:</comment>
  Lit les informations sur un fichier à partir d'un pointeur de fichier
  
  Rassemble les informations sur le fichier dont on connaît le pointeur <strong>$stream</strong>. <strong>fstat()</strong> est
  similaire à la fonction <strong>stat()</strong>, hormis le fait qu'elle utilise un pointeur de fichier, au lieu
  d'un nom de fichier.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Un pointeur de système de fichiers de type ressource
                     qui est habituellement créé en utilisant la fonction <strong>fopen()</strong>.

<comment>Return:</comment>
  <info>array|false</info>  Retourne un tableau contenant les statistiques pour le fichier ; le format de ce
               tableau est décrit en détail sur la page de documentation de la fonction <strong>stat()</strong>.
               Retourne <info>false</info> en cas d'échec.


id: fsync
type: function
doc:
<comment>Description:</comment>
  Synchronise les modifications apportées au fichier (y compris les métadonnées)
  
  Cette fonction synchronise les modifications apportées au fichier, y compris ses métadonnées.
  Celle-ci est similaire à <strong>fflush()</strong>, mais elle demande également au système d'exploitation d'écrire
  sur le support de stockage.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Le pointeur de fichier doit être valide et pointer
                     sur un fichier ouvert avec succès par <strong>fopen()</strong> ou
                     <strong>fsockopen()</strong> (et pas encore fermé par <strong>fclose()</strong>).

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fdatasync()</strong>
   * <strong>fflush()</strong>


id: ftell
type: function
doc:
<comment>Description:</comment>
  Renvoie la position courante du pointeur de fichier
  
  Renvoie la position courante du pointeur de fichier référencé par <strong>$stream</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  Le pointeur de fichier doit être valide, et avoir été correctement ouvert par
                     <strong>fopen()</strong> ou <strong>popen()</strong>. <strong>ftell()</strong> donne des résultats non définis pour les flux
                     "<return>append-only</return>" (ouvert avec le flag "a").

<comment>Return:</comment>
  <info>int|false</info>  Retourne la position courante du pointeur dans le fichier repéré par le pointeur
             <strong>$stream</strong> sous la forme d'un entier, i.e., sa position dans le flux du fichier.
             
             Si une erreur survient, la fonction retournera <info>false</info>.
             
             Comme le type entier de PHP est signé et que de nombreuses plates-formes utilisent des
             entiers de 32 bits, certaines fonctions relatives au système de fichiers peuvent
             retourner des résultats étranges pour les fichiers de taille supérieure à 2 Go.

<comment>See Also:</comment>
   * <strong>fopen()</strong>
   * <strong>popen()</strong>
   * <strong>fseek()</strong>
   * <strong>rewind()</strong>


id: ftok
type: function
doc:
<comment>Description:</comment>
  Convertit un chemin et un identifiant de projet en une clé System V IPC
  
  Convertit le paramètre <strong>$filename</strong> d'un fichier existant, et de l'identifiant de projet  <strong>$proj</strong>, en
  un entier <return>integer</return> à utiliser avec la fonction <strong>shmop_open()</strong> et d'autres fonctions System V IPC.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>    Chemin vers un fichier accessible.
  <info>string</info>  <strong>$project_id</strong>  Identifiant du projet. Doit être un seul caractère.

<comment>Return:</comment>
  <info>int</info>  En cas de succès, la valeur retournée sera la valeur de la clé créée, sinon, <return>-1</return> sera
       retourné.

<comment>See Also:</comment>
   * <strong>shmop_open()</strong>
   * <strong>sem_get()</strong>


id: ftp_alloc
type: function
doc:
<comment>Description:</comment>
  Alloue de l'espace pour un téléchargement de fichier
  
  <strong>ftp_alloc()</strong> envoie la commande FTP <return>ALLO</return> pour allouer un espace sur le serveur FTP de <strong>$filesize</strong>
  octets.
  
  De nombreux serveur FTP ne supportent pas cette commande. Ces serveurs peuvent retourner un code
  d'erreur (<info>false</info>) qui indique que la commande n'est pas supportée, ou (<info>true</info>) pour dire que la
  préallocation n'est pas nécessaire : le client continue alors ses  opérations de la même façon. À
  cause de cela, il est préférable de n'utiliser cette fonction qu'avec les serveurs qui requièrent
  spécifiquement cette fonction.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>       Une instance de <class>FTP\Connection</class>.
  <info>int</info>             <strong>$size</strong>      Le nombre d'octets à allouer.
  <info>string</info>          <strong>$response</strong>  Une représentation textuelle de la réponse du serveur qui sera
                             retournée par référence dans <strong>$response</strong> si une variable est fournie.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>ftp_put()</strong>
   * <strong>ftp_fput()</strong>


id: ftp_append
type: function
doc:
<comment>Description:</comment>
  Ajoute le contenu d'un fichier à un autre fichier sur le serveur FTP
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              Une instance de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$remote_filename</strong>  
  <info>string</info>          <strong>$local_filename</strong>   
  <info>int</info>             <strong>$mode</strong>             

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: ftp_cdup
type: function
doc:
<comment>Description:</comment>
  Change de dossier et passe au dossier parent
  
  <strong>ftp_cdup()</strong> change de dossier et passe au dossier parent.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>  Une instance de <class>FTP\Connection</class>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>ftp_chdir()</strong>
   * <strong>ftp_pwd()</strong>


id: ftp_chdir
type: function
doc:
<comment>Description:</comment>
  Modifie le dossier FTP courant
  
  <strong>ftp_chdir()</strong> modifie le dossier courant en <strong>$directory</strong>.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>        Une instance de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$directory</strong>  Le dossier cible.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient. Si le
        changement échoue, PHP lancera également une alerte.

<comment>See Also:</comment>
   * <strong>ftp_cdup()</strong>
   * <strong>ftp_pwd()</strong>


id: ftp_chmod
type: function
doc:
<comment>Description:</comment>
  Modifie les droits d'un fichier via FTP
  
  <strong>ftp_chmod()</strong> modifie les droits d'accès au fichier <strong>$filename</strong> sur le serveur FTP  <strong>$ftp</strong>, en lui
  attribuant les droits de <strong>$permissions</strong>, spécifié sous la forme d'un entier en base octale.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>          Une instance de <class>FTP\Connection</class>.
  <info>int</info>             <strong>$permissions</strong>  La nouvelle permission, donnée en tant que valeur octale.
  <info>string</info>          <strong>$filename</strong>     Le fichier distant.

<comment>Return:</comment>
  <info>int|false</info>  Retourne les nouvelles permissions du fichier en cas de succès, ou <info>false</info> si une erreur
             survient.

<comment>See Also:</comment>
   * <strong>chmod()</strong>


id: ftp_close
type: function
doc:
<comment>Description:</comment>
  Ferme une connexion FTP
  
  <strong>ftp_close()</strong> ferme la connexion  <strong>$ftp</strong> et libère les ressources.
  
  Après avoir appelé cette fonction, vous ne pouvez plus utiliser l'ancienne connexion, et vous
  devez en ouvrir une nouvelle avec <strong>ftp_connect()</strong>.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>  Une instance de <class>FTP\Connection</class>.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>ftp_connect()</strong>


id: ftp_connect
type: function
doc:
<comment>Description:</comment>
  Ouvre une connexion FTP
  
  <strong>ftp_connect()</strong> ouvre une connexion FTP avec l'hôte <strong>$hostname</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$hostname</strong>  L'adresse du serveur FTP. Ce paramètre ne doit jamais avoir de slash final et
                     ne doit pas être préfixé par <return>ftp://</return>.
  <info>int</info>     <strong>$port</strong>      Ce paramètre spécifie un numéro de port alternatif pour la connexion. S'il est
                     omis ou définie à zéro, alors le port FTP par défaut, 21, sera utilisé.
  <info>int</info>     <strong>$timeout</strong>   Ce paramètre spécifie le délai de connexion en secondes pour toutes les
                     opérations ultérieures en réseau. S'il est omis, la valeur par défaut sera 90
                     secondes. Le délai de connexion peut être modifié et interrogé à n'importe quel
                     moment avec les fonctions <strong>ftp_set_option()</strong> et <strong>ftp_get_option()</strong>.

<comment>Return:</comment>
  <info>FTP\Connection|false</info>  Retourne une instance de <class>FTP\Connection</class> en cas de succès, ou <info>false</info> si une
                        erreur survient.

<comment>See Also:</comment>
   * <strong>ftp_close()</strong>
   * <strong>ftp_ssl_connect()</strong>


id: ftp_delete
type: function
doc:
<comment>Description:</comment>
  Efface un fichier sur un serveur FTP
  
  <strong>ftp_delete()</strong> efface le fichier <strong>$filename</strong> sur un serveur FTP.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>       Une instance de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$filename</strong>  Le fichier à effacer.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.


id: ftp_exec
type: function
doc:
<comment>Description:</comment>
  Exécute une commande sur un serveur FTP
  
  <strong>ftp_exec()</strong> envoie une commande SITE EXEC au serveur FTP, pour qu'il exécute le programme <strong>$command</strong>.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>      Une instance de <class>FTP\Connection</class>.
  <info>string</info>          <strong>$command</strong>  La commande à exécuter.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la commande a été exécutée avec succès (le serveur envoie le code réponse :
        <return>200</return>); sinon, retourne <info>false</info>.

<comment>See Also:</comment>
   * <strong>ftp_raw()</strong>


id: ftp_fget
type: function
doc:
<comment>Description:</comment>
  Télécharge un fichier via FTP dans un fichier local
  
  <strong>ftp_fget()</strong> télécharge le fichier <strong>$remote_filename</strong> depuis le serveur FTP et l'écrit dans le fichier
  identifié par <strong>$stream</strong>.

<comment>Param:</comment>
  <info>FTP\Connection</info>  <strong>$ftp</strong>              Une instance de <class>FTP\Connection</class>.
  <info>resource</info>        <strong>$stream</strong>           Un pointeur de fichier ouvert dans lequel on écrit les données.
  <info>string</info>          <strong>$remote_filename</strong>  Le chemin vers le fichier distant.
  <info>int</info>             <strong>$mode</strong>             Le mode de transfert. Doit être soit <info>FTP_ASCII</info>, soit <info>FTP_BINARY</info>.
  <info>int</info>             <strong>$offset</strong>           La position du fichier distant à partir de laquelle le
                                    téléchargement commence.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>ftp_get()</strong>
   * <strong>ftp_nb_get()</strong>
   * <strong>ftp_nb_fget()</strong>


