# php_manual

id: preg_replace_callback_array
type: function
doc:
<comment>Description:</comment>
  Éffectue une recherche de correspondance avec une expression régulière et remplace grâce à une
  fonction de rappel
  
  Le comportement de cette fonction est similaire à <strong>preg_replace_callback()</strong>, à l'exception que les
  fonctions de rappel sont exécutéees à chaque masque.

<comment>Param:</comment>
  <info>array</info>         <strong>$pattern</strong>  Un tableau associatif qui établie une relation entre les masques (clés)
                          et les fonctions de rappels <info>callable</info> (valeurs).
  <info>string|array</info>  <strong>$subject</strong>  La chaîne de caractères ou tableau qui contient les chaîne de caractères à
                          chercher et remplacer.
  <info>int</info>           <strong>$limit</strong>    Le nombre maximum de remplacement pour chaque masque dans chaque chaîne de
                          caractères <strong>$subject</strong>. Par défaut <return>-1</return> (aucune limite).
  <info>int</info>           <strong>$count</strong>    Si fournit, cette variable sera remplit avec le nombre de remplacement
                          effectué.
  <info>int</info>           <strong>$flags</strong>    <strong>$flags</strong> peut être une combinaison des drapeaux <info>PREG_OFFSET_CAPTURE</info> et
                          <info>PREG_UNMATCHED_AS_NULL</info>, qui influence le format du tableau de
                          correspondances. Voir la description de <strong>preg_match()</strong> pour plus de détail.

<comment>Return:</comment>
  <info>string|array|null</info>  <strong>preg_replace_callback_array()</strong> retourne un tableau si le paramètre <strong>$subject</strong> est
                     un tableau, ou sinon une chaîne de caractères. Lors d'une erreur la valeur de
                     retour est <info>null</info>.
                     
                     Si des correspondances sont trouvées, le nouveau sujet sera retourné, sinon
                     <strong>$subject</strong> sera retourné inchangé.

<comment>See Also:</comment>
   * Masques PCRE
   * <strong>preg_replace_callback()</strong>
   * <strong>preg_quote()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>
   * Anonymous functions


id: preg_split
type: function
doc:
<comment>Description:</comment>
  Éclate une chaîne par expression rationnelle
  
  Éclate une chaîne par expression rationnelle.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Le masque à chercher, sous la forme d'une chaîne de caractères.
  <info>string</info>  <strong>$subject</strong>  La chaîne d'entrée.
  <info>int</info>     <strong>$limit</strong>    Si <strong>$limit</strong> est spécifié, alors seules les <strong>$limit</strong> premières sous-chaînes sont
                    retournées avec le reste de la chaîne placé dans la dernière sous-chaîne. Une
                    <strong>$limit</strong> de -1 ou 0 signifie "aucune limite".
  <info>int</info>     <strong>$flags</strong>    <strong>$flags</strong> peut être la combinaison des options suivantes (combinées avec
                    l'opérateur <return>|</return>): <info>PREG_SPLIT_NO_EMPTY</info> Si cette option est activée, seules les
                    sous-chaînes non vides seront retournées par <strong>preg_split()</strong>.
                    <info>PREG_SPLIT_DELIM_CAPTURE</info> Si cette option est activée, les expressions entre
                    parenthèses entre les délimiteurs de masques seront aussi capturées et
                    retournées. <info>PREG_SPLIT_OFFSET_CAPTURE</info> Si cette option est activée, pour chaque
                    résultat, la position de celui-ci sera retournée. Notez que cela change la
                    valeur retournée en un tableau où chaque élément est un tableau constitué de la
                    chaîne trouvée à la position <return>0</return> et la position de la chaîne dans <strong>$subject</strong> à la
                    position <return>1</return>.
                    
                    Si cette option est activée, seules les sous-chaînes non vides seront retournées
                    par <strong>preg_split()</strong>.
                    
                    Si cette option est activée, les expressions entre parenthèses entre les
                    délimiteurs de masques seront aussi capturées et retournées.
                    
                    Si cette option est activée, pour chaque résultat, la position de celui-ci sera
                    retournée. Notez que cela change la valeur retournée en un tableau où chaque
                    élément est un tableau constitué de la chaîne trouvée à la position <return>0</return> et la
                    position de la chaîne dans <strong>$subject</strong> à la position <return>1</return>.
  <info>string</info>  <strong>$subject</strong>  Si cette option est activée, pour chaque résultat, la position de celui-ci sera
                    retournée. Notez que cela change la valeur retournée en un tableau où chaque
                    élément est un tableau constitué de la chaîne trouvée à la position <return>0</return> et la
                    position de la chaîne dans <strong>$subject</strong> à la position <return>1</return>.

<comment>Return:</comment>
  <info>array|false</info>  Retourne un tableau contenant les sous-chaînes de <strong>$subject</strong>, séparées par les chaînes
               qui vérifient <strong>$pattern</strong>,  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * Masques PCRE
   * <strong>preg_quote()</strong>
   * <strong>implode()</strong>
   * <strong>preg_match()</strong>
   * <strong>preg_match_all()</strong>
   * <strong>preg_replace()</strong>
   * <strong>preg_last_error()</strong>


id: prev
type: function
doc:
<comment>Description:</comment>
  Recule le pointeur courant de tableau
  
  Recule le pointeur courant de tableau.
  
  <strong>prev()</strong> se comporte exactement comme <strong>next()</strong>, mais elle fait reculer le pointeur plutôt que de
  l'avancer.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  Le tableau d'entrée.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur précédente du tableau suivant le pointeur interne du tableau, ou <info>false</info>
         s'il n'y a plus d'élément.
         
         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>current()</strong>
   * <strong>end()</strong>
   * <strong>next()</strong>
   * <strong>reset()</strong>
   * <strong>each()</strong>


id: print
type: function
doc:
<comment>Description:</comment>
  Affiche une chaîne de caractères
  
  Affiche <strong>$expression</strong>.
  
  <return>print</return> n'est pas une fonction mais une construction du langage. Son argument est l'expression
  suivant le mot clé <return>print</return>, et n'est pas délimité par des parenthèses.
  
  La différence majeure avec <return>echo</return> est que <return>print</return> n'accepte qu'un seul argument et retourne toujours
  1.

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  L'expression à afficher. Les valeurs qui ne sont pas des chaînes de
                       caractères seront converties en celle-ci, même si la directive <return>strict_types</return>
                       est activé.

<comment>Return:</comment>
  <info>int</info>  Retourne <return>1</return>, toujours.

<comment>See Also:</comment>
   * <strong>echo()</strong>
   * <strong>printf()</strong>
   * <strong>flush()</strong>
   * Manière de spécifié des chaînes littérales


id: print_r
type: function
doc:
<comment>Description:</comment>
  Affiche des informations lisibles pour une variable
  
  <strong>print_r()</strong> affiche des informations à propos d'une variable, de manière à ce qu'elle soit lisible.
  
  <strong>print_r()</strong>, <strong>var_dump()</strong> et <strong>var_export()</strong> affiche également les propriétés protégées et privées d'un
  objet. Les membres des classes statiques ne seront pas affichés.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>   L'expression à afficher.
  <info>bool</info>   <strong>$return</strong>  Si vous voulez obtenir le résultat de <strong>print_r()</strong> dans une chaîne, utilisez le
                  paramètre <strong>$return</strong>. Lorsque ce paramètre vaut <info>true</info>, <strong>print_r()</strong> retournera
                  l'information plutôt que de l'afficher.

<comment>Return:</comment>
  <info>string|bool</info>  Si une chaîne de caractères, un entier ou un nombre décimal est fournie, sa valeur
               sera affichée. Si un tableau est fourni, les valeurs seront affichées dans un format
               permettant de voir les clés et les éléments. Un format similaire sera également
               utilisé pour les objets.
               
               Lorsque le paramètre <strong>$return</strong> vaut <info>true</info>, cette fonction retournera une chaîne de
               caractères. Autrement, la valeur de retour sera <info>true</info>.

<comment>See Also:</comment>
   * <strong>ob_start()</strong>
   * <strong>var_dump()</strong>
   * <strong>var_export()</strong>


id: printf
type: function
doc:
<comment>Description:</comment>
  Affiche une chaîne de caractères formatée
  
  Affiche une chaîne de caractères formatée.

<comment>Param:</comment>
  <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 taille de la chaîne affichée.

<comment>See Also:</comment>
   * <strong>print()</strong>
   * <strong>sprintf()</strong>
   * <strong>fprintf()</strong>
   * <strong>vprintf()</strong>
   * <strong>vsprintf()</strong>
   * <strong>vfprintf()</strong>
   * <strong>sscanf()</strong>
   * <strong>fscanf()</strong>
   * <strong>number_format()</strong>
   * <strong>date()</strong>
   * <strong>flush()</strong>


id: proc_close
type: function
doc:
<comment>Description:</comment>
  Ferme un processus ouvert par proc_open
    
  
  <strong>proc_close()</strong> est similaire à <strong>pclose()</strong> hormis le fait qu'elle fonctionne avec les processus ouverts
  par  <strong>proc_open()</strong>. <strong>proc_close()</strong> attend que le processus  <strong>$process</strong> se termine, puis retourne son
  code de sortie. Les pipes ouverts avec ce processus sont fermés quand cette fonction est appellée
  pour éviter des verrouillages : le processus peut ne pas pouvoir sortir tant que les pipes sont
  ouverts.

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  La <info>resource</info> <strong>proc_open()</strong> à fermer

<comment>Return:</comment>
  <info>int</info>  Retourne le code de sortie du processus ou <return>-1</return> en cas d'echec.
       
       Si PHP a été compilé avec l'option de configuration --enable-sigchild, la valeur retournée de
       cette fonction sera indéfinie.


id: proc_get_status
type: function
doc:
<comment>Description:</comment>
  Lit les informations concernant un processus ouvert par proc_open
    
  
  <strong>proc_get_status()</strong> lit les données concernant le processus <strong>$process</strong> créé avec la fonction
  <strong>proc_open()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  La ressource <strong>proc_open()</strong> à évaluer.

<comment>Return:</comment>
  <info>array</info>  Un tableau contenant les informations collectées. Le tableau retourné contient les éléments
         suivants :
         
         ÉlémentTypeDescriptioncommandchaîne de caractères La commande passée à la fonction
         <strong>proc_open()</strong>. pidentieridentifiant du processusrunningbooléen<info>true</info> si le processus fonctionne
         toujours et  <info>false</info> s'il est terminé. signaledbooléen<info>true</info> si le processus fils a été terminé
         par un signal inconnu. Toujours défini à <info>false</info> sous Windows. stoppedbooléen<info>true</info> si le
         processus fils a été stoppé par un signal. Toujours défini à <info>false</info> sous Windows.
         exitcodeentier Le code retourné par le processus (uniquement si l'élément <return>running</return> vaut
         <info>false</info>). Seul le premier appel à cette fonction retourne une valeur réelle, les prochains
         appels retournent <return>-1</return>. termsigentier le numéro du signal qui a causé la fin de l'exécution
         du processus fils (uniquement significatif si <return>signaled</return> vaut <info>true</info>). stopsigentier le numéro
         du signal qui a causé l'arrêt de l'exécution du processus fils (uniquement significatif si
         <return>signaled</return> vaut <info>true</info>).

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


id: proc_nice
type: function
doc:
<comment>Description:</comment>
  Change la priorité d'exécution du processus courant
  
  <strong>proc_nice()</strong> modifie la priorité du processus courant par  le paramètre spécifié <strong>$priority</strong>. Un
  paramètre <strong>$priority</strong> positif atténuera la priorité du processus courant, tandis qu'une valeur
  négative  <strong>$priority</strong> augmentera la priorité.
  
  <strong>proc_nice()</strong> n'est pas lié à <strong>proc_open()</strong> et ses fonctions associées d'aucune façon.

<comment>Param:</comment>
  <info>int</info>  <strong>$priority</strong>  La nouvelle valeur de priorité, la valeur de ceci peut différer sur des
                  plates-formes.
                  
                  Sur Unix, une valeur faible, telle que <return>-20</return> indique une priorité élevée alors
                  qu'une valeur positive ont une priorité basse.
                  
                  Pour Windows le paramètre <strong>$priority</strong> a les significations suivantes :

<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 une erreur
        survient, par exemple, si l'utilisateur qui tente de changer la priorité d'un processus n'a
        pas suffisamment de droit pour le faire, une erreur de niveau  <info>E_WARNING</info> est générée et
        <info>false</info> est retourné.

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


id: proc_open
type: function
doc:
<comment>Description:</comment>
  Exécute une commande et ouvre les pointeurs de fichiers pour les entrées / sorties
    
  
  <strong>proc_open()</strong> est similaire à <strong>popen()</strong> mais fournit un plus grand degré de contrôle sur l'exécution
  du programme.

<comment>Param:</comment>
  <info>array|string</info>  <strong>$command</strong>          La commande à exécuter en tant que chaîne de caractères. Les
                                  caractères spéciaux doivent être échappé correctement, et une
                                  application correcte des guillemets doit être appliqué.
                                  
                                  Sur Windows, sauf si <return>bypass_shell</return> est définie à <info>true</info> dans
                                  <strong>$options</strong>, <strong>$command</strong> est passé à cmd.exe (en fait, <return>%ComSpec%</return>) avec
                                  le drapeau <return>/c</return> est une chaîne de caractères sans guillemets (c.à.d.
                                  exactement comment elle a été fournie à <strong>proc_open()</strong>). Ceci peut
                                  causer cmd.exe à supprimer les guillemets entourant de <strong>$command</strong>
                                  (pour plus de détails voir la documentation de cmd.exe),
                                  résulatant dans du comportement innatendu, et potentiellement
                                  dangereux, car les messages d'erreurs de cmd.exe peuvent contenir
                                  (une partir de) la <strong>$command</strong> passé (voir exemple ci-dessous).
                                  
                                  À partir de PHP 7.4.0, <strong>$command</strong> peut être passé comme un tableau
                                  de paramètres de commandes. Dans ce cas le processus sera ouvert
                                  directement (sans passer à travers un shell) et PHP se chargera
                                  d'échapper les arguments nécessaire.
                                  
                                  Sur Windows, l'échappement des arguments des éléments du tableau
                                  assume que le traitement de la ligne de commande de la commande
                                  exécuté est compatible avec le traitement d'arguments de ligne de
                                  commande fait par le runtime VC.
  <info>array</info>         <strong>$descriptor_spec</strong>  Un tableau indexé, dont les clés représentent le numéro de
                                  descripteur  et la valeur la méthode avec laquelle PHP va passer
                                  ce descripteur au  processus fils. 0 est stdin, 1 est stdout, et 2
                                  est stderr.
                                  
                                  Chaque élément peut être :  Un tableau décrivant le pipe à passer
                                  au processus. Le premier élément est le type du descripteur et le
                                  second est une option pour le type donné. Les types valides sont
                                  <return>pipe</return> (le second élément est soit <return>r</return> pour passer la fin de lecture
                                  du pipe au processus, ou <return>w</return> pour passer la fin d'écriture) et <return>file</return>
                                  (le second élément est le nom de fichier). À noter que tout autre
                                  élément différent de <return>w</return> est traité comme <return>r</return>.  Une ressource de flux
                                  représentant un descripteur de fichier (e.g. un fichier ouvert, un
                                  socket, ou bien <info>STDIN</info>).
                                  
                                  Les numéros de pointeurs de fichiers ne sont pas limités à 0, 1 et
                                  2 - vous pouvez spécifier n'importe quel numéro de descripteur
                                  valide, et il sera passé au processus fils. Cela permettra à votre
                                  script d'inter opérer avec d'autres scripts, et d'être exécuté
                                  comme "co-processus". En particulier, c'est très pratique pour
                                  passer des mots de passes à des programmes comme PGP, GPG et
                                  openssl, avec une méthode très protégée. C'est aussi pratique pour
                                  lire des informations de statut fournies par ces programmes, sur
                                  des descripteurs auxiliaires.
  <info>array</info>         <strong>$pipes</strong>            Doit être défini en un tableau indexé de pointeurs de fichiers qui
                                  correspondent à la fin de n'importe quel descripteur PHP qui sont
                                  créés.
  <info>string|null</info>   <strong>$cwd</strong>              Le dossier initial de travail de la commande. Cela doit être un
                                  chemin absolu vers le dossier ou <info>null</info> si vous voulez utiliser la
                                  valeur par défaut (le dossier de travail du processus courant PHP)
  <info>array|null</info>    <strong>$env_vars</strong>         Un tableau contenant les variables d'environnement pour la
                                  commande qui doit être exécutée, ou <info>null</info> pour utiliser le même
                                  environnement que le processus PHP courant
  <info>array|null</info>    <strong>$options</strong>          Vous permet de spécifier des options supplémentaires. Les options
                                  actuellement supportées sont : <return>suppress_errors</return> (windows
                                  uniquement): suppression des erreurs générées par cette fonction
                                  lorsque définit à <info>true</info> <return>bypass_shell</return> (windows uniquement): bypass
                                  du shell <return>cmd.exe</return> lorsque définit à <info>true</info> <return>blocking_pipes</return> (windows
                                  uniquement): force les tubes bloquand lorsque définit à <info>true</info>
                                  <return>create_process_group</return> (windows uniquement) : permet au processus
                                  enfant de gérer les évènement <return>CTRL</return>   lorsqu'il est à <info>true</info>
                                  <return>create_new_console</return> (windows uniquement) : le nouvel processus à
                                  une nouvelle console, au lieu d'hériter la console de son parent.

<comment>Return:</comment>
  <info>resource|false</info>  Retourne une ressource représentant le processus, qui pourra être utilisé par  la
                  fonction <strong>proc_close()</strong> lorsque vous n'en aurez plus besoin. En cas d'échec, <info>false</info>
                  sera retourné.

<comment>See Also:</comment>
   * <strong>popen()</strong>
   * <strong>exec()</strong>
   * <strong>system()</strong>
   * <strong>passthru()</strong>
   * <strong>stream_select()</strong>
   * Les guillemets obliques


id: proc_terminate
type: function
doc:
<comment>Description:</comment>
  Termine un processus ouvert par proc_open
    
  
  <strong>proc_terminate()</strong> envoie un signal au processus  <strong>$process</strong> (créé avec <strong>proc_open()</strong>)  pour lui
  indiquer qu'il doit se terminer. <strong>proc_terminate()</strong>  se termine immédiatement après, et n'attend pas
  l'arrêt réel du processus.
  
  <strong>proc_terminate()</strong> vous permet de conclure un processus, et de continuer les autres tâches. Vous
  pouvez tester la présence de  votre processus en utilisant la fonction <strong>proc_get_status()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$process</strong>  La ressource <strong>proc_open()</strong> qui sera fermée.
  <info>int</info>       <strong>$signal</strong>   Ce paramètre optionnel n'est utile que sur les plates-formes POSIX : vous
                      pouvez alors spécifier un signal à envoyer au processus, en utilisant l'appel
                      système  <return>kill(2)</return>. La valeur par défaut est alors  <return>SIGTERM</return>.

<comment>Return:</comment>
  <info>bool</info>  Retourne le code de sortie du processus.

<comment>See Also:</comment>
   * <strong>proc_open()</strong>
   * <strong>proc_close()</strong>
   * <strong>proc_get_status()</strong>


id: property_exists
type: function
doc:
<comment>Description:</comment>
  Vérifie si un objet ou une classe possède une propriété
    
  
  Cette fonction vérifie si la propriété <strong>$property</strong>  existe dans la classe spécifiée.
  
  <strong>property_exists()</strong> retourne <info>true</info> même si la propriété a une valeur <info>null</info>,  contrairement à la
  fonction <strong>isset()</strong>.

<comment>Param:</comment>
  <info>object|string</info>  <strong>$object_or_class</strong>  Le nom de la classe ou un objet de la classe à tester
  <info>string</info>         <strong>$property</strong>         Le nom de la propriété

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la propriété existe, <info>false</info> si elle n'existe pas et <info>null</info> si une erreur
        survient.

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


id: ps_add_bookmark
type: function
doc:
<comment>Description:</comment>
  Ajoute un signet à la page courante
  
  Ajoute un signet pour la page courante. Les signets apparaissent normalement dans les lecteurs PDF
  sur la gauche de la page dans un arbre hiérarchique. Cliquer sur un signet sautera à la page
  donnée.
  
  La note ne sera pas visible si le document est imprimé ou
  affiché, mais elle sera visible si le document est converti en PDF, soit par
  Acrobat Distiller™, soit par Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>    Le texte utilisé pour afficher le signet.
  <info>int</info>       <strong>$parent</strong>  Un signet précédemment créé par cette fonction qui est utilisé comme parent du
                     nouveau signet.
  <info>int</info>       <strong>$open</strong>    Si <strong>$open</strong> n'est pas égal à zéro, le signet sera montré ouvert dans le lecteur
                     PDF.

<comment>Return:</comment>
  <info>int</info>  La valeur retournée est une référence pour le signet. Cela est utilisé seulement si le signet
       doit être utilisé en tant que parent. La valeur est supérieure à zéro si la fonction réussit.
       En cas d'erreur, <return>0</return> sera retourné.

<comment>See Also:</comment>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_launchlink
type: function
doc:
<comment>Description:</comment>
  Ajoute un lien qui démarre un fichier
  
  <strong>ps_add_launchlink()</strong> place un hyperlien à la position donnée pointant vers un programme qui sera
  démarré lors du clic sur celui-ci.  La position source de l'hyperlien est un rectangle avec son
  coin inférieur gauche à (<strong>$llx</strong>, <strong>$lly</strong>) et son coin haut droit à (<strong>$urx</strong>, <strong>$ury</strong>). Le rectangle a par
  défaut une mince bordure bleue.
  
  La note ne sera pas visible si le document est imprimé ou
  affiché, mais elle sera visible si le document est converti en PDF, soit par
  Acrobat Distiller™, soit par Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>       La position x du coin inférieur gauche.
  <info>float</info>     <strong>$lly</strong>       La position y du coin inférieur gauche.
  <info>float</info>     <strong>$urx</strong>       La position x du coin supérieur droit.
  <info>float</info>     <strong>$ury</strong>       La position y du coin supérieur droit.
  <info>string</info>    <strong>$filename</strong>  Le chemin où le programme sera démarré, lorsque le lien sera cliqué.

<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>ps_add_locallink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_locallink
type: function
doc:
<comment>Description:</comment>
  Ajoute un lien à une page dans le même document
  
  <strong>ps_add_locallink()</strong> place un hyperlien à une position donnée pointant à une page dans le même
  document. Cliquer sur le lien  sautera à la page donnée. La première page dans un document a le
  numéro 1.
  
  La position source de l'hyperlien est un rectangle avec son coin inférieur gauche à (<strong>$llx</strong>, <strong>$lly</strong>)
  et son coin supérieur droit à (<strong>$urx</strong>, <strong>$lly</strong>). Le rectangle a par défaut une mince bordure bleue.
  
  La note ne sera pas visible si le document est imprimé ou
  affiché, mais elle sera visible si le document est converti en PDF, soit par
  Acrobat Distiller™, soit par Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>    La position x du coin inférieur gauche.
  <info>float</info>     <strong>$lly</strong>    La position y du coin inférieur gauche.
  <info>float</info>     <strong>$urx</strong>    La position x du coin supérieur droit.
  <info>float</info>     <strong>$ury</strong>    La position y du coin supérieur droit.
  <info>int</info>       <strong>$page</strong>   Le nombre de page affichée lors du clic sur le lien.
  <info>string</info>    <strong>$dest</strong>   Le paramètre <strong>$dest</strong> détermine comment le document sera vu. Il peut être <return>fitpage</return>,
                    <return>fitwidth</return>, <return>fitheight</return> ou <return>fitbbox</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>ps_add_launchlink()</strong>
   * <strong>ps_add_pdflink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_note
type: function
doc:
<comment>Description:</comment>
  Ajoute une note à la page courante
  
  <strong>ps_add_note()</strong> ajoute une note à une certaine position sur  la page. Les notes sont comme de
  petites feuilles rectangulaires avec du texte par dessus, qui peuvent être placées n'importe où
  sur une page. Elles sont affichées, soit pliées ou dépliées. Si elles sont pliées, l'icône
  spécifiée est utilisée comme un marqueur.
  
  La note ne sera pas visible si le document est imprimé ou
  affiché, mais elle sera visible si le document est converti en PDF, soit par
  Acrobat Distiller™, soit par Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>       La position x du coin inférieur gauche.
  <info>float</info>     <strong>$lly</strong>       La position y du coin inférieur gauche.
  <info>float</info>     <strong>$urx</strong>       La position x du coin supérieur droit.
  <info>float</info>     <strong>$ury</strong>       La position y du coin supérieur droit.
  <info>string</info>    <strong>$contents</strong>  Le texte de la note.
  <info>string</info>    <strong>$title</strong>     Le titre de la note affiché en tant qu'en-tête de la note.
  <info>string</info>    <strong>$icon</strong>      L'icône montrée si la note est pliée. Le paramètre peut être fixé à <return>comment</return>,
                       <return>insert</return>, <return>note</return>, <return>paragraph</return>, <return>newparagraph</return>, <return>key</return> ou <return>help</return>.
  <info>int</info>       <strong>$open</strong>      Si <strong>$open</strong> n'est pas égal à zéro, la note sera affichée dépliée après
                       l'ouverture du document dans un visualisateur PDF.

<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>ps_add_pdflink()</strong>
   * <strong>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_pdflink
type: function
doc:
<comment>Description:</comment>
  Ajoute un lien à une page à un second document PDF
  
  <strong>ps_add_pdflink()</strong> place un hyperlien à une position donnée à un second document PDF. Cliquer sur le
  lien branchera au document à la page donnée. La première page dans un document a le numéro 1.
  
  La position source de l'hyperlien est un rectangle avec son coin inférieur gauche à (<strong>$llx</strong>, <strong>$lly</strong>)
  et son coin supérieur droit à (<strong>$urx</strong>, <strong>$lly</strong>). Le rectangle a par défaut une mince bordure bleue.
  
  La note ne sera pas visible si le document est imprimé ou
  affiché, mais elle sera visible si le document est converti en PDF, soit par
  Acrobat Distiller™, soit par Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     
  <info>float</info>     <strong>$llx</strong>       La position x du coin inférieur gauche.
  <info>float</info>     <strong>$lly</strong>       La position y du coin inférieur gauche.
  <info>float</info>     <strong>$urx</strong>       La position x du coin supérieur droit.
  <info>float</info>     <strong>$ury</strong>       La position y du coin supérieur droit.
  <info>string</info>    <strong>$filename</strong>  Le nom du document PDF qui sera ouvert lors du clic sur ce lien.
  <info>int</info>       <strong>$page</strong>      Le numéro de page de la destination du document PDF.
  <info>string</info>    <strong>$dest</strong>      Le paramètre <strong>$dest</strong> détermine comment le document sera vu. Il peut être
                       <return>fitpage</return>, <return>fitwidth</return>, <return>fitheight</return> ou <return>fitbbox</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>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_weblink()</strong>


id: ps_add_weblink
type: function
doc:
<comment>Description:</comment>
  Ajoute un lien à un emplacement web
  
  Place un hyperlien à la position donnée à une page web. La position source de l'hyperlien est un
  rectangle avec son coin inférieur gauche à (<strong>$llx</strong>, <strong>$lly</strong>) et son coin supérieur droit à (<strong>$urx</strong>,
  <strong>$ury</strong>). Le rectangle a par défaut une mince bordure bleue.
  
  La note ne sera pas visible si le document est imprimé ou
  affiché, mais elle sera visible si le document est converti en PDF, soit par
  Acrobat Distiller™, soit par Ghostview.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$llx</strong>    La position x du coin inférieur gauche.
  <info>float</info>     <strong>$lly</strong>    La position y du coin inférieur gauche.
  <info>float</info>     <strong>$urx</strong>    La position x du coin supérieur droit.
  <info>float</info>     <strong>$ury</strong>    La position y du coin supérieur droit.
  <info>string</info>    <strong>$url</strong>    L'adresse url du lien hypertexte à être ouvert lors du clic sur ce lien, par
                    exemple <return>http://www.php.net</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>ps_add_launchlink()</strong>
   * <strong>ps_add_locallink()</strong>
   * <strong>ps_add_pdflink()</strong>


id: ps_arc
type: function
doc:
<comment>Description:</comment>
  Dessine un arc dans le sens contraire des aiguilles d'une montre
  
  Dessine une portion d'un cercle avec un point milieu à (<strong>$x</strong>, <strong>$y</strong>). L'arc débute à un angle de <strong>$alpha</strong>
  et termine avec un angle de <strong>$beta</strong>. Il est tracé dans le sens contraire des aiguilles d'une montre
  (utilisez <strong>ps_arcn()</strong> pour dessiner dans le sens des aiguilles d'une montre). La sous trajectoire
  ajoutée à la trajectoire courante débute sur l'arc à l'angle <strong>$alpha</strong> et termine sur l'arc à l'angle
  <strong>$beta</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       La position x du centre du cercle.
  <info>float</info>     <strong>$y</strong>       La position y du centre du cercle.
  <info>float</info>     <strong>$radius</strong>  Le rayon du cercle.
  <info>float</info>     <strong>$alpha</strong>   L'angle de départ donné en degrés.
  <info>float</info>     <strong>$beta</strong>    L'angle de fin donné en degrés.

<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>ps_arcn()</strong>


id: ps_arcn
type: function
doc:
<comment>Description:</comment>
  Dessine un arc dans le sens des aiguilles d'une montre
  
  Dessine une portion d'un cercle avec un point milieu à (<strong>$x</strong>, <strong>$y</strong>). L'arc débute à un angle de <strong>$alpha</strong>
  et termine avec un angle de <strong>$beta</strong>. Il est tracé dans le sens des aiguilles d'une montre (utilisez
  <strong>ps_arc()</strong> pour dessiner dans le sens contraire des aiguilles d'une montre). La sous trajectoire
  ajoutée à la trajectoire courante débute sur l'arc à l'angle <strong>$beta</strong> et termine sur l'arc à l'angle
  <strong>$alpha</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       La position x du centre du cercle.
  <info>float</info>     <strong>$y</strong>       La position y du centre du cercle.
  <info>float</info>     <strong>$radius</strong>  Le rayon du cercle.
  <info>float</info>     <strong>$alpha</strong>   L'angle de départ donné en degrés.
  <info>float</info>     <strong>$beta</strong>    L'angle de fin donné en degrés.

<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>ps_arc()</strong>


id: ps_begin_page
type: function
doc:
<comment>Description:</comment>
  Démarre une nouvelle page
  
  Démarre une nouvelle page. Bien que les paramètres <strong>$width</strong> et <strong>$height</strong> implique une taille
  différente des feuilles pour chaque page, cela n'est pas possible dans PostScript. Le premier
  appel de <strong>ps_begin_page()</strong> fixera la taille des pages pour le document entier. Des appels
  consécutifs n'auront aucun effet, à l'exception pour créer une nouvelle page. La situation est
  différente si vous tentez de convertir le document PostScript en PDF. Cette fonction place des
  marques pdf à l'intérieur du document qui peuvent fixer la taille pour chaque page
  individuellement. Le document PDF résultant aura différentes tailles de pages.
  
  Bien que le PostScript ne sait pas les tailles des différentes pages, pslib place une boîte de
  contour pour chaque page dans le document. La taille est évaluée par quelques lecteurs PostScript
  et aura précédence sur la BoundingBox dans l'en-tête du document. Ceci peut mener à des résultats
  non attendus lorsque vous fixez une BoundingBox dont le coin inférieur gauche n'est pas (0, 0),
  parce que la boîte de contour de la page aura toujours le coin inférieur gauche à (0, 0) et
  écrasera les configurations globales.
  
  Chaque page est encapsulée en sauvegarde/restauration. Cela signifie, que la plupart des
  configurations effectuées sur une page ne seront pas retenues sur la page suivante.
  
  S'il n'y a aucun appel de <strong>ps_findfond()</strong> jusqu'au premier appel de <strong>ps_begin_page()</strong>, alors l'en-tête
  du document PostScript sera affichée et le rectangle englobant sera fixé à la taille de la
  première page. Le coin inférieur gauche de la boîte de contour est fixée à (0, 0). Si
  <strong>ps_findfont()</strong> était appelée avant que l'en-tête ne soit déjà affichée, le document n'aura pas un
  rectangle englobant valide. Afin de prévenir cela, vous devriez appeler <strong>ps_set_info()</strong> pour fixer
  le champ d'information <return>BoundingBox</return> et possiblement <return>Orientation</return> avant d'appeler <strong>ps_findfont()</strong> ou
  <strong>ps_begin_page()</strong>.
  
  Jusqu'à la version 0.2.6 de pslib, cette fonction écrasera toujours la BoundingBox et
  l'Orientation, si elle n'a pas été fixée avant avec la fonction <strong>ps_set_info()</strong> et que la fonction
  <strong>ps_findfont()</strong> n'ait jamais été appelée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>   La largeur de la page en pixel, par exemple 596 pour le format A4.
  <info>float</info>     <strong>$height</strong>  La hauteur de la page en pixel, par exemple 842 pour le format A4.

<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>ps_end_page()</strong>
   * <strong>ps_findfont()</strong>
   * <strong>ps_set_info()</strong>


id: ps_begin_pattern
type: function
doc:
<comment>Description:</comment>
  Démarre un nouveau motif
  
  Démarre un nouveau motif. Un motif est comme une page contenant par exemple un dessin qui peut
  être utilisé pour remplir des secteurs. Il est utilisé comme une couleur en appelant <strong>ps_setcolor()</strong>
  et en configurant l'emplacement de la couleur au <return>motif</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>      La largeur du motif en pixel.
  <info>float</info>     <strong>$height</strong>     La hauteur du motif en pixel.
  <info></info>          <strong>$x-step</strong>     La distance en pixel de l'emplacement du motif dans la direction
                        horizontale.
  <info></info>          <strong>$y-step</strong>     La distance en pixel de l'emplacement du motif dans la direction verticale.
  <info>int</info>       <strong>$painttype</strong>  Doit être 1 ou 2.

<comment>Return:</comment>
  <info>int|false</info>  L'identifiant du motif  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>ps_end_pattern()</strong>
   * <strong>ps_setcolor()</strong>
   * <strong>ps_shading_pattern()</strong>


id: ps_begin_template
type: function
doc:
<comment>Description:</comment>
  Démarre un nouveau modèle
  
  <strong>ps_begin_template()</strong> démarre un nouveau modèle.  Un modèle est appelé par un formulaire dans le
  langage PostScript.  Il est créé de la même manière qu'un motif, mais est utilisé comme une image.
  Les modèles sont souvent utilisés pour les dessins qui sont placés plusieurs fois dans le
  document, par exemple un logo de compagnie. Toutes les fonctions de dessin peuvent être utilisées
  dans un modèle. Le modèle ne sera pas dessiné tant qu'il n'est pas placé par <strong>ps_place_image()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>   La largeur du modèle en pixels.
  <info>float</info>     <strong>$height</strong>  La hauteur du modèle en pixels.

<comment>Return:</comment>
  <info>int</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>ps_end_template()</strong>


id: ps_circle
type: function
doc:
<comment>Description:</comment>
  Dessine un cercle
  
  Dessine un cercle avec son point milieu à (<strong>$x</strong>, <strong>$y</strong>). Le cercle débute et termine à la position
  (<strong>$x</strong>+<strong>$radius</strong>, <strong>$y</strong>). Si cette fonction est appelée à l'extérieur d'un chemin, elle démarrera un
  nouveau chemin. Si elle est appelée à l'intérieur d'un chemin, elle ajoutera le cercle comme étant
  un sous chemin. Si la dernière opération de dessin ne se termine pas au point (<strong>$x</strong>+<strong>$radius</strong>, <strong>$y</strong>)
  alors il y aura un trou dans le chemin.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       La position x du centre du cercle.
  <info>float</info>     <strong>$y</strong>       La position y du centre du cercle.
  <info>float</info>     <strong>$radius</strong>  Le rayon du cercle.

<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>ps_arc()</strong>
   * <strong>ps_arcn()</strong>


id: ps_clip
type: function
doc:
<comment>Description:</comment>
  Attache le dessin au chemin courant
  
  Prend le chemin courant et l'utilise pour définir la bordure du secteur à attacher. Tout ce qui
  est dessiné à l'extérieur de ce secteur ne sera pas visible.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_closepath()</strong>


id: ps_close
type: function
doc:
<comment>Description:</comment>
  Ferme le document PostScript
  
  Ferme le document PostScript.
  
  Cette fonction écrit les dernières informations dans le document PostScript. Elle écrit aussi
  l'arbre des signets. <strong>ps_close()</strong> ne libère aucune ressource, ceci peut être fait par <strong>ps_delete()</strong>.
  
  Cette fonction est aussi appelée par <strong>ps_delete()</strong> si elle n'avait pas été appelée avant.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_open_file()</strong>
   * <strong>ps_delete()</strong>


id: ps_close_image
type: function
doc:
<comment>Description:</comment>
  Ferme l'image et libère la mémoire
  
  Ferme une image et libère ses ressources. Une fois l'image fermée, elle ne peut plus être
  utilisée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>    Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>int</info>       <strong>$imageid</strong>  Identifiant d'une image retourné par <strong>ps_open_image()</strong> ou <strong>ps_open_image_file()</strong>.

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

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_open_image_file()</strong>


id: ps_closepath
type: function
doc:
<comment>Description:</comment>
  Ferme un chemin
  
  Connecte le dernier point avec le premier point du chemin. Le chemin résultant peut être utilisé
  comme ligne, remplissage, coupure, etc.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_clip()</strong>
   * <strong>ps_closepath_stroke()</strong>


id: ps_closepath_stroke
type: function
doc:
<comment>Description:</comment>
  Ferme et trace un chemin
  
  Connecte le dernier point avec le premier point du chemin et dessine le résultat de la ligne
  fermée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_closepath()</strong>


id: ps_continue_text
type: function
doc:
<comment>Description:</comment>
  Continue un texte à la ligne suivante
  
  Écrit un texte une ligne en dessous de la dernière ligne. L'espace entre les lignes est pris avec
  la valeur "leading" qui doit être fixée avec <strong>ps_set_value()</strong>. La position actuelle du texte est
  déterminée par les valeurs "textx" et "texty" qui peuvent être récupérées par <strong>ps_get_value()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   Le texte à afficher.

<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>ps_show()</strong>
   * <strong>ps_show_xy()</strong>
   * <strong>ps_show_boxed()</strong>


id: ps_curveto
type: function
doc:
<comment>Description:</comment>
  Dessine une courbe
  
  <strong>ps_curveto()</strong> ajoute une section d'une courbe Bézier cubique décrit par les trois points de
  contrôle donnés au chemin courant.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x1</strong>     Position x du premier point de contrôle.
  <info>float</info>     <strong>$y1</strong>     Position y du premier point de contrôle.
  <info>float</info>     <strong>$x2</strong>     Position x du deuxième point de contrôle.
  <info>float</info>     <strong>$y2</strong>     Position y du deuxième point de contrôle.
  <info>float</info>     <strong>$x3</strong>     Position x du troisième point de contrôle.
  <info>float</info>     <strong>$y3</strong>     Position y du troisième point de contrôle.

<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>ps_lineto()</strong>


id: ps_delete
type: function
doc:
<comment>Description:</comment>
  Supprime toutes les ressources d'un document PostScript
  
  Libère principale la mémoire utilisée par le document. Ferme aussi un fichier, s'il n'était pas
  fermée auparavant avec la fonction <strong>ps_close()</strong>. Vous devriez dans tous les cas fermer le fichier
  avec <strong>ps_close()</strong> avant, car <strong>ps_close()</strong> ne ferme pas simplement le fichier mais écrit aussi les
  dernières informations contenant le commentaire PostScript avec le nombre de pages dans le
  document et ajoute la hiérarchie des signets.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_close()</strong>


id: ps_end_page
type: function
doc:
<comment>Description:</comment>
  Termine une page
  
  Termine une page qui a été débutée avec <strong>ps_begin_page()</strong>. Terminer une page laissera le contexte
  courant de dessin, qui par exemple requiert de recharger les polices si elles ont été chargées
  avec la page et fixe plusieurs autres paramètres de dessin comme la largeur des lignes, la
  couleur.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_begin_page()</strong>


id: ps_end_pattern
type: function
doc:
<comment>Description:</comment>
  Termine un motif
  
  Termine un motif qui a été débuté avec <strong>ps_begin_pattern()</strong>. Une fois qu'un motif est terminé, il
  peut être utilisé en tant que couleur pour remplir des secteurs.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_begin_pattern()</strong>


id: ps_end_template
type: function
doc:
<comment>Description:</comment>
  Termine un modèle
  
  Termine un modèle qui a été débuté avec <strong>ps_begin_template()</strong>. Une fois un modèle terminé, il peut
  être utilisé comme une image.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_begin_template()</strong>


id: ps_fill
type: function
doc:
<comment>Description:</comment>
  Remplit le chemin courant
  
  Remplit le chemin construit avec des fonctions de dessin comme <strong>ps_lineto()</strong> précédemment appelées.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_fill_stroke()</strong>
   * <strong>ps_stroke()</strong>


id: ps_fill_stroke
type: function
doc:
<comment>Description:</comment>
  Remplit et trace le chemin courant
  
  Remplit et dessine le chemin construit avec des fonctions de dessin comme <strong>ps_lineto()</strong> précédemment
  appelées.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_fill()</strong>
   * <strong>ps_stroke()</strong>


id: ps_findfont
type: function
doc:
<comment>Description:</comment>
  Charge une police
  
  <strong>ps_findfont()</strong> charge une police pour utilisation ultérieure.  Avant que le texte soit écrit avec
  la police chargée, il doit être fixé avec <strong>ps_setfont()</strong>. Cette fonction doit avoir le fichier de
  police métrique "adobe" afin de calculer l'espace utilisé par les caractères. Une police qui est
  chargée dans une page sera seulement disponible sur cette page. Les polices qui seront utilisées
  dans le document complet doivent être chargées avant le premier appel de <strong>ps_begin_page()</strong>. L'appel
  de <strong>ps_findfont()</strong> entre les pages rendra cette police disponible pour toutes les pages qui suivent.
  
  Le nom du fichier afm doit être <strong>$fontname</strong><return>.afm</return>. Si la police doit être incorporée, le fichier
  <strong>$fontname</strong><return>.pfb</return> contenant le dessin de la police doit être présent aussi.
  
  L'appel de <strong>ps_findfont()</strong> avant la première page requiert l'affichage de l'en-tête du postscript
  qui inclut le BoundingBox pour le document entier. Normalement, le BoundingBox est fixé avec le
  premier appel de <strong>ps_begin_page()</strong> qui vient maintenant après <strong>ps_findfont()</strong>. En conséquence, le
  BoundingBox n'a pas été fixée et une erreur sera lancée lorsque <strong>ps_findfont()</strong> sera appelée. Afin
  de prévenir cette situation, vous devriez appeler la fonction <strong>ps_set_parameter()</strong> pour fixer le
  BoundingBox avant que <strong>ps_findfont()</strong> soit appelée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$fontname</strong>  Le nom de la police.
  <info>string</info>    <strong>$encoding</strong>  <strong>ps_findfont()</strong> essaiera de charger le fichier passé dans le paramètre
                       <strong>$encoding</strong>. Les fichiers d'encodage sont de même syntaxe que ceux utilisés par
                       dvips(1). Ils contiennent un vecteur de police d'encodage (qui n'est
                       actuellement pas utilisé, mais qui doit être présent) et une liste de
                       ligatures en extra pour prolonger la liste des ligatures dérivées du fichier
                       AFM.
                       
                       <strong>$encoding</strong> peut être <info>null</info> ou une chaîne de caractères vide si l'encodage par
                       défaut (TeXBase1) désire être utilisé.
                       
                       Si l'encodage est fixé à <return>builtin</return> alors il n'y aura pas d'encodage à nouveau
                       et l'encodage spécifique de police sera utilisé. Cela est très utile pour les
                       polices avec symboles.
  <info>bool</info>      <strong>$embed</strong>     Si fixé à une valeur &gt;0, la police sera incorporée dans le document. Ceci
                       requiert la présence du fichier dessin (.pfb).

<comment>Return:</comment>
  <info>int</info>  Retourne un identifiant de la police ou zéro en cas d'erreur. L'identifiant est un nombre
       positif.

<comment>See Also:</comment>
   * <strong>ps_begin_page()</strong>
   * <strong>ps_setfont()</strong>


id: ps_get_buffer
type: function
doc:
<comment>Description:</comment>
  Récupère le tampon complet contenant les données PS générées
  
  Cette fonction n'est pas encore implémentée. Elle retournera toujours une chaîne de caractères
  vide. L'idée pour une future implémentation est d'écrire le contenu du fichier postscript dans un
  tampon interne si création en mémoire est demandée et de retourner le contenu du tampon avec la
  fonction. Présentement, les documents créés en mémoire sont envoyés au navigateur sans utilisation
  de tampon.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.

<comment>Return:</comment>
  <info>string</info>  

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


id: ps_get_parameter
type: function
doc:
<comment>Description:</comment>
  Récupère certains paramètres
  
  Récupère plusieurs paramètres qui ont été fixés directement par <strong>ps_set_parameter()</strong> ou
  indirectement par une ou d'autres fonctions. Les paramètres sont, par définition, des valeurs de
  chaîne de caractères. Cette fonction ne peut être utilisée pour récupérer les ressources qui ont
  été aussi fixées par <strong>ps_set_parameter()</strong>.
  
  Le paramètre <strong>$name</strong> peut avoir une des valeurs suivantes.
  
  <return>fontname</return> Le nom de la police présentement active ou la police dont l'identifiant est passé dans le
  paramètre <strong>$modifier</strong>. <return>fontencoding</return> L'encodage de la police présentement active. <return>dottedversion</return> La
  version la bibliothèque sous-jacente pslib dans le format \<majeur&gt;.\<mineur&gt;.\<sousmineur&gt; <return>scope</return> La portée courante du dessin. Peut être un objet, un document, <info>null</info>, une page, un motif, un chemin, un modèle, un prolog, une police, un glyphe. <return>ligaturedisolvechar</return> Le caractère qui détache une ligature. Si vous utilisez une police qui contient une ligature `ff' et `|` est le caractère à détacher la ligature, alors `f|f' donnera deux `f' au lieu de la ligature `ff'. <return>imageencoding</return> L'encodage utilisé pour encoder les images. Peut être soit <return>hex</return> ou <return>85</return>. L'encodage hex utilise deux octets dans le fichier PostScript, chaque octet dans une image.  85 représente l'encodage Ascii85. <return>linenumbermode</return> Fixe à <return>paragraph</return> si des lignes sont numérotées à l'intérieur d'un paragraphe ou <return>box</return> si elles sont numérotées dans une boîte qui l'entoure. <return>linebreak</return> Seulement utilisé si le texte est affiché avec <strong>ps_show_boxed()</strong>. Si fixé à <info>true</info>, un retour au chariot ajoutera un saut de ligne. <return>parbreak</return> Seulement utilisé si le texte est affiché avec <strong>ps_show_boxed()</strong>. Si fixé à <info>true</info>, un retour au chariot démarrera un nouveau paragraphe. <return>hyphenation</return> Seulement utilisé si le texte est affiché avec <strong>ps_show_boxed()</strong>. Si fixé à <info>true</info>, le paragraphe sera divisé si un dictionnaire de trait d'union est fixé et existe. <return>hyphendict</return> Nom du fichier du dictionnaire utilisé pour le motif de trait d'union.
  
  Le nom de la police présentement active ou la police dont l'identifiant est passé dans le
  paramètre <strong>$modifier</strong>.
  
  L'encodage de la police présentement active.
  
  La version la bibliothèque sous-jacente pslib dans le format \<majeur&gt;.\<mineur&gt;.\<sousmineur&gt;
  
  La portée courante du dessin. Peut être un objet, un document, <info>null</info>, une page, un motif, un
  chemin, un modèle, un prolog, une police, un glyphe.
  
  Le caractère qui détache une ligature. Si vous utilisez une police qui contient une ligature `ff'
  et `|` est le caractère à détacher la ligature, alors `f|f' donnera deux `f' au lieu de la
  ligature `ff'.
  
  L'encodage utilisé pour encoder les images. Peut être soit <return>hex</return> ou <return>85</return>. L'encodage hex utilise deux
  octets dans le fichier PostScript, chaque octet dans une image.  85 représente l'encodage Ascii85.
  
  Fixe à <return>paragraph</return> si des lignes sont numérotées à l'intérieur d'un paragraphe ou <return>box</return> si elles sont
  numérotées dans une boîte qui l'entoure.
  
  Seulement utilisé si le texte est affiché avec <strong>ps_show_boxed()</strong>. Si fixé à <info>true</info>, un retour au
  chariot ajoutera un saut de ligne.
  
  Seulement utilisé si le texte est affiché avec <strong>ps_show_boxed()</strong>. Si fixé à <info>true</info>, un retour au
  chariot démarrera un nouveau paragraphe.
  
  Seulement utilisé si le texte est affiché avec <strong>ps_show_boxed()</strong>. Si fixé à <info>true</info>, le paragraphe sera
  divisé si un dictionnaire de trait d'union est fixé et existe.
  
  Nom du fichier du dictionnaire utilisé pour le motif de trait d'union.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>      Nom du paramètre.
  <info>float</info>     <strong>$modifier</strong>  Un identifiant requis si le paramètre d'une ressource est requis, par
                       exemple, la taille d'une image. Dans ce cas, l'identifiant de la ressource
                       est passé.

<comment>Return:</comment>
  <info>string|false</info>  Retourne la valeur du paramètre  ou <info>false</info> si une erreur survient.

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


id: ps_get_value
type: function
doc:
<comment>Description:</comment>
  Récupère certaines valeurs
  
  Récupère plusieurs valeurs qui ont été fixées par <strong>ps_set_value()</strong>. Les valeurs sont par définition
  des valeurs de nombre décimal.
  
  Le paramètre <strong>$name</strong> peut avoir une des valeurs suivantes.
  
  <return>fontsize</return> La taille de la police présentement active ou la police dont l'identifiant est passé dans
  le paramètre <strong>$modifier</strong>. <return>font</return> La police présentement active en elle-même. <return>imagewidth</return> La largeur de
  l'image dont l'identifiant est passé dans le paramètre <strong>$modifier</strong>. <return>imageheight</return> La hauteur de
  l'image dont l'identifiant est passé dans le paramètre <strong>$modifier</strong>. <return>capheight</return> La hauteur d'une
  capitale M dans la police présentement active ou la police dont l'identifiant est passé dans le
  paramètre  <strong>$modifier</strong>. <return>ascender</return> La hampe de la police présentement active ou la police dont
  l'identifiant est passé dans le paramètre <strong>$modifier</strong>. <return>descender</return> Le jambage de la police
  présentement active ou la police dont l'identifiant est passé dans le paramètre <strong>$modifier</strong>.
  <return>italicangle</return> Le paramètre italicangle de la police présentement active ou la police dont
  l'identifiant est passé dans le paramètre  <strong>$modifier</strong>. <return>underlineposition</return> Le paramètre
  underlineposition de la police présentement active ou la police dont l'identifiant est passé dans
  le paramètre <strong>$modifier</strong>. <return>underlinethickness</return> Le paramètre underlinethickness de la police
  présentement active ou la police dont l'identifiant est passé dans le paramètre <strong>$modifier</strong>. <return>textx</return>
  La position x courante d'affichage du texte. <return>texty</return> La position y courante d'affichage du texte.
  <return>textrendering</return> Le mode courant pour le rendu du texte. <return>textrise</return> L'espace par lequel le texte est
  augmenté au dessus de la ligne de base. <return>leading</return> La distance entre les lignes de texte en points.
  <return>wordspacing</return> L'espace entre les mots en tant que multiple de la largeur d'un caractère d'espace.
  <return>charspacing</return> L'espace entre les caractères. Si charspacing est != 0.0, les ligatures seront
  toujours détachées. <return>hyphenminchars</return> Nombre minimal de caractères avant un trait d'union à la fin
  d'un mot. <return>parindent</return> L'indentation des premières n lignes dans un paragraphe. <return>numindentlines</return> Nombre
  de ligne dans un paragraphe à indenter si paraindent != 0.0. <return>parskip</return> Distance entre les
  paragraphes. <return>linenumberspace</return> Espace général en face de chaque ligne pour le numéro de ligne.
  <return>linenumbersep</return> Espace entre les lignes et les numéros de lignes. <return>major</return> Le numéro de version majeur
  de pslib. <return>minor</return> Le numéro de version mineur de pslib. <return>subminor</return>, <return>revision</return> Le numéro de version sous
  mineur de pslib.
  
  La taille de la police présentement active ou la police dont l'identifiant est passé dans le
  paramètre <strong>$modifier</strong>.
  
  La police présentement active en elle-même.
  
  La largeur de l'image dont l'identifiant est passé dans le paramètre <strong>$modifier</strong>.
  
  La hauteur de l'image dont l'identifiant est passé dans le paramètre <strong>$modifier</strong>.
  
  La hauteur d'une capitale M dans la police présentement active ou la police dont l'identifiant est
  passé dans le paramètre  <strong>$modifier</strong>.
  
  La hampe de la police présentement active ou la police dont l'identifiant est passé dans le
  paramètre <strong>$modifier</strong>.
  
  Le jambage de la police présentement active ou la police dont l'identifiant est passé dans le
  paramètre <strong>$modifier</strong>.
  
  Le paramètre italicangle de la police présentement active ou la police dont l'identifiant est
  passé dans le paramètre  <strong>$modifier</strong>.
  
  Le paramètre underlineposition de la police présentement active ou la police dont l'identifiant
  est passé dans le paramètre <strong>$modifier</strong>.
  
  Le paramètre underlinethickness de la police présentement active ou la police dont l'identifiant
  est passé dans le paramètre <strong>$modifier</strong>.
  
  La position x courante d'affichage du texte.
  
  La position y courante d'affichage du texte.
  
  Le mode courant pour le rendu du texte.
  
  L'espace par lequel le texte est augmenté au dessus de la ligne de base.
  
  La distance entre les lignes de texte en points.
  
  L'espace entre les mots en tant que multiple de la largeur d'un caractère d'espace.
  
  L'espace entre les caractères. Si charspacing est != 0.0, les ligatures seront toujours détachées.
  
  Nombre minimal de caractères avant un trait d'union à la fin d'un mot.
  
  L'indentation des premières n lignes dans un paragraphe.
  
  Nombre de ligne dans un paragraphe à indenter si paraindent != 0.0.
  
  Distance entre les paragraphes.
  
  Espace général en face de chaque ligne pour le numéro de ligne.
  
  Espace entre les lignes et les numéros de lignes.
  
  Le numéro de version majeur de pslib.
  
  Le numéro de version mineur de pslib.
  
  Le numéro de version sous mineur de pslib.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>      Nom de la valeur.
  <info>float</info>     <strong>$modifier</strong>  Le paramètre <strong>$modifier</strong> spécifie la ressource pour laquelle la valeur sera
                       récupérée. Cela peut être l'ID de la police ou une image.

<comment>Return:</comment>
  <info>float</info>  Retourne la valeur du paramètre ou <info>false</info>.

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


id: ps_hyphenate
type: function
doc:
<comment>Description:</comment>
  Relie un mot
  
  Relie le mot passé. <strong>ps_hyphenate()</strong> évalue la valeur hyphenminchars (fixé par <strong>ps_set_value()</strong>) et le
  paramètre hyphendic (fixé par <strong>ps_set_parameter()</strong>). hyphendict doit être fixé avant d'appeler cette
  fonction.
  
  Cette fonction requiert que la configuration locale LC_CTYPE soit correctement faîte. Cela est
  fait lorsque l'extension est initialisée en utilisant les variables d'environnement. Sur les
  systèmes Unix, lisez les pages de manuel de locale pour plus d'informations.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   <strong>$text</strong> ne devrait pas contenir de caractères non alpha. Les positions possibles
                    pour les coupures sont retournées dans un tableau de nombre entier. Chaque
                    nombre est la position du caractère dans <strong>$text</strong> après que la liaison puisse avoir
                    lieu.

<comment>Return:</comment>
  <info>array|false</info>  Un tableau d'entier indiquant la position des coupures possibles dans le texte  ou
               <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>ps_show_boxed()</strong>
   * locale(1)


id: ps_include_file
type: function
doc:
<comment>Description:</comment>
  Lit un fichier externe avec du code PostScript brut
  
   Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant de ressource du fichier postscript, tel que retourné par la fonction
                    <strong>ps_new()</strong>.
  <info>string</info>    <strong>$file</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: ps_lineto
type: function
doc:
<comment>Description:</comment>
  Dessine une ligne
  
  Ajoute une ligne droite à partir du point courant aux coordonnées données au chemin courant.
  Utilisez <strong>ps_moveto()</strong> pour fixer le point de départ de la ligne.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      La position x du dernier point de la ligne.
  <info>float</info>     <strong>$y</strong>      La position y du dernier point de la ligne.

<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>ps_moveto()</strong>


id: ps_makespotcolor
type: function
doc:
<comment>Description:</comment>
  Crée une tache de couleur
  
  Crée une tache de couleur à partir de la couleur de remplissage courante. La couleur de
  remplissage doit être définie en espace colorimétrique rgb, cmyk ou gris. Le nom de la tache de
  couleur peut être un nom arbitraire. Une tache de couleur peut être fixée à n'importe quelle
  couleur avec <strong>ps_setcolor()</strong>. Lorsque le document n'est pas imprimé, mais est affiché par un
  visualisateur PostScript, la couleur donnée dans l'espace de couleur spécifié est utilisé.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   Nom de la tache de couleur, par exemple Pantone 5565.

<comment>Return:</comment>
  <info>int</info>  L'ID de la nouvelle tache de couleur ou <return>0</return> en cas d'erreur.

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


id: ps_moveto
type: function
doc:
<comment>Description:</comment>
  Fixe le point courant
  
  Fixe le point courant à de nouvelles coordonnées. Si cela est le premier appel de <strong>ps_moveto()</strong>
  après qu'un chemin précédent ait été terminé alors il démarrera un nouveau chemin. Si cette
  fonction est appelée au milieu d'un chemin, elle fixera simplement le point courant et débutera un
  sous chemin.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      La position x du point où se déplacer.
  <info>float</info>     <strong>$y</strong>      La position y du point où se déplacer.

<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>ps_lineto()</strong>


id: ps_new
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet document PostScript
  
  Crée une nouvelle instance de document. Elle ne crée pas le fichier sur le disque ou dans la
  mémoire. Elle prépare simplement tout. <strong>ps_new()</strong> est normalement suivie par un appel de
  <strong>ps_open_file()</strong> pour créer le document PostScript.

<comment>Return:</comment>
  <info>resource|false</info>  Ressource d'un document PostScript ou <info>false</info> si une erreur survient. La valeur de
                  retour est passé à toutes les autres fonctions en tant que premier argument.

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


id: ps_open_file
type: function
doc:
<comment>Description:</comment>
  Ouvre un fichier pour écriture
  
  Crée un nouveau fichier sur le disque et écrit le document PostScript à l'intérieur. Le fichier
  sera fermé lorsque <strong>ps_close()</strong> sera appelée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>     Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$filename</strong>  Le nom du fichier PostScript. Si <strong>$filename</strong> n'est pas passé, le document sera
                       créé en mémoire et toutes les écritures iront directement au navigateur.

<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>ps_close()</strong>


id: ps_open_image
type: function
doc:
<comment>Description:</comment>
  Lit une image pour placement futur
  
  Lit une image qui est déjà disponible en mémoire. Le paramètre <strong>$source</strong> n'est présentent pas évalué
  et est assumé d'être <return>memory</return>. Les données de l'image est une séquence de pixels démarrant avec le
  coin supérieur gauche et termine avec le coin inférieur droit. Chaque pixel consiste de composants
  de couleur <strong>$components</strong> et chaque composant a <strong>$bpc</strong> bits.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>        Type de l'image. Les valeurs possibles sont <return>png</return>, <return>jpeg</return> ou <return>eps</return>.
  <info>string</info>    <strong>$source</strong>      Non utilisé.
  <info>string</info>    <strong>$data</strong>        Les données de l'image.
  <info></info>          <strong>$length</strong>      La taille des données de l'image.
  <info>int</info>       <strong>$width</strong>       La largeur de l'image.
  <info>int</info>       <strong>$height</strong>      La hauteur de l'image.
  <info>int</info>       <strong>$components</strong>  Le nombre de composant pour chaque pixel. Cela peut être 1 (images à
                         échelle de gris), 3 (images rgb) ou 4 (images cmyk, rgba).
  <info>int</info>       <strong>$bpc</strong>         Nombre de bits par composant (très souvent 8).
  <info>string</info>    <strong>$params</strong>      

<comment>Return:</comment>
  <info>int</info>  Retourne l'identifiant de l'image ou zéro en cas d'erreur. L'identifiant est un nombre
       positif supérieur à <return>0</return>.

<comment>See Also:</comment>
   * <strong>ps_open_image_file()</strong>
   * <strong>ps_place_image()</strong>
   * <strong>ps_close_image()</strong>


id: ps_open_image_file
type: function
doc:
<comment>Description:</comment>
  Ouvre une image à partir d'un fichier
  
  Charge une image pour une utilisation ultérieure.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>        Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>         Type de l'image. Les valeurs possibles sont <return>png</return>, <return>jpeg</return> ou <return>eps</return>.
  <info>string</info>    <strong>$filename</strong>     Le nom du fichier contenant les données de l'image.
  <info>string</info>    <strong>$stringparam</strong>  Non utilisé.
  <info>int</info>       <strong>$intparam</strong>     Non utilisé.

<comment>Return:</comment>
  <info>int</info>  Retourne un identifiant de l'image ou zéro en cas d'erreur. L'identifiant est un nombre
       positive plus grand que <return>0</return>.

<comment>See Also:</comment>
   * <strong>ps_open_image()</strong>
   * <strong>ps_place_image()</strong>
   * <strong>ps_close_image()</strong>


id: ps_open_memory_image
type: function
doc:
<comment>Description:</comment>
  Prend une image GD et retourne une image à placer dans un document PS
  
   Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant de ressource du fichier postscript, tel que retourné par la fonction
                    <strong>ps_new()</strong>.
  <info>int</info>       <strong>$gd</strong>     

<comment>Return:</comment>
  <info>int</info>  


id: ps_place_image
type: function
doc:
<comment>Description:</comment>
  Place une image sur la page
  
  Place une image précédemment chargée sur la page. L'image peut être redimensionnée. Si l'image est
  tournée, vous devrez tourner le système de coordonnées avant avec <strong>ps_rotate()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>    Identifiant de ressource PostScript, tel que retourné par <strong>ps_new()</strong>.
  <info>int</info>       <strong>$imageid</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_open_image()</strong> ou
                      <strong>ps_open_image_file()</strong>.
  <info>float</info>     <strong>$x</strong>        La position x du coin inférieur gauche de l'image.
  <info>float</info>     <strong>$y</strong>        La position y du coin inférieur gauche de l'image.
  <info>float</info>     <strong>$scale</strong>    Le facteur de redimensionnement pour l'image. Un redimensionnement de 1.0
                      donnera une résolution de 72 dpi, parce que chaque pixel est équivalent à 1
                      point.

<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>ps_open_image()</strong>
   * <strong>ps_open_image_file()</strong>


id: ps_rect
type: function
doc:
<comment>Description:</comment>
  Dessine un rectangle
  
  Dessine un rectangle avec son coin inférieur gauche à (<strong>$x</strong>, <strong>$y</strong>). Le rectangle débute et termine sur
  son coin inférieur gauche. Si cette fonction est appelée à l'extérieur d'un chemin, elle démarrera
  un nouveau chemin. Si elle est appelée à l'intérieur d'un chemin, elle ajoutera le rectangle comme
  étant un sous chemin. Si la dernière opération de dessin ne se termine pas au coin inférieur
  gauche alors il y aura un trou dans le chemin.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>       La position x du coin inférieur gauche du rectangle.
  <info>float</info>     <strong>$y</strong>       La position y du coin inférieur gauche du rectangle.
  <info>float</info>     <strong>$width</strong>   La largeur de l'image.
  <info>float</info>     <strong>$height</strong>  La hauteur de l'image.

<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>ps_arc()</strong>
   * <strong>ps_cirle()</strong>
   * <strong>ps_lineto()</strong>


id: ps_restore
type: function
doc:
<comment>Description:</comment>
  Restaure un contexte précédemment sauvegardé
  
  Restaure un contexte graphique précédemment sauvegardé. Tout appel de <strong>ps_save()</strong> doit être
  accompagné par un appel à <strong>ps_restore()</strong>. Toutes les transformations de coordonnée, de
  configurations de style de ligne, de couleur, etc. sont restaurées à l'état avant l'appel de la
  fonction <strong>ps_save()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_save()</strong>


id: ps_rotate
type: function
doc:
<comment>Description:</comment>
  Fixe le facteur de rotation
  
  Fixe la rotation d'un système de coordonnées.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$rot</strong>    Angle de rotation en degrés.

<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>ps_scale()</strong>
   * <strong>ps_translate()</strong>


id: ps_save
type: function
doc:
<comment>Description:</comment>
  Sauvegarde le contexte courant
  
  Sauvegarde le contexte graphique courant, contenant les configurations des couleurs, des
  translations et rotations et quelques autres. Un contexte sauvegardé peut être restauré avec
  <strong>ps_restore()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_restore()</strong>


id: ps_scale
type: function
doc:
<comment>Description:</comment>
  Fixe le facteur de redimensionnement
  
  Fixe le redimensionnement horizontal et vertical d'un système de coordonnées.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      Facteur de redimensionnement en direction horizontale.
  <info>float</info>     <strong>$y</strong>      Facteur de redimensionnement en direction verticale.

<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>ps_rotate()</strong>
   * <strong>ps_translate()</strong>


id: ps_set_border_color
type: function
doc:
<comment>Description:</comment>
  Fixe la couleur des bordures pour les commentaires
  
  Les liens ajoutés avec une des fonctions telles que <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong>, etc.
  seront affichées avec un rectangle entouré lorsque le document postscript est converti en PDF et
  vu dans un visualisateur PDF. Ce rectangle n'est pas visible dans le document postscript. Cette
  fonction fixe la couleur de la bordure de la ligne du rectangle.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$red</strong>    Le composant rouge de la couleur de la bordure.
  <info>float</info>     <strong>$green</strong>  Le composant vert de la couleur de la bordure.
  <info>float</info>     <strong>$blue</strong>   Le composant bleu de la couleur de la bordure.

<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>ps_set_border_dash()</strong>
   * <strong>ps_set_border_style()</strong>


id: ps_set_border_dash
type: function
doc:
<comment>Description:</comment>
  Fixe la grandeur des tirets pour les bordures des commentaires
  
  Les liens ajoutés avec une des fonctions telles que <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong>, etc.
  seront affichées avec un rectangle entouré lorsque le document postscript est converti en pdf et
  vu dans un visualisateur pdf. Ce rectangle n'est pas visible dans le document postscript. Cette
  fonction fixe la grandeur de la portion de noir et blanc de la ligne de bordure pointillée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$black</strong>  La grandeur des pointillés.
  <info>float</info>     <strong>$white</strong>  La grandeur de l'espace entre les pointillés.

<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>ps_set_border_color()</strong>
   * <strong>ps_set_border_style()</strong>


id: ps_set_border_style
type: function
doc:
<comment>Description:</comment>
  Fixe le style de bordure des commentaires
  
  Les liens ajoutés avec une des fonctions telles que <strong>ps_add_weblink()</strong>, <strong>ps_add_pdflink()</strong>, etc.
  seront affichées avec un rectangle entouré lorsque le document postscript est converti en PDF et
  vu dans un visualisateur PDF. Ce rectangle n'est pas visible dans le document postscript. Cette
  fonction fixe l'apparence et la largeur de la ligne de bordure.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$style</strong>  <strong>$style</strong> peut être <return>solid</return> ou <return>dashed</return>.
  <info>float</info>     <strong>$width</strong>  La largeur de la bordure.

<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>ps_set_border_color()</strong>
   * <strong>ps_set_border_dash()</strong>


id: ps_set_info
type: function
doc:
<comment>Description:</comment>
  Assigne les champs d'informations d'un document
  
  <strong>ps_set_info()</strong> fixe certains champs d'informations du document. Les champs seront montrés en tant
  que commentaire dans l'en-tête du fichier PostScript. Si le document est converti en PDF, ces
  champs seront aussi utilisés pour les informations du document.
  
  Le <return>BoundingBox</return> est normalement fixé à la valeur donnée par la première page. Cela fonctionne
  seulement si <strong>ps_findfont()</strong> n'a pas été appelée auparavant. Dans ces cas, le BoundingBox sera
  laissé non fixé à moins que vous le fixé explicitement avec cette fonction.
  
  Cette fonction n'aura plus d'effet lorsque l'en-tête du fichier PostScript a été déjà été écrit.
  Elle doit être appelée avant la première page ou le premier appel de <strong>ps_findfont()</strong>.

<comment>Param:</comment>
  <info></info>        <strong>$psdoc</strong>  Identifiant de ressource PostScript,  retourné par <strong>ps_new()</strong>.
  <info>string</info>  <strong>$key</strong>    Le nom du champ d'information à configurer. Les valeurs de noms possibles sont
                  <return>Keywords</return>, <return>Subject</return>, <return>Title</return>, <return>Creator</return>, <return>Author</return>, <return>BoundingBox</return> et <return>Orientation</return>. Soyez
                  attentifs, car certains champs ont des significations spéciales pour les lecteurs
                  PostScript.
  <info></info>        <strong>$value</strong>  Les valeurs du champ d'information. Le champ <return>Orientation</return> peut être fixé à soit
                  <return>Portrait</return> ou <return>Landscape</return>. Le <return>BoundingBox</return> est une chaîne de caractères contenant
                  quatre nombres. Les deux premiers sont les coordonnées du coin inférieur gauche de
                  la page. Les deux derniers sont les coordonnées du coin supérieur droit.
                  
                  Jusqu'à la version 0.2.6 de pslib, le BoundingBox et Orientation seront toujours
                  écrasés par <strong>ps_begin_page()</strong>, à moins que <strong>ps_findfont()</strong> ait été appelée avant.

<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>ps_findfont()</strong>
   * <strong>ps_begin_page()</strong>


id: ps_set_parameter
type: function
doc:
<comment>Description:</comment>
  Fixe certains paramètres
  
  Fixe plusieurs paramètres qui sont utilisés par beaucoup de fonctions. Les paramètres sont par
  définition des valeurs de chaîne de caractères.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   Pour une liste des noms possibles, voyez <strong>ps_get_parameter()</strong>.
  <info>string</info>    <strong>$value</strong>  La valeur du 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.

<comment>See Also:</comment>
   * <strong>ps_get_parameters()</strong>
   * <strong>ps_set_value()</strong>


id: ps_set_text_pos
type: function
doc:
<comment>Description:</comment>
  Fixe la position l'écriture du texte
  
  Fixe la position pour la prochaine écriture de texte. Vous devriez alternativement fixer la valeur
  x et y séparément en appelant <strong>ps_set_value()</strong> et choisir <return>textx</return> respectivement <return>texty</return> comme nom de
  valeur.
  
  Si vous voulez afficher le texte à une certaine position, il est plus facile d'utiliser
  <strong>ps_show_xy()</strong> au lieu de configurer la position du texte et d'appeler <strong>ps_show()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      La position x de la nouvelle position du texte.
  <info>float</info>     <strong>$y</strong>      La position y de la nouvelle position du texte.

<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>ps_set_value()</strong>
   * <strong>ps_show()</strong>


id: ps_set_value
type: function
doc:
<comment>Description:</comment>
  Fixe certaines valeurs
  
  Fixe plusieurs valeurs qui sont utilisées par beaucoup de fonctions. Les paramètres sont par
  définitions des valeurs de nombre décimal.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$name</strong>   Le paramètre <strong>$name</strong> peut être une des valeurs suivantes : textrendering Le moyen
                    comme est montré le texte. textx La position de coordonnées x pour afficher le
                    texte. texty La position de coordonnées y pour afficher le texte. wordspacing La
                    distance entre les mots relativement à la largeur des espaces. leading La
                    distance entre les lignes en pixels.
                    
                    Le moyen comme est montré le texte.
                    
                    La position de coordonnées x pour afficher le texte.
                    
                    La position de coordonnées y pour afficher le texte.
                    
                    La distance entre les mots relativement à la largeur des espaces.
                    
                    La distance entre les lignes en pixels.
  <info>float</info>     <strong>$value</strong>  La valeur du 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.

<comment>See Also:</comment>
   * <strong>ps_get_value()</strong>
   * <strong>ps_set_parameter()</strong>


id: ps_setcolor
type: function
doc:
<comment>Description:</comment>
  Fixe la couleur courante
  
  Fixe la couleur pour le dessin, remplissage ou les deux.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>        Le paramètre <strong>$type</strong> peut être <return>both</return>, <return>fill</return> ou <return>fillstroke</return>.
  <info>string</info>    <strong>$colorspace</strong>  L'espace colorimétrique peut être soit <return>gray</return>, <return>rgb</return>, <return>cmyk</return>,  <return>spot</return>, <return>pattern</return>.
                         Dépendamment de l'espace colorimétrique soit le premier, les trois premiers
                         ou tous les paramètres peuvent être utilisés.
  <info>float</info>     <strong>$c1</strong>          Dépendemment de l'espace colorimétrique, cette valeur peut être le
                         composant rouge (rgb), le composant cyan (cmyk), la valeur de gris (gris),
                         l'identifiant de la tache de couleur ou l'identifiant du motif.
  <info>float</info>     <strong>$c2</strong>          Dépendemment de l'espace colorimétrique, cette valeur peut être le
                         composant vert (rgb) ou le composant magenta (cmyk).
  <info>float</info>     <strong>$c3</strong>          Dépendemment de l'espace colorimétrique, cette valeur peut être le
                         composant bleu (rgb) ou le composant jaune (cymk).
  <info>float</info>     <strong>$c4</strong>          Ce paramètre doit être fixé seulement dans l'espace colorimétrique cymk et
                         spécifie le composant noir.

<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: ps_setdash
type: function
doc:
<comment>Description:</comment>
  Fixe l'apparence d'une ligne pointillée
  
  Fixe la longueur des portions de noir et blanc d'une ligne pointillée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$on</strong>     La grandeur des pointillés.
  <info>float</info>     <strong>$off</strong>    La grandeur des espaces entres les pointillés.

<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>ps_setpolydash()</strong>


id: ps_setflat
type: function
doc:
<comment>Description:</comment>
  Fixe la position à plat
  
   Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$value</strong>  La valeur <strong>$value</strong> doit être entre 0.2 et 1.

<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: ps_setfont
type: function
doc:
<comment>Description:</comment>
  Fixe la police à utiliser pour la prochaine écriture
  
  Fixe une police, qui doit être chargée avant avec <strong>ps_findfont()</strong>. L'écriture de texte sans
  configurer une police provoquera une erreur.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>int</info>       <strong>$fontid</strong>  L'identifiant de la police retourné par <strong>ps_findfont()</strong>.
  <info>float</info>     <strong>$size</strong>    La taille de la police.

<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>ps_findfont()</strong>
   * <strong>ps_set_text_pos()</strong> pour un exemple.


id: ps_setgray
type: function
doc:
<comment>Description:</comment>
  Fixe la valeur de gris
  
  Fixe la valeur de gris pour toutes les opérations de dessin suivantes.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$gray</strong>   La valeur doit être entre 0 (blanc) et 1 (noir).

<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>ps_setcolor()</strong>


id: ps_setlinecap
type: function
doc:
<comment>Description:</comment>
  Fixe l'apparence des fins de ligne
  
  Fixe comment les fins de ligne ressemblent.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>int</info>       <strong>$type</strong>   Le type de fin de ligne. Les valeurs possibles sont <return>PS_LINECAP_BUTT</return>,
                    <return>PS_LINECAP_ROUND</return> ou <return>PS_LINECAP_SQUARED</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>ps_setlinejoin()</strong>
   * <strong>ps_setlinewidth()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setlinejoin
type: function
doc:
<comment>Description:</comment>
  Fixe comment les lignes connectés sont jointes
  
  Fixe comment les lignes sont jointes.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>int</info>       <strong>$type</strong>   Le moyen comment les lignes sont jointes. Les valeurs possibles sont
                    <return>PS_LINEJOIN_MITER</return>, <return>PS_LINEJOIN_ROUND</return> ou <return>PS_LINEJOIN_BEVEL</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>ps_setlinecap()</strong>
   * <strong>ps_setlinewidth()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setlinewidth
type: function
doc:
<comment>Description:</comment>
  Fixe la largeur d'une ligne
  
  Fixe la largeur d'une ligne pour toutes les opérations de dessin suivantes.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$width</strong>  La largeur des lignes en points.

<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>ps_setlinecap()</strong>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setmiterlimit()</strong>


id: ps_setmiterlimit
type: function
doc:
<comment>Description:</comment>
  Fixe les limites de l'anglet
  
  Si deux lignes se joignent dans un petit angle et le joint des lignes est fixé à l'anglet
  <return>PS_LINEJOIN_MITER</return>, alors la mèche résultante sera vraiment longue. La limite de l'anglet est le
  ratio maximal de la longueur de l'anglet (la longueur de la mèche) et la largeur de la ligne.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$value</strong>  Le ratio maximal entre la grandeur de l'anglet et la largeur de la ligne. De
                    grandes valeurs (&gt; 10) auront pour effet l'affichage de très longues mèches
                    lorsque deux lignes se joignent dans un petit angle. Gardez le par défaut à
                    moins que vous sachiez que vous faites.

<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>ps_setlinecap()</strong>
   * <strong>ps_setlinejoin()</strong>
   * <strong>ps_setlinewidth()</strong>


id: ps_setoverprintmode
type: function
doc:
<comment>Description:</comment>
  Définit le mode "overprint"
  
   Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant de ressource du fichier postscript, tel que retourné par la fonction
                    <strong>ps_new()</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: ps_setpolydash
type: function
doc:
<comment>Description:</comment>
  Fixe l'apparence d'une ligne pointillée
  
  Fixe la longueur des portions de noir et blanc d'une ligne pointillée. <strong>ps_setpolydash()</strong> est
  utilisée pour fixer des motifs pointillés plus compliqués.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$arr</strong>    <strong>$arr</strong> est une liste des grandeurs des éléments alternativement pour la portion de
                    noir et de blanc.

<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>ps_setdash()</strong>


id: ps_shading
type: function
doc:
<comment>Description:</comment>
  Crée un ton pour usage futur
  
  Crée un ton, qui peut être utilisé par <strong>ps_shfill()</strong> ou <strong>ps_shading_pattern()</strong>.
  
  La couleur du ton peut être n'importe quelle couleur d'espace excepté pour <return>pattern</return>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>           Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$type</strong>            Le type de ton peut être soit <return>radial</return> ou <return>axial</return>. Chaque ton débute avec
                             la couleur courante de remplissage et termine avec la valeur de couleur
                             donnée passée dans les paramètres <strong>$c1</strong> à <strong>$c4</strong> (voyez <strong>ps_setcolor()</strong> pour
                             leur signification).
  <info></info>          <strong>$x0, x1, y0, y1</strong>  Les coordonnées <strong>$x0</strong>, <strong>$y0</strong>, <strong>$x1</strong>, <strong>$y1</strong> sont le point de début et de fin du
                             ton. Si le type de ton est <return>radial</return>, les deux points sont les points
                             milieux du début et de la fin du cercle.
  <info></info>          <strong>$c1, c2, c3, c4</strong>  Voyez <strong>ps_setcolor()</strong> pour leur signification.
  <info>string</info>    <strong>$optlist</strong>         Si le ton est de type <return>radial</return>, le <strong>$optlist</strong> doit aussi contenir les
                             paramètres <return>r0</return> et <return>r1</return> avec le radius du début et de fin du cercle.

<comment>Return:</comment>
  <info>int|false</info>  Retourne un identifiant du motif  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>ps_shading_pattern()</strong>
   * <strong>ps_shfill()</strong>


id: ps_shading_pattern
type: function
doc:
<comment>Description:</comment>
  Crée un motif basé sur le ton
  
  Crée un motif basé sur le ton, qui doit avoir été créé avant avec <strong>ps_shading()</strong>. Les motifs de ton
  peuvent être utilisés comme des motifs réguliers.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>int</info>       <strong>$shadingid</strong>  L'identifiant de ton créé précédemment avec <strong>ps_shading()</strong>.
  <info>string</info>    <strong>$optlist</strong>    Cet argument n'est pas utilisé présentement.

<comment>Return:</comment>
  <info>int|false</info>  L'identifiant du motif  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>ps_shading()</strong>
   * <strong>ps_shfill()</strong>


id: ps_shfill
type: function
doc:
<comment>Description:</comment>
  Remplit un espace avec un ton
  
  Remplit un espace avec un ton, qui doit être créé avant avec <strong>ps_shading()</strong>. Ceci est un moyen
  alternatif pour créer un motif à partir d'un ton venant de <strong>ps_shading_pattern()</strong> et d'utiliser le
  motif comme couleur de remplissage.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>      Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>int</info>       <strong>$shadingid</strong>  L'identifiant de ton créé précédemment avec <strong>ps_shading()</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>ps_shading()</strong>
   * <strong>ps_shading_pattern()</strong>


id: ps_show
type: function
doc:
<comment>Description:</comment>
  Écrit du texte
  
  Écrit du texte à la position courante du texte. La position du texte peut être fixée en mettant
  les positions des coordonnées x et y dans les valeurs <return>textx</return> et <return>texty</return> avec la fonction
  <strong>ps_set_value()</strong>. Cette fonction émettra une erreur si une police n'a été fixée auparavant avec
  <strong>ps_setfont()</strong>.
  
  <strong>ps_show()</strong> évalue les paramètres et les variables suivantes fixés par <strong>ps_set_parameter()</strong> et
  <strong>ps_set_value()</strong>.
  
  Distance entre deux glyphes consécutifs. Si cette valeur n'est pas égal à zéro, alors toutes les
  ligatures seront résolues. Les valeurs inférieures à zéro sont autorisées.
  
  Fixer ce paramètre à <info>false</info> désactivera le crénage. Le crénage est activé par défaut.
  
  Fixer ce paramètre à <info>false</info> désactivera l'utilisation des ligatures. Les ligatures sont activées
  par défaut.
  
  Fixer ce paramètre à <info>true</info> activera le soulignement. Le soulignement est désactivé par défaut.
  
  Fixer ce paramètre à <info>true</info> activera surlignement. Le surlignement est désactivé par défaut.
  
  Fixer ce paramètre à <info>true</info> activera le texte barré. Le texte barré est désactivé par défaut.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   Le texte à être affiché.

<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>ps_continue_text()</strong>
   * <strong>ps_show_xy()</strong>
   * <strong>ps_setfont()</strong>


id: ps_show2
type: function
doc:
<comment>Description:</comment>
  Affiche un texte à la position courante
  
  Affiche le texte à la position courante. N'affiche pas plus de <strong>$len</strong> caractères.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant de ressource d'un fichier postscript, tel que retourné par la
                    fonction <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   Le texte à afficher.
  <info>int</info>       <strong>$len</strong>    Le nombre maximal de caractères à afficher.

<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: ps_show_boxed
type: function
doc:
<comment>Description:</comment>
  Écriture de texte dans une boîte
  
  <strong>ps_show_boxed()</strong> écrit du texte dans une boîte donnée. Le coin inférieur gauche de la boîte est à
  (<strong>$left</strong>,  <strong>$bottom</strong>). Les coupures de ligne sera insérées où  nécessaires. Des espaces multiples sont
  traités comme une seule. Les  tabulations sont traitées comme des espaces.
  
  Le texte sera relié si le paramètre <strong>$hyphenation</strong> est fixé à <info>true</info> et le paramètre <strong>$hyphendict</strong>
  contient un fichier valide pour un fichier de liaison. L'espace des lignes est pris à partir de la
  valeur <strong>$leading</strong>. Les paragraphes peuvent être séparés par une ligne vide comme dans TeX. Si la
  valeur <strong>$parindent</strong> est fixée à une valeur &gt; 0.0, alors les premières n lignes seront indentées.
  Le nombre n de lignes est fixé par le paramètre <strong>$numindentlines</strong>. Afin de prévenir l'indentation
  des premiers m paragraphes, fixés la valeur <strong>$parindentskip</strong> à un nombre positif.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>       Identifiant d'un fichier PostScript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>        Le texte à être affiché dans la boîte donnée.
  <info>float</info>     <strong>$left</strong>        La position x du coin inférieur gauche de la boîte.
  <info>float</info>     <strong>$bottom</strong>      La position y du coin inférieur gauche de la boîte.
  <info>float</info>     <strong>$width</strong>       Largeur de la boîte.
  <info>float</info>     <strong>$height</strong>      Hauteur de la boîte.
  <info>string</info>    <strong>$hmode</strong>       Le paramètre <strong>$hmode</strong> peut être <return>justify</return>, <return>fulljustify</return>, <return>right</return>, <return>left</return>, ou <return>center</return>.
                         La différence entre <return>justify</return> et <return>fulljustify</return> affecte simplement la dernière
                         ligne de la boîte. Dans le mode <return>fulljustify</return>, la dernière ligne sera
                         justifiée de gauche à droite à moins que cela est aussi la dernière ligne
                         du paragraphe. Dans le mode <return>"justify"</return>, le texte sera toujours justifié à
                         gauche.
  <info>string</info>    <strong>$feature</strong>     
  <info></info>          <strong>$hyphendict</strong>  Fixé à <info>true</info> afin d'activer les liaisons. Cela requiert un dictionnaire fixé
                         par le paramètre <strong>$hyphendict</strong>. Par défaut, ce paramètre vaut <info>false</info>.

<comment>Return:</comment>
  <info>int</info>  Nombre de caractères qui ne peuvent être écrits.

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


id: ps_show_xy
type: function
doc:
<comment>Description:</comment>
  Écrit du texte à la position donnée
  
  Écrit du texte à la position de texte donnée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>   Le texte à être affiché.
  <info>float</info>     <strong>$x</strong>      La position x du coin inférieur droit de la boîte entourant le texte.
  <info>float</info>     <strong>$y</strong>      La position y du coin inférieur droit de la boîte entourant le texte.

<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>ps_continue_text()</strong>
   * <strong>ps_show()</strong>


id: ps_show_xy2
type: function
doc:
<comment>Description:</comment>
  Affiche un texte à la position
  
   Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<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: ps_string_geometry
type: function
doc:
<comment>Description:</comment>
  Récupère les géométries d'une chaîne de caractères
  
  <strong>ps_string_geometry()</strong> est similaire à  <strong>ps_stringwidth()</strong>, mais retourne un tableau des dimensions
  contenant la largeur, la hampe et le jambage du texte.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>    Le texte pour lequel la géométrie sera calculée.
  <info>int</info>       <strong>$fontid</strong>  L'identifiant de la police à être utilisée. Si aucune police n'est spécifiée,
                     la police courante sera utilisée.
  <info>float</info>     <strong>$size</strong>    La taille de la police. Si aucune taille n'est spécifiée, la taille courante
                     est utilisée.

<comment>Return:</comment>
  <info>array</info>  Un tableau des dimensions de la chaîne de caractères. L'élément <return>width</return> contient la largeur
         de la chaîne comme retournée par <strong>ps_stringwidth()</strong>. L'élément <return>descender</return> contient le maximum
         de jambage et <return>ascender</return> le maximum de la hampe de la chaîne de caractères.

<comment>See Also:</comment>
   * <strong>ps_continue_text()</strong>
   * <strong>ps_stringwidth()</strong>


id: ps_stringwidth
type: function
doc:
<comment>Description:</comment>
  Récupère la largeur d'une chaîne de caractères
  
  Calcule la largeur d'une chaîne de caractères en points si elle a été écrite dans la police et la
  taille donnée. Cette fonction requiert le fichier de police métrique "adobe" pour calculer la
  largeur précise. Si le crénage est activé, il sera pris en compte.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>string</info>    <strong>$text</strong>    Le texte pour lequel la largeur sera calculée.
  <info>int</info>       <strong>$fontid</strong>  L'identifiant de la police à être utilisée. Si aucune police n'est spécifiée,
                     la police courante sera utilisée.
  <info>float</info>     <strong>$size</strong>    La taille de la police. Si aucune taille n'est spécifiée, la taille courante
                     est utilisée.

<comment>Return:</comment>
  <info>float</info>  Largeur de la chaîne de caractères en points.

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


id: ps_stroke
type: function
doc:
<comment>Description:</comment>
  Dessine le chemin courant
  
  Dessine le chemin construit avec des fonctions de dessin comme <strong>ps_lineto()</strong> précédemment appelées.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</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>ps_closepath_stroke()</strong>
   * <strong>ps_fill()</strong>
   * <strong>ps_fill_stroke()</strong>


id: ps_symbol
type: function
doc:
<comment>Description:</comment>
  Écrit un glyphe
  
  Écrit un glyphe à la position <strong>$ord</strong> dans le vecteur d'encodage de la police de la police courante.
  L'encodage de la police pour une police peut être fixé lors du chargement de la police avec
  <strong>ps_findfont()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>    La position du glyphe dans le vecteur d'encodage de la police.

<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>ps_symbol_name()</strong>
   * <strong>ps_symbol_width()</strong>


id: ps_symbol_name
type: function
doc:
<comment>Description:</comment>
  Récupère le nom d'un glyphe
  
  Cette fonction nécessite le fichier de police métrique "adobe" pour savoir quels glyphes sont
  disponibles.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>     Le paramètre <strong>$ord</strong> est la position du glyphe dans le vecteur d'encodage de la
                     police.
  <info>int</info>       <strong>$fontid</strong>  L'identifiant de la police à être utilisée. Si aucune police n'est spécifiée,
                     la police courante sera utilisée.

<comment>Return:</comment>
  <info>string</info>  Le nom d'un glyphe dans la police donnée.

<comment>See Also:</comment>
   * <strong>ps_symbol()</strong>
   * <strong>ps_symbol_width()</strong>


id: ps_symbol_width
type: function
doc:
<comment>Description:</comment>
  Récupère la largeur d'un glyphe
  
  Calcule la largeur d'un glyphe en points s'il a été écrit dans la police et la taille donnée.
  Cette fonction nécessite le fichier de police métrique "adobe" pour calculer la largeur précise.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>   Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>int</info>       <strong>$ord</strong>     La position du glyphe dans le vecteur d'encodage de la police.
  <info>int</info>       <strong>$fontid</strong>  L'identifiant de la police à être utilisée. Si aucune police n'est spécifiée,
                     la police courante sera utilisée.
  <info>float</info>     <strong>$size</strong>    La taille de la police. Si aucune taille n'est spécifiée, la taille courante
                     est utilisée.

<comment>Return:</comment>
  <info>float</info>  La largeur d'un glyphe en points.

<comment>See Also:</comment>
   * <strong>ps_symbol()</strong>
   * <strong>ps_symbol_name()</strong>


id: ps_translate
type: function
doc:
<comment>Description:</comment>
  Fixe une translation
  
  Fixe un nouveau point initial d'un système de coordonnées.

<comment>Param:</comment>
  <info>resource</info>  <strong>$psdoc</strong>  Identifiant d'un fichier postscript retourné par <strong>ps_new()</strong>.
  <info>float</info>     <strong>$x</strong>      La position x de l'origine du système de coordonnées translaté.
  <info>float</info>     <strong>$y</strong>      La position y de l'origine du système de coordonnées translaté.

<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>ps_scale()</strong>
   * <strong>ps_rotate()</strong>


id: pspell_add_to_personal
type: function
doc:
<comment>Description:</comment>
  Ajoute le mot au dictionnaire personnel
  
  <strong>pspell_add_to_personal()</strong> ajoute un mot au dictionnaire personnel. Si vous utilisez
  <strong>pspell_new_config()</strong> avec <strong>pspell_config_personal()</strong> pour ouvrir le dictionnaire, vous pourrez sauver
  le dictionnaire personnel ultérieurement avec <strong>pspell_save_wordlist()</strong>.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Une instance de <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        Le Mot ajouté.

<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: pspell_add_to_session
type: function
doc:
<comment>Description:</comment>
  Ajoute le mot au dictionnaire personnel de la session courante
  
  <strong>pspell_add_to_session()</strong> ajoute un mot au dictionnaire personnel associé à la version courante.
  C'est une fonction similaire à <strong>pspell_add_to_personal()</strong>.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Une instance de <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        Le mot ajouté.

<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: pspell_check
type: function
doc:
<comment>Description:</comment>
  Vérifie un mot
  
  <strong>pspell_check()</strong> vérifie l'orthographe d'un mot.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Une instance de <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        Le mot testé.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si l'orthographe est correcte, <info>false</info> sinon.


id: pspell_clear_session
type: function
doc:
<comment>Description:</comment>
  Remet à zéro la session courante
  
  <strong>pspell_clear_session()</strong> remet à zéro la session courante. Le dictionnaire personnel est vidé et,
  par exemple, si vous tentez de l'enregistrer avec <strong>pspell_save_wordlist()</strong>, rien ne se passera.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Une instance de <class>PSpell\Dictionary</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.


id: pspell_config_create
type: function
doc:
<comment>Description:</comment>
  Crée une configuration utilisée pour ouvrir un dictionnaire
  
  Crée une configuration utilisée pour ouvrir un dictionnaire.
  
  <strong>pspell_config_create()</strong> a une syntaxe similaire à celle de <strong>pspell_new()</strong>. En fait, utiliser
  <strong>pspell_config_create()</strong> suivi immédiatement par <strong>pspell_new_config()</strong> produira exactement le même
  résultat. Cependant, après avoir créé une nouvelle configuration, vous pouvez aussi utiliser les
  fonctions <strong>pspell_config_*()</strong>  avant d'appeler  <strong>pspell_new_config()</strong> pour tirer profit des
  fonctionnalités avancées.
  
  Pour davantage d'information et d'exemples, jetez un oeil au manuel en ligne sur le site de pspell
  : http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$language</strong>  Le paramètre de langage <strong>$language</strong> est le code  de langue en deux lettres,
                     défini dans la norme ISO 639, et deux lettres optionnelles ISO 3166, après un
                     tiret ou un souligné (_).
  <info>string</info>  <strong>$spelling</strong>  Le paramètre d'orthographe <strong>$spelling</strong> est nécessaire pour les langues qui ont
                     plus d'une orthographe, comme l'anglais. Les valeurs reconnues sont alors
                     'american' (américain) , 'british' (anglais), et 'canadian' (canadien).
  <info>string</info>  <strong>$jargon</strong>    Le paramètre de jargon <strong>$jargon</strong> contient des informations supplémentaires pour
                     distinguer deux dictionnaires distincts pour la même langue et le même
                     paramètre d'orthographe <strong>$spelling</strong>.
  <info>string</info>  <strong>$encoding</strong>  Le paramètre d'encodage <strong>$encoding</strong> indique  l'encodage attendu pour la réponse.
                     Les valeurs valides sont : 'utf-8', 'iso8859-*', 'koi8-r', 'viscii', 'cp1252',
                     'machine unsigned 16', 'machine unsigned 32'. Ce paramètre n'a pas été testé de
                     manière exhaustive, alors soyez prudent.

<comment>Return:</comment>
  <info>PSpell\Config</info>  Retourne une instance de <class>PSpell\Config</class>.


id: pspell_config_data_dir
type: function
doc:
<comment>Description:</comment>
  Dossier qui contient les fichiers de données linguistiques
  
   Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<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: pspell_config_dict_dir
type: function
doc:
<comment>Description:</comment>
  Endroit où se trouve le fichier global des mots
  
   Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<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: pspell_config_ignore
type: function
doc:
<comment>Description:</comment>
  Ignore les mots de moins de N caractères
  
  <strong>pspell_config_ignore()</strong> doit être utilisée avec une configuration avant d'appeler
  <strong>pspell_new_config()</strong>. Cette fonction permet au vérificateur d'ignorer les mots courts.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>      Une instance de <class>PSpell\Config</class>.
  <info>int</info>            <strong>$min_length</strong>  Les mots de moins de <strong>$min_length</strong> caractères seront ignorés.

<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: pspell_config_mode
type: function
doc:
<comment>Description:</comment>
  Change le mode de suggestion
  
  <strong>pspell_config_mode()</strong> doit être appelée dans une configuration avant <strong>pspell_new_config()</strong>. Cette
  fonction détermine le nombre de suggestions qui seront retournées par <strong>pspell_suggest()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Une instance de <class>PSpell\Config</class>.
  <info>int</info>            <strong>$mode</strong>    Le paramètre de mode est le mode de travail du vérificateur d'orthographe.
                          Plusieurs modes sont disponibles : <info>PSPELL_FAST</info> - Mode rapide (moins de
                          suggestions) <info>PSPELL_NORMAL</info> - Mode normal (plus de suggestions)
                          <info>PSPELL_BAD_SPELLERS</info> - Mode lent (beaucoup plus de  suggestions)
                          
                          <info>PSPELL_FAST</info> - Mode rapide (moins de  suggestions)
                          
                          <info>PSPELL_NORMAL</info> - Mode normal (plus de suggestions)
                          
                          <info>PSPELL_BAD_SPELLERS</info> - Mode lent (beaucoup plus de  suggestions)

<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: pspell_config_personal
type: function
doc:
<comment>Description:</comment>
  Choisit le fichier qui contient le dictionnaire personnel
  
  Choisit le fichier qui contient le dictionnaire personnel. Le dictionnaire personnel sera  chargé
  et utilisé en plus du dictionnaire standard, une fois que vous aurez appelé  <strong>pspell_new_config()</strong>.
  Le fichier est aussi là où <strong>pspell_save_wordlist()</strong> sauvegardera le dictionnaire personnel.
  
  <strong>pspell_config_personal()</strong> doit être appelée dans une configuration avant d'appeler
  <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>    Une instance de <class>PSpell\Config</class>.
  <info>string</info>         <strong>$filename</strong>  Le dictionnaire personnel. Si le fichier n'existe pas, il sera créé. Le
                            fichier doit être accessible en écriture pour l'utilisateur invoquant
                            PHP (ex. nobody).

<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: pspell_config_repl
type: function
doc:
<comment>Description:</comment>
  Choisit le fichier qui contient les paires de remplacement
  
  Choisit le fichier qui contient les paires de remplacement.
  
  Les paires de remplacement améliorent la qualité du vérificateur. Lorsqu'un mot  est mal
  orthographié et qu'aucune suggestion valable n'est trouvée dans le dictionnaire,
  <strong>pspell_store_replacement()</strong> sera utilisée pour enregistrer une  paire de remplacement et
  <strong>pspell_save_wordlist()</strong> pour  sauver le dictionnaire avec les paires de remplacement.
  
  <strong>pspell_config_repl()</strong> doit être utilisé avec une configuration avant d'appeler <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>    Une instance de <class>PSpell\Config</class>.
  <info>string</info>         <strong>$filename</strong>  Le fichier doit être accessible en écriture pour l'utilisateur invoquant
                            PHP (ex. nobody).

<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: pspell_config_runtogether
type: function
doc:
<comment>Description:</comment>
  Considère deux mots accolés comme un composé
  
  Cette fonction indique si deux mots accolés doivent être traités comme un composé valide. Ainsi
  "lechat" sera traité comme un composé valide bien qu'il devrait y avoir un espace entre ces deux
  mots. Modifier cette configuration n'affecte que les résultats retournés par <strong>pspell_check()</strong>;
  <strong>pspell_suggest()</strong> retournera toujours des suggestions.
  
  <strong>pspell_config_runtogether()</strong> doit être appelée dans une configuration avant <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Une instance de <class>PSpell\Config</class>.
  <info>bool</info>           <strong>$allow</strong>   <info>true</info> si deux mots accolés doivent être traités comme un composé valide,
                          <info>false</info> sinon.

<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: pspell_config_save_repl
type: function
doc:
<comment>Description:</comment>
  Détermine s'il faut sauver les paires de remplacement
    avec le dictionnaire
  
  <strong>pspell_config_save_repl()</strong> détermine si  <strong>pspell_save_wordlist()</strong> doit sauver  les paires de
  remplacement  avec le dictionnaire. Généralement, il n'y a pas besoin d'utiliser cette fonction
  car, si <strong>pspell_config_repl()</strong> est utilisée, les paires de remplacement seront sauvées de toute
  façon par <strong>pspell_save_wordlist()</strong>, et, si ce n'est pas le cas,  elles ne le seront pas.
  
  <strong>pspell_config_save_repl()</strong> doit être appelée dans une configuration avant d'appeler
  <strong>pspell_new_config()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Une instance de <class>PSpell\Config</class>.
  <info>bool</info>           <strong>$save</strong>    <info>true</info> si les paires de remplacement doivent être sauvées, <info>false</info> sinon.

<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: pspell_new
type: function
doc:
<comment>Description:</comment>
  Charge un nouveau dictionnaire
  
  <strong>pspell_new()</strong> ouvre un nouveau dictionnaire et retourne un instance de <class>PSpell\Dictionary</class>, pour être
  utilisé avec d'autres fonctions pspell.
  
  Pour plus d'informations et d'exemples, reportez-vous au site http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$language</strong>  Le paramètre de langue <strong>$spelling</strong> est constitué des  deux lettres du codage de
                     langue ISO 639, et du codage optionnel de pays ISO  3166, séparés par un '_'.
  <info>string</info>  <strong>$spelling</strong>  Ce paramètre est nécessaire pour les langues qui ont plus d'une orthographe,
                     comme l'anglais ou le français.  Les valeurs reconnues sont  'american',
                     'british', et 'canadian'.
  <info>string</info>  <strong>$jargon</strong>    Le paramètre <strong>$jargon</strong> contient des informations supplémentaires pour distinguer
                     deux listes de mots qui ont le même marquage de langue et d'orthographe.
  <info>string</info>  <strong>$encoding</strong>  Le paramètre <strong>$encoding</strong> est le type d'encodage des mots. Les valeurs valides
                     sont 'utf-8', 'iso8859-*', 'koi8-r', 'viscii', 'cp1252', 'machine unsigned 16',
                     'machine unsigned 32'. Ce paramètre n'ayant pas été testé de  façon exhaustive,
                     il convient d'être prudent lors de son  utilisation.
  <info>int</info>     <strong>$mode</strong>      Le paramètre <strong>$mode</strong> est le mode de travail du vérificateur d'orthographe.
                     Plusieurs modes sont disponibles : <info>PSPELL_FAST</info> - Mode rapide (moins de
                     suggestions) <info>PSPELL_NORMAL</info> - Mode normal (plus de suggestions)
                     <info>PSPELL_BAD_SPELLERS</info> - Mode lent (beaucoup plus de  suggestions)
                     <info>PSPELL_RUN_TOGETHER</info> - Considère que des mots accolés forment un composé
                     autorisé. Ainsi, "lechat" sera un composé valide. Cette option ne modifie que
                     les résultats retournés par <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong>  retournera
                     toujours des suggestions.  <strong>$mode</strong> est un masque construit à partir des
                     constantes  listées ci-dessus. Cependant, <info>PSPELL_FAST</info>, <info>PSPELL_NORMAL</info> et
                     <info>PSPELL_BAD_SPELLERS</info> sont mutuellement exclusives :  vous ne devez en utiliser à
                     la fois.
                     
                     <info>PSPELL_FAST</info> - Mode rapide (moins de  suggestions)
                     
                     <info>PSPELL_NORMAL</info> - Mode normal (plus de suggestions)
                     
                     <info>PSPELL_BAD_SPELLERS</info> - Mode lent (beaucoup plus de  suggestions)
                     
                     <info>PSPELL_RUN_TOGETHER</info> - Considère que des mots accolés forment un composé
                     autorisé. Ainsi, "lechat" sera un composé valide. Cette option ne modifie que
                     les résultats retournés par <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong>  retournera
                     toujours des suggestions.

<comment>Return:</comment>
  <info>PSpell\Dictionary|false</info>  Retourne une instance de <class>PSpell\Dictionary</class> en cas de succès, ou <info>false</info> si
                           une erreur survient.


id: pspell_new_config
type: function
doc:
<comment>Description:</comment>
  Charge un nouveau dictionnaire avec les paramètres spécifiés dans une configuration
    
  
  <strong>pspell_new_config()</strong> ouvre un nouveau dictionnaire avec  les paramétrages de la configuration
  <strong>$config</strong>, créée avec <strong>pspell_config_create()</strong> et modifiée avec les fonctions  <strong>pspell_config_*()</strong>.
  Cette méthode vous donne le maximum de flexibilité, et dispose de toutes les fonctionnalités
  fournies par  <strong>pspell_new()</strong> et <strong>pspell_new_personal()</strong>.

<comment>Param:</comment>
  <info>PSpell\Config</info>  <strong>$config</strong>  Le <strong>$config</strong> est celui qui est retourné par <strong>pspell_config_create()</strong> lorsque
                          la configuration est créée.

<comment>Return:</comment>
  <info>PSpell\Dictionary|false</info>  Retourne une instance de <class>PSpell\Dictionary</class> en cas de succès,  ou <info>false</info> si
                           une erreur survient


id: pspell_new_personal
type: function
doc:
<comment>Description:</comment>
  Charge un nouveau dictionnaire avec un dictionnaire personnel
  
  <strong>pspell_new_personal()</strong> charge un nouveau dictionnaire avec un dictionnaire personnel. Ce dernier
  peut être modifié et sauvé avec <strong>pspell_save_wordlist()</strong>. Cependant, les paires de remplacement ne
  seront pas sauvées. Pour ce faire, vous devez créer une configuration qui utilise
  <strong>pspell_config_create()</strong>, choisir le fichier de destination du dictionnaire personnel avec
  <strong>pspell_config_personal()</strong>, choisir le fichier de paires de remplacement avec  <strong>pspell_config_repl()</strong>
  et ouvrir un nouveau dictionnaire avec  <strong>pspell_new_config()</strong>.
  
  Pour davantage d'information et d'exemples, jetez un oeil sur le manuel en ligne sur le site web
  de pspell : http://aspell.net/.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le fichier où seront ajoutés les mots du dictionnaire personnel.  Ce doit être
                     un chemin absolu, qui commence par '/' car, sinon,  il sera relatif à $HOME,
                     qui est "/root" sur la plupart des systèmes, et  probablement pas ce que vous
                     souhaitez.
  <info>string</info>  <strong>$language</strong>  Le paramètre de langage <strong>$language</strong> est le  code de langue ISO 639 en deux
                     lettres, suivi de deux lettres optionnelles ISO 3166, après un tiret ou un
                     souligné (_).
  <info>string</info>  <strong>$spelling</strong>  Le paramètre d'orthographe <strong>$spelling</strong> est nécessaire pour les langues qui ont
                     plus d'une orthographe, comme l'anglais. Les valeurs reconnues sont alors
                     'american' (américain) , 'british' (anglais), et 'canadian' (canadien).
  <info>string</info>  <strong>$jargon</strong>    Informations supplémentaires pour distinguer deux dictionnaires distincts pour
                     la même langue et le même paramètre d'orthographe <strong>$spelling</strong>.
  <info>string</info>  <strong>$encoding</strong>  L'encodage attendu pour la réponse. Les valeurs valides sont : <return>utf-8</return>,
                     <return>iso8859-*</return>,  <return>koi8-r</return>, <return>viscii</return>,  <return>cp1252</return>, <return>machine unsigned 16</return>,  <return>machine unsigned 32</return>.
  <info>int</info>     <strong>$mode</strong>      Le mode de travail du vérificateur d'orthographe. Plusieurs modes sont
                     disponibles : <info>PSPELL_FAST</info> - Mode rapide (moins de  suggestions) <info>PSPELL_NORMAL</info> -
                     Mode normal (plus de suggestions) <info>PSPELL_BAD_SPELLERS</info> -  Mode lent (beaucoup
                     plus de  suggestions) <info>PSPELL_RUN_TOGETHER</info> - Considère les mots attachés comme
                     légaux. De ce fait, "lechat" sera un mot composé légal, bien qu'il devrait y
                     avoir un espace entre les deux mots. Changer cette configuration n'affecte que
                     le résultat retourné par  <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong> continuera de
                     retourner les suggestions.  Le mode est un masque construit depuis les
                     différentes constantes listées ci-dessous.  Cependant, les constantes
                     <info>PSPELL_FAST</info>, <info>PSPELL_NORMAL</info> et <info>PSPELL_BAD_SPELLERS</info> sont mutuellement exclusives,
                     donc vous ne devez sélectionner qu'une seule d'entre elles.
                     
                     <info>PSPELL_FAST</info> - Mode rapide (moins de  suggestions)
                     
                     <info>PSPELL_NORMAL</info> - Mode normal (plus de suggestions)
                     
                     <info>PSPELL_BAD_SPELLERS</info> -  Mode lent (beaucoup plus de  suggestions)
                     
                     <info>PSPELL_RUN_TOGETHER</info> - Considère les mots attachés comme légaux. De ce fait,
                     "lechat" sera un mot composé légal, bien qu'il devrait y avoir un espace entre
                     les deux mots. Changer cette configuration n'affecte que le résultat retourné
                     par  <strong>pspell_check()</strong>; <strong>pspell_suggest()</strong> continuera de retourner les suggestions.

<comment>Return:</comment>
  <info>PSpell\Dictionary|false</info>  Retourne une instance de <class>PSpell\Dictionary</class> en cas de succès, ou <info>false</info> si
                           une erreur survient.


id: pspell_save_wordlist
type: function
doc:
<comment>Description:</comment>
  Sauve le dictionnaire personnel dans un fichier
  
  <strong>pspell_save_wordlist()</strong> sauve le dictionnaire personnel de la session courante. La localisation des
  fichiers doit avoir été spécifiée avec <strong>pspell_config_personal()</strong> et (éventuellement)
  <strong>pspell_config_repl()</strong>.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Une instance de <class>PSpell\Dictionary</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.


id: pspell_store_replacement
type: function
doc:
<comment>Description:</comment>
  Enregistre une paire de remplacement pour un mot
  
  <strong>pspell_store_replacement()</strong> enregistre une paire de remplacement pour  un mot de façon à ce que
  cette suggestion soit retournée par  <strong>pspell_suggest()</strong> plus tard. Pour pouvoir utiliser cette
  fonction,  vous devez utiliser <strong>pspell_new_personal()</strong> pour ouvrir le dictionnaire. Pour pouvoir
  sauver tout le temps les paires de remplacement, vous devez utiliser <strong>pspell_config_personal()</strong> et
  <strong>pspell_config_repl()</strong> pour indiquer le lieu de sauvegarde des dictionnaires personnels, et
  <strong>pspell_save_wordlist()</strong>  pour enregistrer les modifications sur le disque.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Une instance de <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$misspelled</strong>  Le mot mal orthographié.
  <info>string</info>             <strong>$correct</strong>     La bonne orthographe du mot <strong>$misspelled</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: pspell_suggest
type: function
doc:
<comment>Description:</comment>
  Suggère l'orthographe d'un mot
  
  <strong>pspell_suggest()</strong> retourne un tableau de suggestions pour le mot <strong>$word</strong>.

<comment>Param:</comment>
  <info>PSpell\Dictionary</info>  <strong>$dictionary</strong>  Une instance de <class>PSpell\Dictionary</class>.
  <info>string</info>             <strong>$word</strong>        Le mot testé.

<comment>Return:</comment>
  <info>array|false</info>  Retourne un tableau de suggestions pour le mot <strong>$word</strong>.


id: putenv
type: function
doc:
<comment>Description:</comment>
  Fixe la valeur d'une variable d'environnement
  
  Ajoute <strong>$assignment</strong> à l'environnement serveur. Cette valeur n'existera que durant la vie de la
  requête courante, et l'environnement initial sera restauré lorsque le script sera terminé.

<comment>Param:</comment>
  <info>string</info>  <strong>$assignment</strong>  La configuration, comme <return>"FOO=BAR"</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>getenv()</strong>
   * <strong>apache_setenv()</strong>


id: quoted_printable_decode
type: function
doc:
<comment>Description:</comment>
  Convertit une chaîne quoted-printable en chaîne 8 bits
  
  <strong>quoted_printable_decode()</strong> retourne la chaîne de caractères <strong>$str</strong>, après l'avoir convertie du format
  <return>quoted printable</return> binaire 8 bits (en accord avec la RFC2045, section 6.7, et non pas la RFC2821,
  section 4.5.2, pour que les virgules additionnelles ne soient pas effacée du début de la ligne).
  
  Cette fonction est similaire à <strong>imap_qprint()</strong>, hormis le fait qu'elle n'exige pas le module IMAP
  pour fonctionner.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  La chaîne d'entrée.

<comment>Return:</comment>
  <info>string</info>  Retourne la chaîne, convertie au format 8-bits.

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


id: quoted_printable_encode
type: function
doc:
<comment>Description:</comment>
  Convertit une chaîne 8 bits en une chaîne quoted-printable
  
  Retourne une chaîne quoted printable créée suivant les règles de  RFC2045, section 6.7.
  
  Cette fonction est similaire à <strong>imap_8bit()</strong>, sauf qu'elle ne requiert pas de module IMAP pour
  fonctionner.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  La chaîne à traiter.

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

<comment>See Also:</comment>
   * <strong>quoted_printable_decode()</strong>
   * <strong>iconv_mime_encode()</strong>


id: quotemeta
type: function
doc:
<comment>Description:</comment>
  Protège les métacaractères
  
  Retourne la chaîne <strong>$str</strong> après avoir introduit un antislash (<return>\</return>) devant tous les caractères suivants
  : . \ + * ? [ ^ ] ( $ )

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  La chaîne d'entrée.

<comment>Return:</comment>
  <info>string</info>  Retourne la chaîne dont les métacaractères ont été protégés ou <info>false</info> si une chaîne vide
          est fournie dans le paramètre <strong>$string</strong>.

<comment>See Also:</comment>
   * <strong>addslashes()</strong>
   * <strong>addcslashes()</strong>
   * <strong>htmlentities()</strong>
   * <strong>htmlspecialchars()</strong>
   * <strong>nl2br()</strong>
   * <strong>stripslashes()</strong>
   * <strong>stripcslashes()</strong>
   * <strong>preg_quote()</strong>


id: rad2deg
type: function
doc:
<comment>Description:</comment>
  Conversion de radians en degrés
  
  Convertit <strong>$num</strong> (supposé en radians) en degrés.

<comment>Param:</comment>
  <info>float</info>  <strong>$num</strong>  Une valeur, en radians

<comment>Return:</comment>
  <info>float</info>  L'équivalent de <strong>$num</strong>, en degrés.

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


id: radius_acct_open
type: function
doc:
<comment>Description:</comment>
  Crée une ressource Radius pour les comptes

<comment>Return:</comment>
  <info>resource</info>  Retourne une ressource en cas de succès ou <info>false</info> si une erreur survient. Cette fonction
            n'échoue que s'il y a un manque de mémoire.


id: radius_add_server
type: function
doc:
<comment>Description:</comment>
  Ajoute un serveur
  
  <strong>radius_add_server()</strong> peut être utilisé plusieurs fois, et il peut être utilisé avec la fonction
  <strong>radius_config()</strong>. Tout au plus, 10 serveurs peuvent être spécifiés. Lorsque plusieurs serveurs sont
  fournis, ils sont essayés à la façon <return>round-robin</return> tant qu'une réponse valide n'est pas reçue, ou
  tant que la limite <strong>$max_tries</strong> de chaque serveur n'est pas atteinte.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  
  <info>string</info>    <strong>$hostname</strong>       Le paramètre <strong>$hostname</strong> spécifie l'hôte serveur, soit en tant que nom de
                            domaine qualifié, soit en tant qu'adresse IP.
  <info>int</info>       <strong>$port</strong>           Le <strong>$port</strong> spécifie le port UDP à contacter sur le serveur. Si le port
                            donné vaut <return>0</return>, la bibliothèque recherchera le service radius/udp ou
                            radacct/udp dans la base de données des services du réseau et utilisera
                            le port s'y trouvant. Si aucune entrée n'est trouvée, la bibliothèque
                            utilisera les ports Radius standards, 1812 pour l'identification et 1813
                            pour les comptes.
  <info>string</info>    <strong>$secret</strong>         Le secret partagé pour l'hôte serveur est passé au paramètre <strong>$secret</strong>. Le
                            protocole Radius ignore tout mais garde les 128 premiers octets du
                            secret partagé.
  <info>int</info>       <strong>$timeout</strong>        Le délai limite pour recevoir les réponses du serveur est passé au
                            paramètre <strong>$timeout</strong>, sous la forme de seconde.
  <info>int</info>       <strong>$max_tries</strong>      Le nombre maximal de requêtes répétées à faire avant d'échouer.

<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>radius_config()</strong>


id: radius_auth_open
type: function
doc:
<comment>Description:</comment>
  Crée une ressource Radius pour l'identification

<comment>Return:</comment>
  <info>resource</info>  Retourne une ressource en cas de succès ou <info>false</info> si une erreur survient. Cette fonction
            n'échoue que s'il y a un manque de mémoire.


id: radius_close
type: function
doc:
<comment>Description:</comment>
  Libère toutes les ressources Radius
  
  Il n'est pas nécessaire d'appeler cette fonction car PHP libère toutes les ressources à la fin de
  chaque demande.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.

<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: radius_config
type: function
doc:
<comment>Description:</comment>
  Demande à la bibliothèque de lire un fichier de configuration donné
  
  Avant toute demande Radius, la bibliothèque doit connaître le serveur à contacter. La manière
  simple de configurer la bibliothèque est d'appeler la fonction <strong>radius_config()</strong>. <strong>radius_config()</strong>
  demande à la bibliothèque de lire un fichier de configuration dont le format est décrit sur la
  page radius.conf.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  
  <info>string</info>    <strong>$file</strong>           Le chemin vers le fichier de configuration est passé en tant qu'argument
                            à la fonction <strong>radius_config()</strong>. La bibliothèque peut également être
                            configurée en appelant la fonction <strong>radius_add_server()</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>radius_add_server()</strong>


id: radius_create_request
type: function
doc:
<comment>Description:</comment>
  Crée une demande de compte ou d'identification
  
  Une demande Radius consiste en du code spécifiant une demande spécifique, ainsi que zéro ou
  plusieurs attributs qui fournissent des informations supplémentaires. Pour commencer à construire
  une nouvelle demande, appelez la fonction <strong>radius_create_request()</strong>.
  
  Attention : Vous devez appeler cette fonction avant de passer n'importe quel argument !

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  
  <info>int</info>       <strong>$type</strong>           Le type est <info>RADIUS_ACCESS_REQUEST</info> ou <info>RADIUS_ACCOUNTING_REQUEST</info>.

<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>radius_send_request()</strong>


id: radius_cvt_addr
type: function
doc:
<comment>Description:</comment>
  Convertit des données brutes en adresse IP
  
  Convertie des données brutes en adresse IP

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Données d'entrée

<comment>Return:</comment>
  <info>string</info>  Retourne l'adresse IP.

<comment>See Also:</comment>
   * <strong>radius_cvt_int()</strong>
   * <strong>radius_cvt_string()</strong>


id: radius_cvt_int
type: function
doc:
<comment>Description:</comment>
  Convertit des données brutes en entier
  
  Convertie des données brutes en entier

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Données d'entrée.

<comment>Return:</comment>
  <info>int</info>  Retourne l'entier, récupéré depuis les données.

<comment>See Also:</comment>
   * <strong>radius_cvt_addr()</strong>
   * <strong>radius_cvt_string()</strong>


id: radius_cvt_string
type: function
doc:
<comment>Description:</comment>
  Convertit des données brutes en chaîne de caractères
  
  Convertit des données brutes en chaîne de caractères

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Données d'entrée

<comment>Return:</comment>
  <info>string</info>  Retourne la chaîne, récupéré depuis les données.

<comment>See Also:</comment>
   * <strong>radius_cvt_addr()</strong>
   * <strong>radius_cvt_int()</strong>


id: radius_demangle
type: function
doc:
<comment>Description:</comment>
  Assèche des données
  
  Quelques données (mots de passe, clés MS-CHAPv1 MPPE) sont "séchées" pour des raisons de sécurité
  et doivent être "asséchées" avant de pouvoir les utiliser.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.
  <info>string</info>    <strong>$mangled</strong>        Les données déformés à déchiffrer

<comment>Return:</comment>
  <info>string</info>  Retourne la chaîne "asséchées" ou <info>false</info> si une erreur survient.


id: radius_demangle_mppe_key
type: function
doc:
<comment>Description:</comment>
  Dérive les clés mppe depuis des données
  
  Lors de l'utilisation de MPPE avec MS-CHAPv2, les clés reçues et envoyées sont "séchées" (voir la
  RFC 2548), cependant, cette fonction est utile, car je ne sais pas s'il y a ou pas une
  implémentation de PPTP-MPPE dans PHP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.
  <info>string</info>    <strong>$mangled</strong>        Les données déformés à déchiffrer

<comment>Return:</comment>
  <info>string</info>  Retourne la chaîne ou <info>false</info> si une erreur survient.


id: radius_get_attr
type: function
doc:
<comment>Description:</comment>
  Extrait un attribut
  
  Comme les demandes Radius, chaque réponse doit contenir zéro ou plusieurs attributs. Après la
  réception d'une réponse avec succès par la fonction <strong>radius_send_request()</strong>, ces attributs peuvent
  être extraits un par un en utilisant la fonction <strong>radius_get_attr()</strong>. À chaque appel de
  <strong>radius_get_attr()</strong>, le prochain attribut est récupéré depuis la réponse courante.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.

<comment>Return:</comment>
  <info>mixed</info>  Retourne un tableau associatif contenant le type de l'attribut ainsi que les données ou un
         numéro d'erreur \<= 0.

<comment>See Also:</comment>
   * <strong>radius_put_attr()</strong>
   * <strong>radius_get_vendor_attr()</strong>
   * <strong>radius_put_vendor_attr()</strong>
   * <strong>radius_send_request()</strong>


id: radius_get_tagged_attr_data
type: function
doc:
<comment>Description:</comment>
  Extrait les données d'un attribut
  
  Si un attribut contenant un tag a été retourné depuis la fonction <strong>radius_get_attr()</strong>,
  <strong>radius_get_tagged_attr_data()</strong> va retourner les données depuis cet attribut.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  L'attribut contenant un tag à décoder.

<comment>Return:</comment>
  <info>string|false</info>  Retourne les données de l'attribut ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>radius_get_attr()</strong>
   * <strong>radius_get_tagged_attr_tag()</strong>


id: radius_get_tagged_attr_tag
type: function
doc:
<comment>Description:</comment>
  Extrait le tag depuis un attribut
  
  Si un attribut contenant un tag a été retourné depuis la fonction <strong>radius_get_attr()</strong>,
  <strong>radius_get_tagged_attr_data()</strong> va retourner le tag depuis l'attribut.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  L'attribut à décoder.

<comment>Return:</comment>
  <info>int|false</info>  Retourne le tag depuis l'attribut  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>radius_get_attr()</strong>
   * <strong>radius_get_tagged_attr_data()</strong>


id: radius_get_vendor_attr
type: function
doc:
<comment>Description:</comment>
  Extrait un attribut spécifique au vendeur
  
  Si <strong>radius_get_attr()</strong> retourne <info>RADIUS_VENDOR_SPECIFIC</info>, <strong>radius_get_vendor_attr()</strong> peut être appelé
  pour déterminer le vendeur.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Données d'entrée.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau associatif contenant le type de l'attribut, le vendeur ainsi que les
         données, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>radius_get_attr()</strong>
   * <strong>radius_put_vendor_attr()</strong>


id: radius_put_addr
type: function
doc:
<comment>Description:</comment>
  Attache une adresse IP en tant qu'attribut
  
  Attache une adresse IP à la requête RADIUS courante.
  
  Une requête doit être créée via la fonction <strong>radius_create_request()</strong> avant que cette fonction
  puisse être appelée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.
  <info>int</info>       <strong>$type</strong>           Le type d'attribut.
  <info>string</info>    <strong>$addr</strong>           Une adresse IPv4 ; par exemple <return>10.0.0.1</return>.
  <info>int</info>       <strong>$options</strong>        Un masqe d'options d'attribut. Les options disponibles incluent
                            <info>RADIUS_OPTION_TAGGED</info> et <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            L'attribut tag. Ce paramètre est ignoré tant que l'option
                            <info>RADIUS_OPTION_TAGGED</info> est défini.

<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: radius_put_attr
type: function
doc:
<comment>Description:</comment>
  Attache un attribut binaire
  
  Attache un attribut binaire à la requête RADIUS courante.
  
  Une requête doit être créée via la fonction <strong>radius_create_request()</strong> avant que cette fonction
  puisse être appelée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.
  <info>int</info>       <strong>$type</strong>           Le type d'attribut.
  <info>string</info>    <strong>$value</strong>          La valeur de l'attribut, qui sera traité comme une chaîne binaire brûte.
  <info>int</info>       <strong>$options</strong>        Un masqe d'options d'attribut. Les options disponibles incluent
                            <info>RADIUS_OPTION_TAGGED</info> et <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            L'attribut tag. Ce paramètre est ignoré tant que l'option
                            <info>RADIUS_OPTION_TAGGED</info> est défini.

<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>radius_get_attr()</strong>
   * <strong>radius_get_vendor_attr()</strong>
   * <strong>radius_put_vendor_attr()</strong>


id: radius_put_int
type: function
doc:
<comment>Description:</comment>
  Attache un attribut entier
  
  Attache un attribut entier à la requête RADIUS courante.
  
  Une requête doit être créée via la fonction <strong>radius_create_request()</strong> avant que cette fonction
  puisse être appelée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.
  <info>int</info>       <strong>$type</strong>           Le type d'attribut.
  <info>int</info>       <strong>$value</strong>          La valeur de l'attribut.
  <info>int</info>       <strong>$options</strong>        Un masqe d'options d'attribut. Les options disponibles incluent
                            <info>RADIUS_OPTION_TAGGED</info> et <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            L'attribut tag. Ce paramètre est ignoré tant que l'option
                            <info>RADIUS_OPTION_TAGGED</info> est défini.

<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>radius_put_string()</strong>
   * <strong>radius_put_vendor_int()</strong>
   * <strong>radius_put_vendor_string()</strong>


id: radius_put_string
type: function
doc:
<comment>Description:</comment>
  Attache un attribut chaîne de caractères
  
  Attache un attribut sous forme de chaîne à la requête RADIUS courante. En général, la fonction
  <strong>radius_put_attr()</strong> est plus utile pour cela, car elle est sécurisé au niveau binaire.
  
  Une requête doit être créée via la fonction <strong>radius_create_request()</strong> avant que cette fonction
  puisse être appelée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.
  <info>int</info>       <strong>$type</strong>           Le type d'attribut.
  <info>string</info>    <strong>$value</strong>          La valeur de l'attribut. Cette valeur est attendue par la bibliothèque
                            sous-jacente comme devant se terminer par <info>null</info> ; aussi, ce paramètre
                            n'est pas sécurisé binairement.
  <info>int</info>       <strong>$options</strong>        Un masqe d'options d'attribut. Les options disponibles incluent
                            <info>RADIUS_OPTION_TAGGED</info> et <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            L'attribut tag. Ce paramètre est ignoré tant que l'option
                            <info>RADIUS_OPTION_TAGGED</info> est défini.

<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>radius_put_int()</strong>
   * <strong>radius_put_vendor_int()</strong>
   * <strong>radius_put_vendor_string()</strong>


id: radius_put_vendor_addr
type: function
doc:
<comment>Description:</comment>
  Attache une adresse IP spécifique à un vendeur
  
  Attache une adresse IP spécifique au vendeur pour la requête RADIUS courante.
  
  Une requête doit être créée via la fonction <strong>radius_create_request()</strong> avant que cette fonction
  puisse être appelée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.
  <info>int</info>       <strong>$vendor</strong>         L'identifiant du vendeur.
  <info>int</info>       <strong>$type</strong>           Le type d'attribut.
  <info>string</info>    <strong>$addr</strong>           Une adresse IPv4 ; par exemple <return>10.0.0.1</return>.
  <info></info>          <strong>$options</strong>        Un masqe d'options d'attribut. Les options disponibles incluent
                            <info>RADIUS_OPTION_TAGGED</info> et <info>RADIUS_OPTION_SALT</info>.
  <info></info>          <strong>$tag</strong>            L'attribut tag. Ce paramètre est ignoré tant que l'option
                            <info>RADIUS_OPTION_TAGGED</info> est défini.

<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: radius_put_vendor_attr
type: function
doc:
<comment>Description:</comment>
  Attache un attribut binaire à un vendeur spécifique
  
  Attache un attibut binaire spécifique au vendeur pour la requête courante RADIUS.
  
  Une requête doit être créée via la fonction <strong>radius_create_request()</strong> avant que cette fonction
  puisse être appelée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.
  <info>int</info>       <strong>$vendor</strong>         L'identifiant du vendeur.
  <info>int</info>       <strong>$type</strong>           Le type d'attribut.
  <info>string</info>    <strong>$value</strong>          La valeur de l'attribut, qui sera traité comme une chaîne binaire brûte.
  <info>int</info>       <strong>$options</strong>        Un masqe d'options d'attribut. Les options disponibles incluent
                            <info>RADIUS_OPTION_TAGGED</info> et <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            L'attribut tag. Ce paramètre est ignoré tant que l'option
                            <info>RADIUS_OPTION_TAGGED</info> est défini.

<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>radius_get_vendor_attr()</strong>


id: radius_put_vendor_int
type: function
doc:
<comment>Description:</comment>
  Attache un attribut entier à un vendeur spécifique
  
  Attache un attribut spécifique au vendreau à la requête courante RADIUS.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.
  <info>int</info>       <strong>$vendor</strong>         L'identifiant du vendeur.
  <info>int</info>       <strong>$type</strong>           Le type d'attribut.
  <info>int</info>       <strong>$value</strong>          La valeur de l'attribut.
  <info>int</info>       <strong>$options</strong>        Un masqe d'options d'attribut. Les options disponibles incluent
                            <info>RADIUS_OPTION_TAGGED</info> et <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            L'attribut tag. Ce paramètre est ignoré tant que l'option
                            <info>RADIUS_OPTION_TAGGED</info> est défini.

<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>radius_put_vendor_string()</strong>


id: radius_put_vendor_string
type: function
doc:
<comment>Description:</comment>
  Attache un attribut sous la forme d'une chaîne à un vendeur spécifique
  
  Attache un attribut spécifique au vendeur à la requête courante RADIUS. En général,
  <strong>radius_put_vendor_attr()</strong> est une fonction plus pratique pour attacher des attributs, sachant
  qu'elle est sécurisé au niveau binaire.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.
  <info>int</info>       <strong>$vendor</strong>         L'identifiant du vendeur.
  <info>int</info>       <strong>$type</strong>           Le type d'attribut.
  <info>string</info>    <strong>$value</strong>          La valeur de l'attribut. Cette valeur est attendue par la bibliothèque
                            sous-jacente comme se terminant par <info>null</info> ; aussi, ce paramètre n'est pas
                            sécurisé au niveau binaire.
  <info>int</info>       <strong>$options</strong>        Un masqe d'options d'attribut. Les options disponibles incluent
                            <info>RADIUS_OPTION_TAGGED</info> et <info>RADIUS_OPTION_SALT</info>.
  <info>int</info>       <strong>$tag</strong>            L'attribut tag. Ce paramètre est ignoré tant que l'option
                            <info>RADIUS_OPTION_TAGGED</info> est défini.

<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>radius_put_vendor_int()</strong>


id: radius_request_authenticator
type: function
doc:
<comment>Description:</comment>
  Retourne l'identifiant demandé
  
  L'identifiant demandé est nécessaire pour le rétablissement des données comme les mots de passe et
  les clés de chiffrement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.

<comment>Return:</comment>
  <info>string</info>  Retourne l'identificateur demandé en tant que chaîne de caractères ou <info>false</info> si une erreur
          survient.

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


id: radius_salt_encrypt_attr
type: function
doc:
<comment>Description:</comment>
  Chiffre une valeur en utilisant un Salt
  
  Applique l'algorithme RADIUS salt à la valeur fournie.
  
  En général, ceci est fait automatiquement en fournissant l'option <info>RADIUS_OPTION_SALT</info> à la fonction
  définissant l'attribut, mais cette fonction peut être utilisée si une construction de requête bas
  niveau est requise.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Les données à chiffrer avec un salt.

<comment>Return:</comment>
  <info>string|false</info>  Retourne les données chiffrées en utilisant un salt ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>radius_put_addr()</strong>
   * <strong>radius_put_attr()</strong>
   * <strong>radius_put_int()</strong>
   * <strong>radius_put_string()</strong>


id: radius_send_request
type: function
doc:
<comment>Description:</comment>
  Envoie une requête et attend une réponse
  
  Après qu'une demande Radius ait été construite, elle est envoyé grâce à la fonction
  <strong>radius_send_request()</strong>.
  
  La fonction <strong>radius_send_request()</strong> envoie la requête et attend une réponse valide, essayant à
  nouveau, suivant la méthode <return>round-robin</return> autant que nécessaire.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.

<comment>Return:</comment>
  <info>int</info>  Si une réponse valide est reçue, <strong>radius_send_request()</strong> retourne le code Radius qui spécifie
       le type de réponse. C'est, typiquement, <info>RADIUS_ACCESS_ACCEPT</info>, <info>RADIUS_ACCESS_REJECT</info> ou
       <info>RADIUS_ACCESS_CHALLENGE</info>. Si aucune réponse valide n'est reçue, <strong>radius_send_request()</strong>
       retournera <info>false</info>.

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


id: radius_server_secret
type: function
doc:
<comment>Description:</comment>
  Retourne le secret partagé
  
  Le secret partagé est nécessaire pour le rétablissement des données comme les mots de passe et les
  clés de chiffrement.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.

<comment>Return:</comment>
  <info>string</info>  Retourne le secret partagé du serveur en tant que chaîne de caractères ou <info>false</info> si une
          erreur survient.


id: radius_strerror
type: function
doc:
<comment>Description:</comment>
  Retourne un message d'erreur
  
  Si une fonction Radius échoue, alors, elle enregistre un message d'erreur. Ce message d'erreur
  peut être récupéré avec cette fonction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$radius_handle</strong>  La ressource RADIUS.

<comment>Return:</comment>
  <info>string</info>  Retourne un message d'erreur en tant que chaîne de caractères.


id: rand
type: function
doc:
<comment>Description:</comment>
  Génère une valeur aléatoire
  
  Appelée sans les options <strong>$min</strong> et <strong>$max</strong>, <strong>rand()</strong> retourne un nombre pseudoaléatoire entre 0 et
  <strong>getrandmax()</strong>. Si vous voulez un nombre aléatoire entre 5 et 15 (inclus), par exemple, utilisez
  <return>rand (5, 15)</return>.
  
  Cette fonction ne génère pas de valeurs cryptographiquement sûres, et ne doit pas être utilisée à
  des fins cryptographiques, ou à des fins qui exigent que les valeurs renvoyées soient
  indéchiffrables.
  
  Si de l'aléatoire cryptographiquement sûre est requis, le <class>Random\Randomizer</class> peut être utilisé avec
  le moteur <class>Random\Engine\Secure</class>. Pour des cas d'usage simple, les fonctions <strong>random_int()</strong> et
  <strong>random_bytes()</strong> fournissent une API pratique et sûre qui est qui est soutenu par le CSPRNG du
  système d'exploitation.
  
  Sur quelques plates-formes (par exemple, Windows), <strong>mt_getrandmax()</strong>est limité à 32767. Si vous
  désirez une limite supérieure à 32767, en spécifiant <strong>$min</strong> et <strong>$max</strong>, vous serez autorisés à utiliser
  un intervalle plus grand que <strong>mt_getrandmax()</strong>, ou bien, utilisez la fonction <strong>mt_rand()</strong> à la place.
  
  À partir de php 7.1.0, <strong>rand()</strong> utilise le même  générateur de nombres aléatoires que <strong>mt_rand()</strong>.
  Pour  préserver la compatibilité ascendante, <strong>rand()</strong> permet à  <strong>$max</strong> d'être plus petit que <strong>$min</strong>  par
  opposition au retour <info>false</info> de <strong>mt_rand()</strong>

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  La plus petite valeur à retourner (par défaut, 0)
  <info>int</info>  <strong>$max</strong>  La plus grande valeur à retourner (par défaut, <strong>mt_getrandmax()</strong>)

<comment>Return:</comment>
  <info>int</info>  Une valeur pseudoaléatoire, comprise entre <strong>$min</strong> (ou 0) et <strong>$max</strong> (ou <strong>mt_getrandmax()</strong>,
       inclusif).

<comment>See Also:</comment>
   * <strong>srand()</strong>
   * <strong>getrandmax()</strong>
   * <strong>mt_rand()</strong>
   * <strong>random_int()</strong>
   * <strong>random_bytes()</strong>


id: random_bytes
type: function
doc:
<comment>Description:</comment>
  Récupère des octets aléatoires cryptographiquement sécurisés
  
  Génère une chaîne contenant des octets aléatoires uniformément sélectionnés avec la valeur de
  <strong>$length</strong>.
  
  Les octets retournés étant choisis de manière totalement aléatoire, la chaîne résultante
  contiendra probablement des caractères non imprimables ou des séquences UTF-8 invalides. Il peut
  être nécessaire de l'encoder avant la transmission ou l'affichage.
  
  La randomisation générée par cette fonction est adaptée à toutes les applications, y compris la
  génération de secrets à long terme, tels que des clés de chiffrement.
  
  Les sources de hasard par ordre de priorité sont les suivantes :
  
  Linux: getrandom(), /dev/urandom
  
  FreeBSD &gt;= 12 (PHP &gt;= 7.3): getrandom(), /dev/urandom
  
  Windows (PHP &gt;= 7.2): CNG-API
  
  Windows: CryptGenRandom
  
  macOS (PHP &gt;= 8.2; &gt;= 8.1.9; &gt;= 8.0.22 si CCRandomGenerateBytes est disponible au moment
  de la compilation): CCRandomGenerateBytes()
  
  macOS (PHP &gt;= 8.1; &gt;= 8.0.2): arc4random_buf(), /dev/urandom
  
  NetBSD &gt;= 7 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), /dev/urandom
  
  OpenBSD &gt;= 5.5 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), /dev/urandom
  
  DragonflyBSD (PHP &gt;= 8.1): getrandom(), /dev/urandom
  
  Solaris (PHP &gt;= 8.1): getrandom(), /dev/urandom
  
  Toute combinaison d'un système d'exploitation et d'une version de PHP non mentionnée précédemment:
  /dev/urandom.
  
  Si aucune des sources de hasard n'est disponible ou si elles échouent toutes à générer de
  l'aléatoire, une exception de type <class>Random\RandomException</class> sera levée.
  
  Bien que cette fonction ait été ajoutée en PHP 7.0, une implementation en espace utilisateur est
  disponible pour PHP 5.2 jusqu'à 5.6, inclus.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  La longueur de la chaîne de caractères aléatoire qui doit être retournée en octets;
                doit être supérieur ou égal à <return>1</return>.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères contenant le nombre demandé d'octets cryptographiquement
          sécurisés.

<comment>See Also:</comment>
   * <strong>Random\Randomizer::getBytes()</strong>
   * <strong>random_int()</strong>
   * <strong>bin2hex()</strong>
   * <strong>base64_encode()</strong>


id: random_int
type: function
doc:
<comment>Description:</comment>
  Récupère un entier sélectionné de manière uniforme et cryptographiquement sécurisée
  
  Génère un entier uniformément sélectionné entre la valeur minimale et maximale données.
  
  La randomisation générée par cette fonction est adaptée à toutes les applications, y compris la
  génération de secrets à long terme, tels que des clés de chiffrement.
  
  Les sources de hasard par ordre de priorité sont les suivantes :
  
  Linux: getrandom(), /dev/urandom
  
  FreeBSD &gt;= 12 (PHP &gt;= 7.3): getrandom(), /dev/urandom
  
  Windows (PHP &gt;= 7.2): CNG-API
  
  Windows: CryptGenRandom
  
  macOS (PHP &gt;= 8.2; &gt;= 8.1.9; &gt;= 8.0.22 si CCRandomGenerateBytes est disponible au moment
  de la compilation): CCRandomGenerateBytes()
  
  macOS (PHP &gt;= 8.1; &gt;= 8.0.2): arc4random_buf(), /dev/urandom
  
  NetBSD &gt;= 7 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), /dev/urandom
  
  OpenBSD &gt;= 5.5 (PHP &gt;= 7.1; &gt;= 7.0.1): arc4random_buf(), /dev/urandom
  
  DragonflyBSD (PHP &gt;= 8.1): getrandom(), /dev/urandom
  
  Solaris (PHP &gt;= 8.1): getrandom(), /dev/urandom
  
  Toute combinaison d'un système d'exploitation et d'une version de PHP non mentionnée précédemment:
  /dev/urandom.
  
  Si aucune des sources de hasard n'est disponible ou si elles échouent toutes à générer de
  l'aléatoire, une exception de type <class>Random\RandomException</class> sera levée.
  
  Bien que cette fonction ait été ajoutée en PHP 7.0, une implementation en espace utilisateur est
  disponible pour PHP 5.2 jusqu'à 5.6, inclus.

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  La valeur minimale à retourner.
  <info>int</info>  <strong>$max</strong>  La valeur maximale à retourner.

<comment>Return:</comment>
  <info>int</info>  Un entier sélectionné de manière uniforme et cryptographiquement sécurisée à partir de
       l'intervalle fermé [<strong>$min</strong>, <strong>$max</strong>]. Les deux valeurs <strong>$min</strong> et <strong>$max</strong> peuvent être retournées.

<comment>See Also:</comment>
   * Random\Randomizer::getInt
   * <strong>random_bytes()</strong>


id: range
type: function
doc:
<comment>Description:</comment>
  Crée un tableau contenant un intervalle d'éléments
  
  Crée un tableau contenant un intervalle d'éléments.
  
  Si à la fois <strong>$start</strong> et <strong>$end</strong> sont des <info>string</info>, et que <strong>$step</strong> est de type <info>int</info>, le tableau produit sera
  une séquence d'octets. Sinon, le tableau produit sera une séquence de nombres.
  
  La séquence est croissante si <strong>$start</strong> est inférieur ou égal à <strong>$end</strong>. Sinon, la séquence est
  décroissante.

<comment>Param:</comment>
  <info>string|int|float</info>  <strong>$start</strong>  Première valeur de la séquence.
  <info>string|int|float</info>  <strong>$end</strong>    Dernière valeur possible de la séquence.
  <info>int|float</info>         <strong>$step</strong>   <strong>$step</strong> indique de combien la séquence produite progresse entre les
                            valeurs de la séquence.
                            
                            <strong>$step</strong> peut être négatif pour les séquences décroissantes.
                            
                            Si <strong>$step</strong> est un <info>float</info> sans partie fractionnaire, il est interprété comme
                            un <info>int</info>.

<comment>Return:</comment>
  <info>array</info>  Retourne une séquence d'éléments sous forme d'un tableau <info>array</info> avec le premier élément
         étant <strong>$start</strong> allant jusqu'à <strong>$end</strong>, chaque valeur de la séquence étant séparée de <strong>$step</strong>
         valeurs.
         
         Le dernier élément du tableau retourné est soit <strong>$end</strong> soit l'élément précédent de la
         séquence, en fonction de la valeur de <strong>$step</strong>.
         
         Si à la fois <strong>$start</strong> et <strong>$end</strong> sont des <info>string</info>, et que <strong>$step</strong> est de type <info>int</info> le tableau
         produit sera une séquence d'octets, généralement des caractères ASCII latins.
         
         Si au moins l'un des <strong>$start</strong>, <strong>$end</strong> ou <strong>$step</strong> est de type <info>float</info>, le tableau produit sera une
         séquence de <info>float</info>.
         
         Sinon, le tableau produit sera une séquence de <info>int</info>.

<comment>See Also:</comment>
   * <strong>shuffle()</strong>
   * <strong>array_fill()</strong>
   * foreach


id: rar_wrapper_cache_stats
type: function
doc:
<comment>Description:</comment>
  Statistique pour le cache du gestionnaire URL
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>string</info>  


id: rawurldecode
type: function
doc:
<comment>Description:</comment>
  Décode une chaîne URL
  
  <strong>rawurldecode()</strong> retourne la chaîne <strong>$str</strong> dont les séquences de caractères <return>%xy</return>, avec <return>xy</return> deux valeurs
  hexadécimales, auront été remplacées par le caractère ASCII correspondant.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  L'URL à décoder.

<comment>Return:</comment>
  <info>string</info>  Retourne l'URL décodée, sous la forme d'une chaîne de caractères.

<comment>See Also:</comment>
   * <strong>rawurlencode()</strong>
   * <strong>urldecode()</strong>
   * <strong>urlencode()</strong>
   * RFC 3986


id: rawurlencode
type: function
doc:
<comment>Description:</comment>
  Encode une chaîne en URL, selon la RFC 3986
  
  Encode la chaîne fournie, en accord avec la RFC 3986.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  L'URL à encoder.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne dont tous les caractères non alphanumériques (hormis <return>-_.~</return>) auront été
          remplacés par des séquences <return>%xy</return> (<return>%</return>), avec xy, deux valeurs hexadécimales. Ce codage est
          conforme à la RFC 3986 qui évite que les caractères spéciaux soient interprétés comme des
          délimiteurs, et pour protéger les URL lors du transfert (contrairement à certains systèmes
          email).

<comment>See Also:</comment>
   * <strong>rawurldecode()</strong>
   * <strong>urldecode()</strong>
   * <strong>urlencode()</strong>
   * RFC 3986


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


id: readdir
type: function
doc:
<comment>Description:</comment>
  Lit une entrée du dossier
  
  <strong>readdir()</strong> retourne le nom de la prochaine entrée du dossier identifié par <strong>$dir_handle</strong>. Les entrées
  sont retournées dans l'ordre dans lequel elles sont enregistrées dans le système de fichiers.

<comment>Param:</comment>
  <info>resource|null</info>  <strong>$dir_handle</strong>  La <info>ressource</info> de dossier ouverte précédemment avec <strong>opendir()</strong>. Si la
                              ressource de dossier n'est pas spécifiée, la dernière ressource
                              ouverte avec la fonction <strong>opendir()</strong> sera utilisée.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le nom de l'entrée en cas de réussite, 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>is_dir()</strong>
   * <strong>glob()</strong>
   * <strong>opendir()</strong>
   * <strong>scandir()</strong>


id: readfile
type: function
doc:
<comment>Description:</comment>
  Affiche un fichier
  
  Lit un fichier et l'envoie dans le buffer de sortie.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>          Le fichier à lire.
  <info>bool</info>           <strong>$use_include_path</strong>  Vous pouvez utiliser le deuxième paramètre optionnel pour
                                    explorer le dossier include_path, en passant la valeur de <info>true</info>.
  <info>resource|null</info>  <strong>$context</strong>           Une <info>resource</info> de contexte de flux.

<comment>Return:</comment>
  <info>int|false</info>  Retourne le nombre d'octets lus depuis le fichier en cas de succès,  ou <info>false</info> si une
             erreur survient

<comment>See Also:</comment>
   * <strong>fpassthru()</strong>
   * <strong>file()</strong>
   * <strong>fopen()</strong>
   * <strong>include()</strong>
   * <strong>require()</strong>
   * <strong>virtual()</strong>
   * <strong>file_get_contents()</strong>
   * 


id: readgzfile
type: function
doc:
<comment>Description:</comment>
  Lit tout le fichier compressé
  
  <strong>readgzfile()</strong> lit le fichier <strong>$filename</strong>, le décompresse et affiche le résultat.
  
  <strong>readgzfile()</strong> peut aussi servir à lire un fichier qui n'est pas compressé : dans ce cas,
  <strong>readgzfile()</strong> va lire le fichier sans le décompresser.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>          Le nom du fichier. Ce fichier devra être ouvert depuis le système de
                             fichiers et son contenu sera affiché.
  <info>int</info>     <strong>$use_include_path</strong>  Vous pouvez définir ce paramètre optionnel à <return>1</return>, si vous voulez chercher
                             le fichier également dans l'include_path.

<comment>Return:</comment>
  <info>int|false</info>  Retourne le nombre d'octets (décompressés) lus depuis le fichier en cas de succès,  ou
             <info>false</info> si une erreur survient

<comment>See Also:</comment>
   * <strong>gzpassthru()</strong>
   * <strong>gzfile()</strong>
   * <strong>gzopen()</strong>


id: readline
type: function
doc:
<comment>Description:</comment>
  Lit une ligne
  
  Retourne une ligne entrée par l'utilisateur. Vous devez ajouter cette ligne à l'historique
  vous-même, avec la fonction <strong>readline_add_history()</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$prompt</strong>  Vous pouvez spécifier une chaîne de caractères à utiliser comme prompt à
                        l'utilisateur.

<comment>Return:</comment>
  <info>string|false</info>  Retourne une chaîne de caractères depuis l'utilisateur. La ligne retournée a été
                débarrassée du caractère final de nouvelle ligne. S'il n'y a plus de données à lire,
                alors <info>false</info> est retourné.


id: readline_add_history
type: function
doc:
<comment>Description:</comment>
  Ajoute une ligne à l'historique
  
  Ajoute une ligne à l'historique.

<comment>Param:</comment>
  <info>string</info>  <strong>$prompt</strong>  La ligne à ajouter à l'historique.

<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: readline_callback_handler_install
type: function
doc:
<comment>Description:</comment>
  Initialise l'interface et le terminal de rappel de readline, affiche le prompt et retourne
  immédiatement
  
  Définie une interface de rappel pour readline, affiche le <strong>$prompt</strong> et retourne immédiatement.
  Appeler cette fonction deux fois sans effacer au préalable l'interface de rappel précédente
  effacera automatiquement et proprement l'ancienne interface.
  
  La fonctionnalité de rappel est très utile lorsque combinée à la fonction <strong>stream_select()</strong>
  permettant l'interconnexion IO / entrée utilisateur, à la différence de <strong>readline()</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$prompt</strong>    Le message de prompt.
  <info>callable</info>  <strong>$callback</strong>  La fonction <strong>$callback</strong> prend un paramètre : l'entrée utilisateur retournée.

<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>readline_callback_handler_remove()</strong>
   * <strong>readline_callback_read_char()</strong>
   * <strong>stream_select()</strong>


id: readline_callback_handler_remove
type: function
doc:
<comment>Description:</comment>
  Efface un gestionnaire de rappel readline
  
  Efface un gestionnaire de rappel installé précédemment et restaure les paramètres du terminal.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si un gestionnaire de rappel précédemment installé a été effacé ou <info>false</info> s'il
        n'a pas été trouvé.

<comment>See Also:</comment>
   * <strong>readline_callback_handler_install()</strong>
   * <strong>readline_callback_read_char()</strong>


id: readline_callback_read_char
type: function
doc:
<comment>Description:</comment>
  Lit un caractère et informe l'interface de rappel readline
  
  Lit un caractère de l'entrée utilisateur. Lorsqu'une ligne est reçue, la fonction informe
  l'interface de rappel readline installée en utilisant <strong>readline_callback_handler_install()</strong> qu'une
  ligne est prête à être entrée.

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

<comment>See Also:</comment>
   * <strong>readline_callback_handler_install()</strong>
   * <strong>readline_callback_handler_remove()</strong>


id: readline_clear_history
type: function
doc:
<comment>Description:</comment>
  Efface l'historique
  
  Efface l'historique.

<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: readline_completion_function
type: function
doc:
<comment>Description:</comment>
  Enregistre une fonction de complétion
  
  Enregistre une nouvelle fonction de complétion. C'est la même fonctionnalité que lorsque vous
  utilisez la touche de tabulation sous Bash.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Vous devez fournir le nom d'une fonction qui accepte un nom partiel de
                       commande, et retourne une liste de fonctions complète possibles.

<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: readline_info
type: function
doc:
<comment>Description:</comment>
  Lit ou modifie diverses variables internes de readline
  
  Lit/modifie diverses variables internes.

<comment>Param:</comment>
  <info>string|null</info>           <strong>$var_name</strong>  Un nom de variable.
  <info>int|string|bool|null</info>  <strong>$value</strong>     Si fourni, ce sera la nouvelle valeur à définir.

<comment>Return:</comment>
  <info>mixed</info>  Appelée sans paramètre, <strong>readline_info()</strong> retourne une tableau contenant les valeurs des
         paramètres de Readline. Les éléments seront indexés par les clés suivantes : <return>"done"</return>, <return>"end"</return>,
         <return>"erase_empty_line"</return>, <return>"library_version"</return>,  <return>"line_buffer"</return>, <return>"mark"</return>, <return>"pending_input"</return>, <return>"point"</return>,
         <return>"prompt"</return>, <return>"readline_name"</return> et <return>"terminal_name"</return>. Le tableau ne contiendra que les éléments qui
         sont pris en charge par la bibliothèque utilisée pour construire l'extension readline.
         
         Si appelée avec un ou deux paramètres, l'ancienne valeur est retournée.


id: readline_list_history
type: function
doc:
<comment>Description:</comment>
  Liste l'historique
  
  Liste l'historique.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau avec la liste de toutes les lignes de commandes de l'historique. Les
         éléments sont indexés numériquement, à partir de <return>0</return>.


id: readline_on_new_line
type: function
doc:
<comment>Description:</comment>
  Informe readline que le curseur est passé à une nouvelle ligne
  
  Informe readline que le curseur est passé à une nouvelle ligne.

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


id: readline_read_history
type: function
doc:
<comment>Description:</comment>
  Lit l'historique
  
  Lit une ligne de l'historique depuis le fichier <strong>$filename</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Chemin vers le fichier contenant l'historique des commandes.

<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: readline_redisplay
type: function
doc:
<comment>Description:</comment>
  Demande à readline de refaire l'affichage
  
  Demande à readline de refaire l'affichage.

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


id: readline_write_history
type: function
doc:
<comment>Description:</comment>
  Écrit dans l'historique
  
  Écrit l'historique dans le fichier <strong>$filename</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Chemin vers le fichier à sauvegarder.

<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: readlink
type: function
doc:
<comment>Description:</comment>
  Renvoie le contenu d'un lien symbolique
  
  <strong>readlink()</strong> effectue la même chose que la fonction C <return>readlink</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Le chemin vers le lien symbolique.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le contenu du lien symbolique ou <info>false</info> si une erreur survient.
                
                La fonction échoue si le paramètre <strong>$path</strong> n'est pas un lien symbolique, sauf sous
                Windows, où le chemin personnalisé sera retourné.

<comment>See Also:</comment>
   * <strong>is_link()</strong>
   * <strong>symlink()</strong>
   * <strong>linkinfo()</strong>


id: realpath
type: function
doc:
<comment>Description:</comment>
  Retourne le chemin canonique absolu
  
  <strong>realpath()</strong> résout tous les liens symboliques, et remplace toutes les références <return>/./</return>, <return>/../</return> et <return>/</return> de
  <strong>$path</strong> puis retourne le chemin canonique absolu ainsi trouvé.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Le chemin à vérifier.  Un chemin d'accès doit être fourni, la valeur peut être une
                 chaîne de caractère vide. Dans ces cas, la valeur est interprétée comme étant le
                 dossier courant.
                 
                 Un chemin d'accès doit être fourni, la valeur peut être une chaîne de caractère
                 vide. Dans ces cas, la valeur est interprétée comme étant le dossier courant.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le chemin canonique absolu ainsi trouvé. Le résultat ne contient aucun lien
                symbolique, <return>/./</return> ou <return>/../</return>. Les délimiteurs de fin comme <return>\</return> et <return>/</return> sont également
                supprimés.
                
                <strong>realpath()</strong> retourne <info>false</info> si une erreur survient, e.g. si le fichier n'existe pas.
                
                Le script qui s'exécute doit avoir les permissions en exécution sur tous les
                dossiers de la structure, sinon, la fonction <strong>realpath()</strong> retournera <info>false</info>.
                
                Pour les systèmes de fichiers insensibles à la casse, <strong>realpath()</strong> peut ou non
                normaliser la casse des caractères.
                
                La fonction <strong>realpath()</strong> ne fonctionnera pas pour un  fichier qui se trouve à
                l'intérieur d'un phar car ce chemin serait un  chemin d'accès virtuel, pas un vrai.
                
                Sur Windows, les jonctions et les liens symbolics aux dossiers sont uniquement
                étendu d'un niveau.
                
                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>basename()</strong>
   * <strong>dirname()</strong>
   * <strong>pathinfo()</strong>


id: realpath_cache_get
type: function
doc:
<comment>Description:</comment>
  Récupère les entrées du cache realpath
  
  Récupère les entrées du cache realpath.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableaux d'entrées du cache realpath. Les clés sont les chemins originaux et
         les valeurs sont des tableaux de données contenant le chemin résolu, la date d'expiration
         et d'autres param-tres gardés en cache.

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


id: realpath_cache_size
type: function
doc:
<comment>Description:</comment>
  Récupère la taille du cache realpath
  
  Récupère la quantité de mémoire utilisée par le cache realpath.

<comment>Return:</comment>
  <info>int</info>  Retourne la quantité de mémoire utilisée par le cache realpath.

<comment>See Also:</comment>
   * <strong>realpath_cache_get()</strong>
   * 
     L'option de configuration
     realpath_cache_size
    


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


id: recode_file
type: function
doc:
<comment>Description:</comment>
  Recodage de fichier à fichier, en fonction de la demande
  
  Recode le fichier identifié par <strong>$input</strong> dans le fichier identifié par <strong>$output</strong> en fonction de la
  requête de recodage <strong>$request</strong>.

<comment>Param:</comment>
  <info>string</info>    <strong>$request</strong>  Le type de requête recode désiré
  <info>resource</info>  <strong>$input</strong>    Un gestionnaire de fichier local pour le paramètre <strong>$input</strong>
  <info>resource</info>  <strong>$output</strong>   Un gestionnaire de fichier local pour le paramètre <strong>$output</strong>

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>false</info>, en cas d'échec, et <info>true</info> sinon.

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


id: recode_string
type: function
doc:
<comment>Description:</comment>
  Recode une chaîne en fonction de la requête
  
  Recode la chaîne <strong>$string</strong> en fonction de la requête <strong>$request</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$request</strong>  Le type de requête recode désiré
  <info>string</info>  <strong>$string</strong>   La chaîne de caractères à recoder

<comment>Return:</comment>
  <info>string</info>  Retourne la chaîne recodée en cas de succès et <info>false</info> sinon.

<comment>See Also:</comment>
   * 
     Reportez-vous à la documentation GNU Recode de votre installation
     pour plus de détails sur les requêtes.
    
   * <strong>mb_convert_encoding()</strong>
   * UConverter::transcode
   * <strong>iconv()</strong>


id: register_shutdown_function
type: function
doc:
<comment>Description:</comment>
  Enregistre une fonction de rappel pour exécution à l'extinction
  
  Enregistre une fonction de rappel <strong>$callback</strong> pour exécution à l'extinction ou lorsque <strong>exit()</strong> est
  appelé.
  
  Plusieurs appels à <strong>register_shutdown_function()</strong> sont possibles dans le même script, et les
  fonctions seront appelées dans le même ordre que celui dans lequel elles sont enregistrées. Si
  vous appelez <strong>exit()</strong> durant l'une des fonctions d'extinction, le processus sera définitivement
  arrêté, sans que les autres fonctions soient appelées.
  
  les fonctions d'arrêt peuvent également appeler la fonction <strong>register_shutdown_function()</strong>
  elles-mêmes pour ajouter une fonction d'arrêt à la fin de la file d'attente.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel à enregistrer.
                       
                       La fonction de rappel est exécuté comme faisant parti de la requête, aussi,
                       il est possible d'envoyer quelque à la sortie depuis cette dernière, puis
                       d'accéder aux buffers de sortie.
  <info>mixed</info>     <strong>$args</strong>      Il est possible de passer des paramètres aux fonctions d'extinction en
                       configurant ces paramètres supplémentaires.

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

<comment>See Also:</comment>
   * auto_append_file
   * <strong>exit()</strong>
   * <strong>fastcgi_finish_request()</strong>
   * La section sur la gestion des connexions


id: register_tick_function
type: function
doc:
<comment>Description:</comment>
  Enregistre une fonction exécutée à chaque tick
  
  <strong>register_tick_function()</strong> enregistre la fonction <strong>$callback</strong> pour être exécutée à chaque fois qu'un
  tick survient.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  La fonction à enregistrer.
  <info>mixed</info>     <strong>$args</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>
   * declare
   * <strong>unregister_tick_function()</strong>


id: rename
type: function
doc:
<comment>Description:</comment>
  Renomme un fichier ou un dossier
  
  Tente de renommer <strong>$from</strong> en <strong>$to</strong>, en le déplaçant de répertoire si nécessaire. Si vous renommez un
  fichier et que <strong>$to</strong>  existe, il sera écrasé. Si vous renommez un répertoire et que  <strong>$to</strong> existe,
  cette fonction émet un avertissement.

<comment>Param:</comment>
  <info>string</info>         <strong>$from</strong>     L'ancien nom.
                           
                           Le gestionnaire utilisé dans le paramètre <strong>$from</strong> DOIT être le même que
                           celui utilisé dans <strong>$to</strong>.
  <info>string</info>         <strong>$to</strong>       Le nouveau nom.  Sur Windows, si <strong>$to</strong> existe déjà, il doit pouvoir être
                           écrit. Sinon <strong>rename()</strong> échoue et émet une <info>E_WARNING</info>.
                           
                           Sur Windows, si <strong>$to</strong> existe déjà, il doit pouvoir être écrit. Sinon
                           <strong>rename()</strong> échoue et émet une <info>E_WARNING</info>.
  <info>resource|null</info>  <strong>$context</strong>  Une <info>resource</info> de contexte de flux.

<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>copy()</strong>
   * <strong>unlink()</strong>
   * <strong>move_uploaded_file()</strong>


id: reset
type: function
doc:
<comment>Description:</comment>
  Remet le pointeur interne de tableau au début
  
  <strong>reset()</strong> replace le pointeur de tableau <strong>$array</strong> au premier élément et retourne la valeur du premier
  élément.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  Le tableau d'entrée.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur du premier élément du tableau, ou <info>false</info> si le tableau est vide.
         
         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>current()</strong>
   * <strong>each()</strong>
   * <strong>end()</strong>
   * <strong>next()</strong>
   * <strong>prev()</strong>
   * <strong>array_key_first()</strong>


id: restore_error_handler
type: function
doc:
<comment>Description:</comment>
  Réactive l'ancienne fonction de gestion des erreurs
  
  Utilisée après avoir modifié la fonction de gestion des erreurs, grâce à <strong>set_error_handler()</strong>,
  <strong>restore_error_handler()</strong> permet de réutiliser l'ancienne version de gestion des erreurs (qui peut
  être la fonction PHP par défaut, ou une autre fonction utilisateur).

<comment>Return:</comment>
  <info>true</info>  Retourne toujours <info>true</info>.

<comment>See Also:</comment>
   * <strong>error_reporting()</strong>
   * <strong>set_error_handler()</strong>
   * <strong>restore_exception_handler()</strong>
   * <strong>trigger_error()</strong>


id: restore_exception_handler
type: function
doc:
<comment>Description:</comment>
  Réactive l'ancienne fonction de gestion d'exceptions
    
  
  <strong>restore_exception_handler()</strong> est utilisé, après le changement de la fonction de gestion
  d'exceptions avec la fonction  <strong>set_exception_handler()</strong>, pour revenir à l'ancien  gestionnaire
  d'exceptions (qui peut être la fonction interne ou une fonction définie par l'utilisateur).

<comment>Return:</comment>
  <info>true</info>  Retourne toujours <info>true</info>.

<comment>See Also:</comment>
   * <strong>set_exception_handler()</strong>
   * <strong>set_error_handler()</strong>
   * <strong>restore_error_handler()</strong>
   * <strong>error_reporting()</strong>


id: restore_include_path
type: function
doc:
<comment>Description:</comment>
  Restaure la valeur de la directive de configuration include_path
  
  Restaure la valeur de la directive de configuration include_path à sa valeur originale de début de
  script, telle qu'inscrite dans le php.ini.

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

<comment>See Also:</comment>
   * <strong>ini_restore()</strong>
   * <strong>get_include_path()</strong>
   * <strong>set_include_path()</strong>
   * <strong>include()</strong>


id: rewind
type: function
doc:
<comment>Description:</comment>
  Replace le pointeur de fichier au début
  
  Replace le pointeur de fichier <strong>$stream</strong> au début du flux.
  
  Si vous avez ouvert le fichier en mode d'ajout ("a" ou "a+"), toutes les données que vous écrirez
  dans ce fichier seront toujours ajoutées, sans se soucier de la position du pointeur de fichier.

<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>.

<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>fread()</strong>
   * <strong>fseek()</strong>
   * <strong>ftell()</strong>
   * <strong>fwrite()</strong>


id: rewinddir
type: function
doc:
<comment>Description:</comment>
  Retourne à la première entrée du dossier
  
  <strong>rewinddir()</strong> retourne à la première entrée du dossier identifiée par <strong>$dir_handle</strong>.

<comment>Param:</comment>
  <info>resource|null</info>  <strong>$dir_handle</strong>  La ressource de dossier ouverte précédemment avec <strong>opendir()</strong>. Si la
                              ressource de dossier n'est pas fournie, la dernière ressource ouverte
                              avec la fonction <strong>opendir()</strong> sera utilisée.

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


id: rmdir
type: function
doc:
<comment>Description:</comment>
  Efface un dossier
  
  Tente d'effacer le dossier dont le chemin est <strong>$directory</strong>. Le dossier doit être vide, et le script
  doit avoir les autorisations adéquates. Une alerte de niveau <info>E_WARNING</info> sera générée en cas
  d'échec.

<comment>Param:</comment>
  <info>string</info>         <strong>$directory</strong>  Le chemin vers le dossier.
  <info>resource|null</info>  <strong>$context</strong>    Une <info>resource</info> de contexte de flux.

<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>is_dir()</strong>
   * <strong>mkdir()</strong>
   * <strong>unlink()</strong>


id: rnp_backend_string
type: function
doc:
<comment>Description:</comment>
  Return cryptographic backend library name

<comment>Return:</comment>
  <info>string</info>  Backend name string. Currently supported backends are "Botan" and "OpenSSL".


id: rnp_backend_version
type: function
doc:
<comment>Description:</comment>
  Return cryptographic backend library version

<comment>Return:</comment>
  <info>string</info>  Version string.


id: rnp_decrypt
type: function
doc:
<comment>Description:</comment>
  Decrypt PGP message
  
  Private keys used for decryption should be loaded into the FFI object before calling this
  function. If password encryption was used, then password provider should be set by calling
  <strong>rnp_ffi_set_pass_provider()</strong>.

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>    L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$input</strong>  Encrypted message.

<comment>Return:</comment>
  <info>string|false</info>  Decrypted message on success ou <info>false</info> si une erreur survient.


id: rnp_dump_packets
type: function
doc:
<comment>Description:</comment>
  Dump OpenPGP packets stream information in humand-readable format

<comment>Param:</comment>
  <info>string</info>  <strong>$input</strong>  Input string containing OpenPGP data, either in binary or ASCII-armored format.
  <info>int</info>     <strong>$flags</strong>  See <info>RNP_DUMP_*</info> predefined constants.

<comment>Return:</comment>
  <info>string|false</info>  Text describing packet sequence ou <info>false</info> si une erreur survient.


id: rnp_dump_packets_to_json
type: function
doc:
<comment>Description:</comment>
  Dump OpenPGP packets stream information to the JSON string

<comment>Param:</comment>
  <info>string</info>  <strong>$input</strong>  Input string containing OpenPGP data, either in binary or ASCII-armored format.
  <info>int</info>     <strong>$flags</strong>  See <info>RNP_JSON_DUMP_*</info> predefined constants.

<comment>Return:</comment>
  <info>string|false</info>  JSON string with dump ou <info>false</info> si une erreur survient.


id: rnp_ffi_create
type: function
doc:
<comment>Description:</comment>
  Create the top-level object used for interacting with the library

<comment>Param:</comment>
  <info>string</info>  <strong>$pub_format</strong>  the format of the public keyring, RNP_KEYSTORE_GPG or other RNP_KEYSTORE_*
                       constant.
  <info>string</info>  <strong>$sec_format</strong>  the format of the secret keyring, RNP_KEYSTORE_GPG or other RNP_KEYSTORE_*
                       constant

<comment>Return:</comment>
  <info>RnpFFI|false</info>  Returns <info>RnpFFI</info> object on success ou <info>false</info> si une erreur survient.


id: rnp_ffi_destroy
type: function
doc:
<comment>Description:</comment>
  Destroy the top-level object used for interacting with the library

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>  L'objet FFI retourné par rnp_ffi_create.

<comment>Return:</comment>
  <info>void</info>  


id: rnp_ffi_set_pass_provider
type: function
doc:
<comment>Description:</comment>
  Set password provider callback function
  
  Sets password provider function. This function can ask for the password on a standard input (if
  PHP script is executed in a command line environment), display GUI dialog or provide password in
  any other possible ways. Requested passwords are used to encrypt or decrypt secret keys or perform
  symmetric encryption/decryption operations.

<comment>Param:</comment>
  <info>RnpFFI</info>    <strong>$ffi</strong>                L'objet FFI retourné par rnp_ffi_create.
  <info>callable</info>  <strong>$password_callback</strong>  The function that is to be called for every password request.  It
                                has the following signature:
                                <info>bool</info>password_callback<info>string</info><strong>$key_fp</strong><info>string</info><strong>$pgp_context</strong><info>string</info>password</strong>
                                <return>$key_fp</return> - The key fingerprint, if any. Can be empty.<return>$pgp_context</return> -
                                String describing why the key is being requested.<return>$password</return> -
                                Password string reference where provided password should be stored
                                to. Callback function should return <info>true</info> if password was
                                successfully set ou <info>false</info> si une erreur survient.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success ou <info>false</info> si une erreur survient.


id: rnp_import_keys
type: function
doc:
<comment>Description:</comment>
  Import keys from PHP string to the keyring and receive JSON describing new/updated keys

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>    L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$input</strong>  OpenPGP packets containing key(s) to be loaded. Can be either binary or ASCII
                  armored.
  <info>int</info>     <strong>$flags</strong>  See <info>RNP_LOAD_SAVE_*</info> predefined constants.

<comment>Return:</comment>
  <info>string|false</info>  JSON string with information about new and updated keys on success ou <info>false</info> si une
                erreur survient.


id: rnp_import_signatures
type: function
doc:
<comment>Description:</comment>
  Import standalone signatures to the keyring and receive JSON describing updated keys

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>    L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$input</strong>  OpenPGP packets containing signatures to be imported. Can be either binary or
                  ASCII armored.
  <info>int</info>     <strong>$flags</strong>  Currently must be 0.

<comment>Return:</comment>
  <info>string|false</info>  JSON string with information about updated keys on success ou <info>false</info> si une erreur
                survient.


id: rnp_key_export
type: function
doc:
<comment>Description:</comment>
  Export a key

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>     L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$key_fp</strong>  Key fingerprint.
  <info>int</info>     <strong>$flags</strong>   See <info>RNP_KEY_EXPORT_*</info> predefined constants (except <info>RNP_KEY_EXPORT_BASE64</info>).

<comment>Return:</comment>
  <info>string|false</info>  OpenPGP packets of exported key (binary or ASCII-armored) on success ou <info>false</info> si une
                erreur survient.


id: rnp_key_export_autocrypt
type: function
doc:
<comment>Description:</comment>
  Export minimal key for autocrypt feature (just 5 packets: key, uid, signature,
     encryption subkey, signature)

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>        L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$key_fp</strong>     Primary key fingerprint.
  <info>string</info>  <strong>$subkey_fp</strong>  Subkey to export. Can be an empty string to pick the first suitable subkey.
  <info>string</info>  <strong>$uid</strong>        User ID to export. Can be an empty string if exported key has only one uid.
  <info>int</info>     <strong>$flags</strong>      Only <info>RNP_KEY_EXPORT_BASE64</info> is currently supported. Enabling it would export
                      base64-encoded key data instead of binary.

<comment>Return:</comment>
  <info>string|false</info>  OpenPGP packets of exported key on success ou <info>false</info> si une erreur survient.


id: rnp_key_export_revocation
type: function
doc:
<comment>Description:</comment>
  Generate and export primary key revocation signature
  
  Note: to revoke a key you'll need to import this signature into the keystore or use
  <strong>rnp_key_revoke()</strong> function.

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>      L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$key_fp</strong>   Key fingerprint of the primary key to be revoked.
  <info>int</info>     <strong>$flags</strong>    <info>RNP_KEY_EXPORT_ARMORED</info> or 0.
  <info>array</info>   <strong>$options</strong>  An associative array with options.

<comment>Return:</comment>
  <info>string|false</info>  Exported revocation signature on success ou <info>false</info> si une erreur survient.


id: rnp_key_get_info
type: function
doc:
<comment>Description:</comment>
  Get information about the key

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>     L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$key_fp</strong>  Key fingerprint.

<comment>Return:</comment>
  <info>array|false</info>  An associative array with information about the key ou <info>false</info> si une erreur survient.


id: rnp_key_remove
type: function
doc:
<comment>Description:</comment>
  Remove a key from keyring(s)
  
  Note: you need to call <strong>rnp_save_keys()</strong> to write updated keyring(s) out.

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>     L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$key_fp</strong>  Key fingerprint.
  <info>int</info>     <strong>$flags</strong>   See <info>RNP_KEY_REMOVE_*</info> constants. Flag <info>RNP_KEY_REMOVE_SUBKEYS</info> will work only for
                   the primary key and will remove all of its subkeys as well.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success ou <info>false</info> si une erreur survient.


id: rnp_key_revoke
type: function
doc:
<comment>Description:</comment>
  Revoke a key or subkey by generating and adding revocation signature
  
  Note: you need to call <strong>rnp_save_keys()</strong> to write updated keyring(s) out.

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>      L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$key_fp</strong>   Key fingerprint.
  <info>int</info>     <strong>$flags</strong>    Currently must be 0.
  <info>array</info>   <strong>$options</strong>  An associative array with options.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success ou <info>false</info> si une erreur survient.


id: rnp_list_keys
type: function
doc:
<comment>Description:</comment>
  Enumerate all keys present in a keyring by specified identifer type

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>              L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$identifier_type</strong>  Key identifier type ("userid", "keyid", "grip", "fingerprint").

<comment>Return:</comment>
  <info>array|false</info>  An associative array where key is an identifier string and value is a PGP key
               fingerprint ou <info>false</info> si une erreur survient.


id: rnp_load_keys
type: function
doc:
<comment>Description:</comment>
  Load keys from PHP string
  
  Note that for G10, the input must be a directory (which must already exist).

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>     L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$format</strong>  Le format de clé pour la donnée (GPG, KBX, G10).
  <info>string</info>  <strong>$input</strong>   OpenPGP packets containing key(s) to be loaded. Can be either binary or ASCII
                   armored.
  <info>int</info>     <strong>$flags</strong>   Voir la description des drapeaux RNP_LOAD_SAVE_*.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success ou <info>false</info> si une erreur survient.


id: rnp_load_keys_from_path
type: function
doc:
<comment>Description:</comment>
  Load keys from specified path
  
  Note that for G10, the input must be a directory (which must already exist).

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>         L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$format</strong>      Le format de clé pour la donnée (GPG, KBX, G10).
  <info>string</info>  <strong>$input_path</strong>  file or directory containing the keys.
  <info>int</info>     <strong>$flags</strong>       Voir la description des drapeaux RNP_LOAD_SAVE_*.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success ou <info>false</info> si une erreur survient.


id: rnp_locate_key
type: function
doc:
<comment>Description:</comment>
  Search for the key
  
  Note: only valid userids are checked while searching by userid.

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>              L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$identifier_type</strong>  Identifier type string: "userid", "keyid", "fingerprint", "grip".
  <info>string</info>  <strong>$identifier</strong>       PGP User ID (name and email) for "userid" type, hexadecimal string that
                            represents key id, fingerprint or key grip correspondingly.

<comment>Return:</comment>
  <info>string|false</info>  Returns hexadecimal fingerprint of the key found on success ou <info>false</info> si une erreur
                survient.


id: rnp_op_encrypt
type: function
doc:
<comment>Description:</comment>
  Encrypt message

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>                L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$message</strong>            Message to be encrypted.
  <info>array</info>   <strong>$recipient_keys_fp</strong>  Array with fingerprints of recipient's keys. At least one key must be
                              present.
  <info>array</info>   <strong>$options</strong>            An associative array with options.

<comment>Return:</comment>
  <info>string|false</info>  Encrypted data on success ou <info>false</info> si une erreur survient.


id: rnp_op_generate_key
type: function
doc:
<comment>Description:</comment>
  Generate key

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>      L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$userid</strong>   PGP User ID - text that is intended to represent the name and email address of
                    the key holder.
  <info>string</info>  <strong>$key_alg</strong>  Primary key algorithm (i.e. 'RSA', 'DSA', etc).
  <info>string</info>  <strong>$sub_alg</strong>  Subkey algorithm. If not set, subkey will not be generated.
  <info>array</info>   <strong>$options</strong>  An associative array with options.

<comment>Return:</comment>
  <info>string|false</info>  Fingerprint of the generated primary key ou <info>false</info> si une erreur survient. This
                fingerprint can be used later to reference the key in sign and encrypt operations.
                The key data is stored in FFI memory context and can be saved using <strong>rnp_save_keys()</strong>
                or <strong>rnp_save_keys_to_path()</strong>.


id: rnp_op_sign
type: function
doc:
<comment>Description:</comment>
  Perform signing operation on a binary data, return embedded signature(s)

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>      L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$data</strong>     Data to be signed.
  <info>array</info>   <strong>$keys_fp</strong>  Array with key fingerprints. At least one key must be provided. Keys should be
                    present in <strong>$ffi</strong>.
  <info>array</info>   <strong>$options</strong>  An associative array with options.

<comment>Return:</comment>
  <info>string|false</info>  Data with embedded signature(s) on success ou <info>false</info> si une erreur survient.


id: rnp_op_sign_cleartext
type: function
doc:
<comment>Description:</comment>
  Perform signing operation on a textual data, return cleartext signed message

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>      L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$data</strong>     Data to be signed.
  <info>array</info>   <strong>$keys_fp</strong>  Array with key fingerprints. At least one key must be provided. Keys should be
                    present in <strong>$ffi</strong>.
  <info>array</info>   <strong>$options</strong>  An associative array with options.

<comment>Return:</comment>
  <info>string|false</info>  Cleartext signed message containing source data with additional headers and
                ASCII-armored signature on success ou <info>false</info> si une erreur survient.


id: rnp_op_sign_detached
type: function
doc:
<comment>Description:</comment>
  Perform signing operation, return detached signature(s)

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>      L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$data</strong>     Data to be signed.
  <info>array</info>   <strong>$keys_fp</strong>  Array with key fingerprints. At least one key must be provided. Keys should be
                    present in <strong>$ffi</strong>.
  <info>array</info>   <strong>$options</strong>  An associative array with options.

<comment>Return:</comment>
  <info>string|false</info>  Detached signature(s) data on success ou <info>false</info> si une erreur survient.


id: rnp_op_verify
type: function
doc:
<comment>Description:</comment>
  Verify embedded or cleartext signatures

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>   L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$data</strong>  Signed data.

<comment>Return:</comment>
  <info>array|false</info>  An associative array with information about verification results ou <info>false</info> si une
               erreur survient.
               
               "signatures" sub-array.


id: rnp_op_verify_detached
type: function
doc:
<comment>Description:</comment>
  Verify detached signatures

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>        L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$data</strong>       Source data.
  <info>string</info>  <strong>$signature</strong>  Detached signature data.

<comment>Return:</comment>
  <info>array|false</info>  An associative array with information about verification results ou <info>false</info> si une
               erreur survient.
               
               "signatures" sub-array.


id: rnp_save_keys
type: function
doc:
<comment>Description:</comment>
  Save keys to PHP string
  
  Note that for G10, the output must be a directory (which must already exist).

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>     L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$format</strong>  Le format de clé pour la donnée (GPG, KBX, G10).
  <info>string</info>  <strong>$output</strong>  key packets will be saved to the string referenced by <strong>$output</strong>.
  <info>int</info>     <strong>$flags</strong>   Voir la description des drapeaux RNP_LOAD_SAVE_*.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success ou <info>false</info> si une erreur survient.


id: rnp_save_keys_to_path
type: function
doc:
<comment>Description:</comment>
  Save keys to specified path
  
  Saves keys present in the FFI object (loaded or generated) to the specified file or directory.

<comment>Param:</comment>
  <info>RnpFFI</info>  <strong>$ffi</strong>          L'objet FFI retourné par rnp_ffi_create.
  <info>string</info>  <strong>$format</strong>       Le format de clé pour la donnée (GPG, KBX, G10).
  <info>string</info>  <strong>$output_path</strong>  File or directory path where keys should be saved to.
  <info>int</info>     <strong>$flags</strong>        Voir la description des drapeaux RNP_LOAD_SAVE_*.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> on success ou <info>false</info> si une erreur survient.


id: rnp_supported_features
type: function
doc:
<comment>Description:</comment>
  Get supported features in JSON format
  
  Get the JSON formatted string containing array of supported rnp feature values (algorithms,
  curves, etc) by type.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  See RNP_FEATURE_* constants for supported values.

<comment>Return:</comment>
  <info>string|false</info>  String containing JSON formatted array of supported algorithms, curves, etc ou <info>false</info>
                si une erreur survient.


id: rnp_version_string
type: function
doc:
<comment>Description:</comment>
  RNP library version

<comment>Return:</comment>
  <info>string</info>  Returns RNP library version string.


id: rnp_version_string_full
type: function
doc:
<comment>Description:</comment>
  Full version string of RNP library

<comment>Return:</comment>
  <info>string</info>  Returns full version string of RNP library.


id: round
type: function
doc:
<comment>Description:</comment>
  Arrondit un nombre à virgule flottante
  
  Retourne la valeur arrondie de <strong>$num</strong> à la précision <strong>$precision</strong> (nombre de chiffres après la
  virgule). Le paramètre <strong>$precision</strong> peut être négatif ou <info>null</info> : c'est sa valeur par défaut.

<comment>Param:</comment>
  <info>int|float</info>  <strong>$num</strong>        La valeur à arrondir.
  <info>int</info>        <strong>$precision</strong>  Le nombre optionnel de décimales à arrondir.
                         
                         Si le paramètre <strong>$precision</strong> est positif, <strong>$num</strong> sera arrondi en utilisant le
                         paramètre <strong>$precision</strong> pour définir le nombre significatif de digits après le
                         point décimal.
                         
                         Si le paramètre <strong>$precision</strong> est négatif, <strong>$num</strong> arrondi en utilisant le
                         paramètre <strong>$precision</strong> pour définir le nombre significatif de digits avant le
                         point décimal, i.e. le multiple le plus proche de pow(10, -$precision),
                         i.e. pour une <strong>$precision</strong> de -1, <strong>$num</strong> sera arrondi à 10, pour une <strong>$precision</strong>
                         de -2 à 100, etc.
  <info>int</info>        <strong>$mode</strong>       Utilisez une des constantes suivantes pour spécifier le mode d'arrondi.
                         ConstantesDescription<info>PHP_ROUND_HALF_UP</info> Arrondit <strong>$num</strong> en s'éloignant de zéro
                         lorsqu'il est à mi-chemin, arrondissant ainsi 1.5 à 2, et -1.5 à -2.
                         <info>PHP_ROUND_HALF_DOWN</info> Arrondit <strong>$num</strong> en se rapprochant de zéro lorsqu'il est à
                         mi-chemin, arrondissant ainsi 1.5 à 1, et -1.5 à -1. <info>PHP_ROUND_HALF_EVEN</info>
                         Arrondit <strong>$num</strong> à la valeur paire la plus proche lorsqu'il est à mi-chemin,
                         arrondissant ainsi 1.5 et 2.5 à 2. <info>PHP_ROUND_HALF_ODD</info> Arrondit <strong>$num</strong> à la
                         valeur impaire la plus proche lorsqu'il est à mi-chemin, arrondissant ainsi
                         1.5 à 1 et 2.5 à 3.

<comment>Return:</comment>
  <info>float</info>  La valeur arrondie à la <strong>$precision</strong> donnée en tant que nombre décimal.

<comment>See Also:</comment>
   * <strong>ceil()</strong>
   * <strong>floor()</strong>
   * <strong>number_format()</strong>


id: rpmaddtag
type: function
doc:
<comment>Description:</comment>
  Add tag retrieved in query
  
  Add an additional retrieved tag in subsequent queries.

<comment>Param:</comment>
  <info>int</info>  <strong>$tag</strong>  One of RPMTAG_* constant, see the rpminfo constants page.

<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>rpminfo()</strong>
   * <strong>rpmdbinfo()</strong>
   * <strong>rpmdbsearch()</strong>


id: rpmdbinfo
type: function
doc:
<comment>Description:</comment>
  Get information from installed RPM
  
  Retrieve information about an installed package, from the system RPM database.

<comment>Param:</comment>
  <info>string</info>  <strong>$nevr</strong>  Name with optional epoch, version and release.
  <info>bool</info>    <strong>$full</strong>  If <info>true</info> all information headers for the file are retrieved, else only a minimal
                 set.

<comment>Return:</comment>
  <info>array|null</info>  An <info>array</info> of <info>array</info> of information or NULL on error.

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


id: rpmdbsearch
type: function
doc:
<comment>Description:</comment>
  Search RPM packages
  
  Search packages in the system RPM database.

<comment>Param:</comment>
  <info>string</info>  <strong>$pattern</strong>  Value to search for.
  <info>int</info>     <strong>$rpmtag</strong>   Search criterion, one of RPMTAG_* constant, see the rpminfo constants page.
  <info>int</info>     <strong>$rpmmire</strong>  Pattern type, one of RPMMIRE_* constant, see the rpminfo constants page. When
                    \< 0 the criterion must equals the value, and database index is used if possible.
  <info>bool</info>    <strong>$full</strong>     If <info>true</info> all information headers for the file are retrieved, else only a minimal
                    set.

<comment>Return:</comment>
  <info>array|null</info>  An <info>array</info> of <info>array</info> of information or NULL on error.

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


id: rpmgetsymlink
type: function
doc:
<comment>Description:</comment>
  Get target of a symlink
  
  Get target of a symlink.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Path of the RPM file.
  <info>string</info>  <strong>$name</strong>  Name of the symlink file.

<comment>Return:</comment>
  <info>string|null</info>  A <info>string</info> with target of the symlink, NULL on error, or an empty string if not a
               symlink.


id: rpminfo
type: function
doc:
<comment>Description:</comment>
  Get information from a RPM file
  
  Retrieve information about a local file, a RPM package.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>   Path of the RPM file.
  <info>bool</info>    <strong>$full</strong>   If <info>true</info> all information headers for the file are retrieved, else only a minimal
                  set.
  <info>string</info>  <strong>$error</strong>  If provided, will receive the possible error message, and will avoid a runtime
                  warning.

<comment>Return:</comment>
  <info>array|null</info>  An <info>array</info> of information or NULL on error.

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


id: rpmvercmp
type: function
doc:
<comment>Description:</comment>
  RPM version comparison
  
  Compare 2 RPM versions.

<comment>Param:</comment>
  <info>string</info>       <strong>$evr1</strong>      First epoch:version-release string
  <info>string</info>       <strong>$evr2</strong>      Second epoch:version-release string
  <info>string|null</info>  <strong>$operator</strong>  An optional operator. The possible operators are: <return>\<</return>, <return>lt</return>, <return>\<=</return>, <return>le</return>, <return>&gt;</return>, <return>gt</return>, <return>&gt;=</return>, <return>ge</return>, <return>==</return>, <return>=</return>, <return>eq</return>, <return>!=</return>, <return>\<&gt;</return>, <return>ne</return> respectively.
                          
                          This parameter is case-sensitive, values should be lowercase.

<comment>Return:</comment>
  <info>int|bool</info>  Returns
            \< 0 if evr1 is less than evr2, &gt; 0 if evr1 is greater than evr2, and 0 if they are equal.
            
            When using the optional <strong>$operator</strong> argument, the function will return <info>true</info> if the
            relationship is the one specified by the operator, <info>false</info> otherwise.


id: rrd_create
type: function
doc:
<comment>Description:</comment>
  Crée un fichier de base de données rrd
  
  Crée un fichier de base de données rrd.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Nom de fichier du nouveau fichier rrd.
  <info>array</info>   <strong>$options</strong>   Options pour la création rrd - listes de chaînes. Reportez-vous à la page man
                     de rrd pour une liste complète des options disponibles pour la création.

<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: rrd_error
type: function
doc:
<comment>Description:</comment>
  Récupère le message de la dernière erreur survenue
  
  Récupère le message de la dernière erreur survenue.

<comment>Return:</comment>
  <info>string</info>  Le dernier message d'erreur.


id: rrd_fetch
type: function
doc:
<comment>Description:</comment>
  Récupère les données pour le graphique
  
  Récupère les données pour le graphique depuis le fichier de base de données RRD sous la forme d'un
  tableau. Cette fonction a le même résultat que la fonction <strong>rrd_graph()</strong>, mais les données
  récupérées sont retournées sous la forme d'un tableau, aucun fichier image n'est créé.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Nom de fichier de la base de données RRD.
  <info>array</info>   <strong>$options</strong>   Tableau d'options pour la spécification de la résolution.

<comment>Return:</comment>
  <info>array</info>  Retourne des informations sur les données de graphique récupérées.


id: rrd_first
type: function
doc:
<comment>Description:</comment>
  Récupère le timestamp  du premier échantillon depuis le fichier RRD
  
  Retourne les données du premier échantillon depuis le RRD spécifié du fichier RRD.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>      Nom de fichier de la base de données RRD.
  <info>int</info>     <strong>$raaindex</strong>  Le numéro d'index du RRA à examiner. La valeur par défaut est 0.

<comment>Return:</comment>
  <info>int</info>  Timestamp unix, ou <info>false</info> si une erreur survient.


id: rrd_graph
type: function
doc:
<comment>Description:</comment>
  Crée une image depuis des données
  
  Crée une image depuis un fichier RRD.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le nom du fichier dans lequel le graphique sera redirigé. Il se termine
                     normalement par l'extension <return>.png</return>, <return>.svg</return> ou <return>.eps</return>, suivant le format de sortie
                     désiré.
  <info>array</info>   <strong>$options</strong>   Options pour la génération de l'image. Reportez-vous à la page man du graphique
                     RRD pour toutes les options possibles. Toutes les options (définitions de
                     données, définitions des variables, etc.) sont autorisées.

<comment>Return:</comment>
  <info>array</info>  Tableau contenant les informations sur l'image générée, ou <info>false</info> si une erreur survient.


id: rrd_info
type: function
doc:
<comment>Description:</comment>
  Récupère les informations sur un fichier RRD
  
  Retourne les informations sur un fichier de base de données RRD.

<comment>Param:</comment>
  <info></info>  <strong>$file</strong>  Nom de fichier de la base de données RRD.

<comment>Return:</comment>
  <info>array</info>  Tableau contenant les informations sur le fichier RRD demandé, ou <info>false</info> si une erreur
         survient.


id: rrd_last
type: function
doc:
<comment>Description:</comment>
  Récupère le timestamp unix du premier échantillon
  
  Retourne le timestamp UNIX de la mise à jour la plus récente de la base de données RRD.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Nom de fichier de la base de données RRD.

<comment>Return:</comment>
  <info>int</info>  Timestamp Unix des données les plus récentes de la base de données RRD.


id: rrd_lastupdate
type: function
doc:
<comment>Description:</comment>
  Récupère les informations sur les dernières données mises à jour
  
  Récupère un tableau de timestamp unix et les valeurs stockées pour chaque date de la dernière mise
  à jour du fichier de base de données RRD.

<comment>Param:</comment>
  <info></info>  <strong>$file</strong>  Nom de fichier de la base de données RRD.

<comment>Return:</comment>
  <info>array</info>  Tableau d'informations sur la dernière mise à jour, ou <info>false</info> si une erreur survient.


id: rrd_restore
type: function
doc:
<comment>Description:</comment>
  Restaure le fichier RRD depuis une sauvegarde XML
  
  Restaure le fichier RRD depuis une sauvegarde XML.

<comment>Param:</comment>
  <info>string</info>  <strong>$xml_file</strong>  Nom de fichier XML de la sauvegarde du fichier original de base de données RRD.
  <info>string</info>  <strong>$rrd_file</strong>  Nom du fichier de la base de données RRD qui sera restauré.
  <info>array</info>   <strong>$options</strong>   Tableau d'options pour la restauration. Reportez-vous à la page man de la
                     restauration RRD.

<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: rrd_tune
type: function
doc:
<comment>Description:</comment>
  Affine des options d'en-tête d'un fichier de base de données RRD
  
  Modifie quelques options de l'en-tête d'un fichier de base de données RRD, comme le fait de
  renommer la source des données.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Nom du fichier de la base de données RRD.
  <info>array</info>   <strong>$options</strong>   Options avec les propriétés du fichier de la base de données RRD qui doivent
                     être modifiés. Reportez-vous à la page man correspondante de RRD pour plus de
                     détails.

<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: rrd_update
type: function
doc:
<comment>Description:</comment>
  Met à jour une base de données RRD
  
  Met à jour le fichier d'une base de données RRD. Les données d'entrée sont la date/heure,
  interpolée suivant les propriétés du fichier de la base de données RRD.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Nom du fichier de la base de données RRD. Cette base de données sera mise à
                     jour.
  <info>array</info>   <strong>$options</strong>   Options pour la mise à jour de la base de données RRD -  liste de chaînes.
                     Reportez-vous à la page man correspondante pour une liste complète des options.

<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: rrd_version
type: function
doc:
<comment>Description:</comment>
  Récupère les informations de version de la bibliothèque rrdtool
  
  Récupère les informations de version de la bibliothèque rrdtool.

<comment>Return:</comment>
  <info>string</info>  Une chaîne de caractères contenant le numéro de version de la bibliothèque rrdtool i.e.
          "1.4.3".


id: rrd_xport
type: function
doc:
<comment>Description:</comment>
  Exporte les informations d'une base de données
  
  Exporte les informations d'un fichier de base de données RRD. Ces données peuvent être converties
  en fichier XML via un script PHP de l'espace utilisateur puis, être utilisées pour restaurer le
  fichier de base de données RRD.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  Tableau d'options pour l'exportation ; reportez-vous à la page man
                   correspondante.

<comment>Return:</comment>
  <info>array</info>  Tableau contenant les informations du fichier de base de données RRD, ou <info>false</info> si une
         erreur survient.


id: rrdc_disconnect
type: function
doc:
<comment>Description:</comment>
  Ferme toutes les connexions vers le daemon de mise en cache rrd
  
  Ferme toutes les connexions vers le daemon de mise en cache rrd.
  
  Cette fonction est automatiquement appelée lorsque le processus global PHP se termine. Cela dépend
  de l'API utilisée. Par exemple, cette fonction est appelée automatiquement à la fin d'un script en
  ligne de commande.
  
  Il en est de l'utilisateur que de vouloir appeler cette fonction à la fin de chaque requête ou
  non.

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


id: rsort
type: function
doc:
<comment>Description:</comment>
  Trie un tableau en ordre décroissant
  
  Trie <strong>$array</strong> sur place suivant les valeurs en ordre décroissant.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.
  
  Cette fonction assigne de nouvelles clés aux éléments dans <strong>$array</strong>. Elle effacera toutes les clés
  existantes qui ont pu être assignées, plutôt que de réarranger les clés.
  
  Réinitialise le pointeur interne du tableau au premier élément.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Le tableau d'entrée.
  <info>int</info>    <strong>$flags</strong>  Le deuxième paramètre optionnel <strong>$flags</strong> peut être utilisé pour modifier le
                 comportement de tri en utilisant ces valeurs :
                 
                 Type de drapeaux de tri : <info>SORT_REGULAR</info> - compare items normally; the details are
                 described in the comparison operators section<info>SORT_NUMERIC</info> - compare les éléments
                 numériquement<info>SORT_STRING</info> - compare les éléments comme des chaînes de
                 caractères<info>SORT_LOCALE_STRING</info> - compare les éléments comme des chaînes de
                 caractères, basé sur la locale courante. Ceci utilise la locale, qui peut être
                 changée en utilisant <strong>setlocale()</strong> <info>SORT_NATURAL</info> - compare les éléments comme des
                 chaînes de caractères utilisant "l'ordre naturel" comme <strong>natsort()</strong> <info>SORT_FLAG_CASE</info> -
                 peut être combiné (OU bit à bit) avec <info>SORT_STRING</info> ou <info>SORT_NATURAL</info> pour trier les
                 chaînes sans tenir compte de la casse
                 
                 <info>SORT_REGULAR</info> - compare items normally; the details are described in the comparison
                 operators section
                 
                 <info>SORT_NUMERIC</info> - compare les éléments numériquement
                 
                 <info>SORT_STRING</info> - compare les éléments comme des chaînes de caractères
                 
                 <info>SORT_LOCALE_STRING</info> - compare les éléments comme des chaînes de caractères, basé sur
                 la locale courante. Ceci utilise la locale, qui peut être changée en utilisant
                 <strong>setlocale()</strong>
                 
                 <info>SORT_NATURAL</info> - compare les éléments comme des chaînes de caractères utilisant
                 "l'ordre naturel" comme <strong>natsort()</strong>
                 
                 <info>SORT_FLAG_CASE</info> - peut être combiné (OU bit à bit) avec <info>SORT_STRING</info> ou <info>SORT_NATURAL</info>
                 pour trier les chaînes sans tenir compte de la casse

<comment>Return:</comment>
  <info>true</info>  Retourne toujours <info>true</info>.

<comment>See Also:</comment>
   * <strong>sort()</strong>
   * <strong>arsort()</strong>
   * <strong>krsort()</strong>
   * Les fonctions de tri des tableaux


id: rtrim
type: function
doc:
<comment>Description:</comment>
  Supprime les espaces (ou d'autres caractères) de fin de chaîne
  
  Retourne la chaîne <strong>$string</strong>, après avoir supprimé tous les caractères blancs (ou autres caractères)
  de fin de chaîne.
  
  Appelée sans le second paramètre, <strong>rtrim()</strong> supprimera les caractères suivants :  " " (ASCII <return>32</return>
  (<return>0x20</return>)), un espace ordinaire.  "\t" (ASCII <return>9</return> (<return>0x09</return>)), une tabulation.  "\n" (ASCII <return>10</return> (<return>0x0A</return>)), une
  nouvelle ligne (<return>line feed</return>).  "\r" (ASCII <return>13</return> (<return>0x0D</return>)), un retour chariot (<return>carriage return</return>).  "\0"
  (ASCII <return>0</return> (<return>0x00</return>)), le caractère <return>NULL</return>.  "\v" (ASCII <return>11</return> (<return>0x0B</return>)), une tabulation verticale.
  
  " " (ASCII <return>32</return> (<return>0x20</return>)), un espace ordinaire.
  
  "\t" (ASCII <return>9</return> (<return>0x09</return>)), une tabulation.
  
  "\n" (ASCII <return>10</return> (<return>0x0A</return>)), une nouvelle ligne (<return>line feed</return>).
  
  "\r" (ASCII <return>13</return> (<return>0x0D</return>)), un retour chariot (<return>carriage return</return>).
  
  "\0" (ASCII <return>0</return> (<return>0x00</return>)), le caractère <return>NULL</return>.
  
  "\v" (ASCII <return>11</return> (<return>0x0B</return>)), une tabulation verticale.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>      La chaîne d'entrée.
  <info>string</info>  <strong>$characters</strong>  Il est aussi possible de spécifier les caractères à supprimer en utilisant le
                       paramètre <strong>$characters</strong>. Listez simplement les caractères que vous voulez
                       supprimer dans ce paramètre. Avec <return>..</return>, vous pourrez spécifier des intervalles
                       de caractères.

<comment>Return:</comment>
  <info>string</info>  Retourne la chaîne modifiée.

<comment>See Also:</comment>
   * <strong>trim()</strong>
   * <strong>ltrim()</strong>


id: runkit7_constant_add
type: function
doc:
<comment>Description:</comment>
  Similar to define(), but allows defining in class definitions as well

<comment>Param:</comment>
  <info>string</info>  <strong>$constant_name</strong>  Name of constant to declare.  Either a string to indicate a global
                          constant, or <return>classname::constname</return> to indicate a class constant.
  <info>mixed</info>   <strong>$value</strong>          NULL, Bool, Long, Double, String, Array, or Resource value to store in the
                          new constant.
  <info>int</info>     <strong>$newVisibility</strong>  Visibility of the constant, for class constants. Public by default. One of
                          the <info>RUNKIT7_ACC_*</info> constants.

<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>define()</strong>
   * <strong>runkit7_constant_redefine()</strong>
   * <strong>runkit7_constant_remove()</strong>


id: runkit7_constant_redefine
type: function
doc:
<comment>Description:</comment>
  Redefine an already defined constant

<comment>Param:</comment>
  <info>string</info>  <strong>$constant_name</strong>   Constant to redefine.  Either the name of a global constant, or
                           <return>classname::constname</return> indicating class constant.
  <info>mixed</info>   <strong>$value</strong>           Value to assign to the constant.
  <info>int</info>     <strong>$new_visibility</strong>  The new visibility of the constant, for class constants. Unchanged by
                           default. One of the <info>RUNKIT7_ACC_*</info> constants.

<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>runkit7_constant_add()</strong>
   * <strong>runkit7_constant_remove()</strong>


id: runkit7_constant_remove
type: function
doc:
<comment>Description:</comment>
  Remove/Delete an already defined constant

<comment>Param:</comment>
  <info>string</info>  <strong>$constant_name</strong>  Name of the constant to remove.  Either the name of a global constant, or
                          <return>classname::constname</return> indicating a class constant.

<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>define()</strong>
   * <strong>runkit7_constant_add()</strong>
   * <strong>runkit7_constant_redefine()</strong>


id: runkit7_function_add
type: function
doc:
<comment>Description:</comment>
  Add a new function, similar to create_function

<comment>Param:</comment>
  <info>string</info>   <strong>$function_name</strong>        Name of the function to be created
  <info>string</info>   <strong>$argument_list</strong>        Comma separated argument list
  <info>string</info>   <strong>$code</strong>                 Code making up the function
  <info>Closure</info>  <strong>$closure</strong>              A <class>closure</class> that defines the function.
  <info>bool</info>     <strong>$return_by_reference</strong>  Whether the function should return by reference.
  <info>string</info>   <strong>$doc_comment</strong>          The doc comment of the function.
  <info>string</info>   <strong>$return_type</strong>          The return type of the function.
  <info>bool</info>     <strong>$is_strict</strong>            Whether the function should behave as if it were declared in a file
                                 with <return>strict_types=1</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>create_function()</strong>
   * <strong>runkit7_function_redefine()</strong>
   * <strong>runkit7_function_copy()</strong>
   * <strong>runkit7_function_rename()</strong>
   * <strong>runkit7_function_remove()</strong>
   * <strong>runkit7_method_add()</strong>


id: runkit7_function_copy
type: function
doc:
<comment>Description:</comment>
  Copy a function to a new function name

<comment>Param:</comment>
  <info>string</info>  <strong>$source_name</strong>  Name of the existing function
  <info>string</info>  <strong>$target_name</strong>  Name of the new function to copy the definition to

<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>runkit7_function_add()</strong>
   * <strong>runkit7_function_redefine()</strong>
   * <strong>runkit7_function_rename()</strong>
   * <strong>runkit7_function_remove()</strong>


id: runkit7_function_redefine
type: function
doc:
<comment>Description:</comment>
  Replace a function definition with a new implementation
    
  
  Par défaut, seulement les fonctions définies par l'utilisateur peuvent être supprimées, renommées
  ou modifiées. Afin de surcharger des fonctions internes, vous devez activer la configuration
  <return>runkit.internal_override</return> dans le fichier php.ini du système entier.

<comment>Param:</comment>
  <info>string</info>   <strong>$function_name</strong>        Name of function to redefine
  <info>string</info>   <strong>$argument_list</strong>        New list of arguments to be accepted by function
  <info>string</info>   <strong>$code</strong>                 New code implementation
  <info>Closure</info>  <strong>$closure</strong>              A <class>closure</class> that defines the function.
  <info>bool</info>     <strong>$return_by_reference</strong>  Whether the function should return by reference.
  <info>string</info>   <strong>$doc_comment</strong>          The doc comment of the function.
  <info>string</info>   <strong>$return_type</strong>          The return type of the function.
  <info>bool</info>     <strong>$is_strict</strong>            Whether the function behaves as if it was declared in a file with
                                 <return>strict_types=1</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>runkit7_function_add()</strong>
   * <strong>runkit7_function_copy()</strong>
   * <strong>runkit7_function_rename()</strong>
   * <strong>runkit7_function_remove()</strong>
   * <strong>runkit7_method_redefine()</strong>


id: runkit7_function_remove
type: function
doc:
<comment>Description:</comment>
  Remove a function definition
    
  
  Par défaut, seulement les fonctions définies par l'utilisateur peuvent être supprimées, renommées
  ou modifiées. Afin de surcharger des fonctions internes, vous devez activer la configuration
  <return>runkit.internal_override</return> dans le fichier php.ini du système entier.

<comment>Param:</comment>
  <info>string</info>  <strong>$function_name</strong>  Name of the function to be deleted

<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>runkit7_function_add()</strong>
   * <strong>runkit7_function_copy()</strong>
   * <strong>runkit7_function_redefine()</strong>
   * <strong>runkit7_function_rename()</strong>


id: runkit7_function_rename
type: function
doc:
<comment>Description:</comment>
  Change a function's name
    
  
  Par défaut, seulement les fonctions définies par l'utilisateur peuvent être supprimées, renommées
  ou modifiées. Afin de surcharger des fonctions internes, vous devez activer la configuration
  <return>runkit.internal_override</return> dans le fichier php.ini du système entier.

<comment>Param:</comment>
  <info>string</info>  <strong>$source_name</strong>  Current function name
  <info>string</info>  <strong>$target_name</strong>  New function name

<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>runkit7_function_add()</strong>
   * <strong>runkit7_function_copy()</strong>
   * <strong>runkit7_function_redefine()</strong>
   * <strong>runkit7_function_remove()</strong>


id: runkit7_import
type: function
doc:
<comment>Description:</comment>
  Process a PHP file importing function and class definitions, overwriting where appropriate
    
  
  Similar to <strong>include()</strong>. However, any code residing outside of a function or class is simply ignored.
  Additionally, depending on the value of <strong>$flags</strong>, any functions or classes which already exist in
  the currently running environment may be automatically overwritten by their new definitions.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Filename to import function and class definitions from
  <info>int</info>     <strong>$flags</strong>     Bitwise OR of the <return>RUNKIT7_IMPORT_*</return> family of constants.

<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: runkit7_method_add
type: function
doc:
<comment>Description:</comment>
  Dynamically adds a new method to a given class

<comment>Param:</comment>
  <info>string</info>   <strong>$class_name</strong>     The class to which this method will be added
  <info>string</info>   <strong>$method_name</strong>    The name of the method to add
  <info>string</info>   <strong>$argument_list</strong>  Comma-delimited list of arguments for the newly-created method
  <info>string</info>   <strong>$code</strong>           The code to be evaluated when <strong>$method_name</strong> is called
  <info>Closure</info>  <strong>$closure</strong>        A <class>closure</class> that defines the method.
  <info>int</info>      <strong>$flags</strong>          The type of method to create, can be <info>RUNKIT7_ACC_PUBLIC</info>,
                           <info>RUNKIT7_ACC_PROTECTED</info> or <info>RUNKIT7_ACC_PRIVATE</info> optionally combined via
                           bitwise OR with <info>RUNKIT7_ACC_STATIC</info>
  <info>string</info>   <strong>$doc_comment</strong>    The doc comment of the method.
  <info>string</info>   <strong>$return_type</strong>    The return type of the method.
  <info>bool</info>     <strong>$is_strict</strong>      Whether the method behaves as if it were declared in a file with
                           <return>strict_types=1</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>runkit7_method_copy()</strong>
   * <strong>runkit7_method_redefine()</strong>
   * <strong>runkit7_method_remove()</strong>
   * <strong>runkit7_method_rename()</strong>
   * <strong>runkit7_function_add()</strong>


id: runkit7_method_copy
type: function
doc:
<comment>Description:</comment>
  Copies a method from class to another

<comment>Param:</comment>
  <info>string</info>  <strong>$destination_class</strong>        Destination class for copied method
  <info>string</info>  <strong>$destination_method_name</strong>  Destination method name
  <info>string</info>  <strong>$source_class</strong>             Source class of the method to copy
  <info>string</info>  <strong>$source_method_name</strong>       Name of the method to copy from the source class. If this
                                    parameter is omitted, the value of <strong>$destination_method_name</strong> is
                                    assumed.

<comment>Return:</comment>
  <info>bool</info>  

<comment>See Also:</comment>
   * <strong>runkit7_method_add()</strong>
   * <strong>runkit7_method_redefine()</strong>
   * <strong>runkit7_method_remove()</strong>
   * <strong>runkit7_method_rename()</strong>
   * <strong>runkit7_function_copy()</strong>


id: runkit7_method_redefine
type: function
doc:
<comment>Description:</comment>
  Dynamically changes the code of the given method

<comment>Param:</comment>
  <info>string</info>   <strong>$class_name</strong>     The class in which to redefine the method
  <info>string</info>   <strong>$method_name</strong>    The name of the method to redefine
  <info>string</info>   <strong>$argument_list</strong>  Comma-delimited list of arguments for the redefined method
  <info>string</info>   <strong>$code</strong>           The new code to be evaluated when <strong>$method_name</strong> is called
  <info>Closure</info>  <strong>$closure</strong>        A <class>closure</class> that defines the method.
  <info>int</info>      <strong>$flags</strong>          The redefined method can be <info>RUNKIT7_ACC_PUBLIC</info>, <info>RUNKIT7_ACC_PROTECTED</info> or
                           <info>RUNKIT7_ACC_PRIVATE</info> optionally combined via bitwise OR with
                           <info>RUNKIT7_ACC_STATIC</info>
  <info>string</info>   <strong>$doc_comment</strong>    The doc comment of the method.
  <info>string</info>   <strong>$return_type</strong>    The return type of the method.
  <info>bool</info>     <strong>$is_strict</strong>      Whether the method behaves as if it was declared in a file with
                           <return>strict_types=1</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>runkit7_method_add()</strong>
   * <strong>runkit7_method_copy()</strong>
   * <strong>runkit7_method_remove()</strong>
   * <strong>runkit7_method_rename()</strong>
   * <strong>runkit7_function_redefine()</strong>


id: runkit7_method_remove
type: function
doc:
<comment>Description:</comment>
  Dynamically removes the given method
  
  Cette fonction ne peut être utilisée pour manipuler la méthode en cours d'utilisation (ou
  chaînée).

<comment>Param:</comment>
  <info>string</info>  <strong>$class_name</strong>   The class in which to remove the method
  <info>string</info>  <strong>$method_name</strong>  The name of the method to remove

<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>runkit7_method_add()</strong>
   * <strong>runkit7_method_copy()</strong>
   * <strong>runkit7_method_redefine()</strong>
   * <strong>runkit7_method_rename()</strong>
   * <strong>runkit7_function_remove()</strong>


id: runkit7_method_rename
type: function
doc:
<comment>Description:</comment>
  Dynamically changes the name of the given method
  
  Cette fonction ne peut être utilisée pour manipuler la méthode en cours d'utilisation (ou
  chaînée).

<comment>Param:</comment>
  <info>string</info>  <strong>$class_name</strong>          The class in which to rename the method
  <info>string</info>  <strong>$source_method_name</strong>  The name of the method to rename
  <info>string</info>  <strong>$target_method_name</strong>  The new name to give to the renamed method

<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>runkit7_method_add()</strong>
   * <strong>runkit7_method_copy()</strong>
   * <strong>runkit7_method_redefine()</strong>
   * <strong>runkit7_method_remove()</strong>
   * <strong>runkit7_function_rename()</strong>


id: runkit7_object_id
type: function
doc:
<comment>Description:</comment>
  Return the integer object handle for given object
    
  
  This function is equivalent to <strong>spl_object_id()</strong>.
  
  This function returns a unique identifier for the object. The object id is unique for the lifetime
  of the object. Once the object is destroyed, its id may be reused for other objects. This behavior
  is similar to <strong>spl_object_hash()</strong>.

<comment>Param:</comment>
  <info>object</info>  <strong>$obj</strong>  Any object.

<comment>Return:</comment>
  <info>int</info>  An integer identifier that is unique for each currently existing object and is always the
       same for each object.

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


id: runkit7_superglobals
type: function
doc:
<comment>Description:</comment>
  Return numerically indexed array of registered superglobals

<comment>Return:</comment>
  <info>array</info>  Returns a numerically indexed array of the currently registered superglobals. i.e. _GET,
         _POST, _REQUEST, _COOKIE, _SESSION, _SERVER, _ENV, _FILES

<comment>See Also:</comment>
   * Variable Scope


id: runkit7_zval_inspect
type: function
doc:
<comment>Description:</comment>
  Returns information about the passed in value with data types, reference counts, etc

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  The value to return the representation of

<comment>Return:</comment>
  <info>array</info>  The array returned by this function contains the following elements: <return>address</return><return>refcount</return>
         (optional)<return>is_ref</return> (optional)<return>type</return>

<comment>See Also:</comment>
   * References Explained
   * References Explained (by Derick Rethans)


id: sapi_windows_cp_conv
type: function
doc:
<comment>Description:</comment>
  Convert string from one codepage to another
  
  Convert string from one codepage to another.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$in_codepage</strong>   The codepage of the <strong>$subject</strong> string. Either the codepage name or
                             identifier.
  <info>int|string</info>  <strong>$out_codepage</strong>  The codepage to convert the <strong>$subject</strong> string to. Either the codepage
                             name or identifier.
  <info>string</info>      <strong>$subject</strong>       The string to convert.

<comment>Return:</comment>
  <info>string|null</info>  The <strong>$subject</strong> string converted to <strong>$out_codepage</strong>, or <info>null</info> on failure.

<comment>See Also:</comment>
   * <strong>sapi_windows_cp_get()</strong>
   * <strong>iconv()</strong>


id: sapi_windows_cp_get
type: function
doc:
<comment>Description:</comment>
  Get current codepage
  
  Gets the current codepage.

<comment>Param:</comment>
  <info>string</info>  <strong>$kind</strong>  The kind of operating system codepage to get, either <return>'ansi'</return> or <return>'oem'</return>. Any other
                 value refers to the current codepage of the process.

<comment>Return:</comment>
  <info>int</info>  If <strong>$kind</strong> is <return>'ansi'</return>, the current ANSI code page of the operating system is returned. If <strong>$kind</strong>
       is <return>'oem'</return>, the current OEM code page of the operating system is returned. Otherwise, the
       current codepage of the process is returned.

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


id: sapi_windows_cp_is_utf8
type: function
doc:
<comment>Description:</comment>
  Indicates whether the codepage is UTF-8 compatible
  
  Indicates whether the codepage of the current process is UTF-8 compatible.

<comment>Return:</comment>
  <info>bool</info>  Returns whether the codepage of the current process is UTF-8 compatible.

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


id: sapi_windows_cp_set
type: function
doc:
<comment>Description:</comment>
  Set process codepage
  
  Set the codepage of the current process.

<comment>Param:</comment>
  <info>int</info>  <strong>$codepage</strong>  A codepage identifier.

<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>sapi_windows_cp_get()</strong>


id: sapi_windows_generate_ctrl_event
type: function
doc:
<comment>Description:</comment>
  Send a CTRL event to another process
  
  Sends a CTRL event to another process in the same process group.

<comment>Param:</comment>
  <info>int</info>  <strong>$event</strong>  The <return>CTRL</return> event to send; either <info>PHP_WINDOWS_EVENT_CTRL_C</info> or
               <info>PHP_WINDOWS_EVENT_CTRL_BREAK</info>.
  <info>int</info>  <strong>$pid</strong>    The ID of the process to which to send the event to. If <return>0</return> is given, the event is sent
               to all processes of the process group.

<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>proc_open()</strong>
   * <strong>sapi_windows_set_ctrl_handler()</strong>


id: sapi_windows_set_ctrl_handler
type: function
doc:
<comment>Description:</comment>
  Set or remove a CTRL event handler
  
  Sets or removes a <return>CTRL</return> event handler, which allows Windows CLI processes to intercept or ignore
  <return>CTRL+C</return> and <return>CTRL+BREAK</return> events. Note that in multithreaded environments, this is only possible when
  called from the main thread.

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$handler</strong>  A callback function to set or remove. If set, this function will be
                           called whenever a <return>CTRL+C</return> or <return>CTRL+BREAK</return> event occurs. The function is
                           supposed to have the following signature: <info>void</info>handler<info>int</info><strong>$event</strong> <strong>$event</strong> The
                           <return>CTRL</return> event which has been received; either <info>PHP_WINDOWS_EVENT_CTRL_C</info> or
                           <info>PHP_WINDOWS_EVENT_CTRL_BREAK</info>.  Setting a <info>null</info> <strong>$handler</strong> causes the process
                           to ignore <return>CTRL+C</return> events, but not <return>CTRL+BREAK</return> events.
                           
                           The <return>CTRL</return> event which has been received; either <info>PHP_WINDOWS_EVENT_CTRL_C</info>
                           or <info>PHP_WINDOWS_EVENT_CTRL_BREAK</info>.
  <info>int</info>            <strong>$event</strong>    The <return>CTRL</return> event which has been received; either <info>PHP_WINDOWS_EVENT_CTRL_C</info>
                           or <info>PHP_WINDOWS_EVENT_CTRL_BREAK</info>.
  <info>bool</info>           <strong>$add</strong>      If <info>true</info>, the handler is set. If <info>false</info>, the handler is removed.

<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>sapi_windows_generate_ctrl_event()</strong>


id: sapi_windows_vt100_support
type: function
doc:
<comment>Description:</comment>
  Get or set VT100 support for the specified stream associated to an output buffer of a Windows
  console.
  
  If <strong>$enable</strong> is <info>null</info>, the function returns <info>true</info> if the stream <strong>$stream</strong> has VT100 control codes
  enabled, <info>false</info> otherwise.
  
  If <strong>$enable</strong> is a <info>bool</info>, the function will try to enable or disable the VT100 features of the stream
  <strong>$stream</strong>. If the feature has been successfully enabled (or disabled), the function will return
  <info>true</info>, or <info>false</info> otherwise.
  
  At startup, PHP tries to enable the VT100 feature of the <info>STDOUT</info>/<info>STDERR</info> streams. By the way, if
  those streams are redirected to a file, the VT100 features may not be enabled.
  
  If VT100 support is enabled, it is possible to use control sequences as they are known from the
  VT100 terminal.  They allow the modification of the terminal's output. On Windows these sequences
  are called Console Virtual Terminal Sequences.
  
  This function uses the <info>ENABLE_VIRTUAL_TERMINAL_PROCESSING</info> flag implemented in the Windows 10 API,
  so the VT100 feature may not be available on older Windows versions.

<comment>Param:</comment>
  <info>resource</info>   <strong>$stream</strong>  The stream on which the function will operate.
  <info>bool|null</info>  <strong>$enable</strong>  If <info>bool</info>, the VT100 feature will be enabled (if <info>true</info>) or disabled (if <info>false</info>).

<comment>Return:</comment>
  <info>bool</info>  If <strong>$enable</strong> is <info>null</info>: returns <info>true</info> if the VT100 feature is enabled, <info>false</info> otherwise.
        
        If <strong>$enable</strong> is a <info>bool</info>: Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur
        survient.


id: scandir
type: function
doc:
<comment>Description:</comment>
  Liste les fichiers et dossiers dans un dossier
    
  
  Retourne un tableau de fichier et dossier, issus de <strong>$directory</strong>.

<comment>Param:</comment>
  <info>string</info>         <strong>$directory</strong>      Le dossier qui sera analysé.
  <info>int</info>            <strong>$sorting_order</strong>  Par défaut, le tri est en ordre alphabétique, croissant. Si le
                                 paramètre optionnel <strong>$sorting_order</strong>  est défini à
                                 <info>SCANDIR_SORT_DESCENDING</info>, alors le tri sera en ordre alphabétique
                                 inverse. Si ce paramètre est défini à <info>SCANDIR_SORT_NONE</info>, alors le
                                 résultat ne sera pas trié.
  <info>resource|null</info>  <strong>$context</strong>        Pour une description du paramètre <strong>$context</strong>, référez-vous à la
                                 section flux de données du manuel.

<comment>Return:</comment>
  <info>array|false</info>  Retourne un tableau des fichiers en cas de succès ou <info>false</info> en cas d'échec. Si
               <strong>$directory</strong> n'est pas un dossier, alors une valeur booléenne <info>false</info> est retournée et
               une erreur de niveau <info>E_WARNING</info> est générée.

<comment>See Also:</comment>
   * <strong>opendir()</strong>
   * <strong>readdir()</strong>
   * <strong>glob()</strong>
   * <strong>is_dir()</strong>
   * <strong>sort()</strong>


id: scoutapm_get_calls
type: function
doc:
<comment>Description:</comment>
  Returns a list of instrumented calls that have occurred
  
  Returns a list of any instrumented function calls since <strong>scoutapm_get_calls()</strong> was last called. The
  list is cleared each time the function is called.

<comment>Return:</comment>
  <info>array</info>  <strong>scoutapm_get_calls()</strong> returns an array containing a list of all recorded calls to
         instrumented function calls.


id: scoutapm_list_instrumented_functions
type: function
doc:
<comment>Description:</comment>
  List functions scoutapm will instrument.
  
  Returns a list of the functions the extension will instrument.

<comment>Return:</comment>
  <info>array</info>  <strong>scoutapm_list_instrumented_functions()</strong> returns an array containing a list of all functions
         that the scoutapm extension is able to instrument in the current installation.


id: seaslog_get_author
type: function
doc:
<comment>Description:</comment>
  Get SeasLog author.

<comment>Return:</comment>
  <info>string</info>  Return SeasLog author as string.


id: seaslog_get_version
type: function
doc:
<comment>Description:</comment>
  Get SeasLog version.

<comment>Return:</comment>
  <info>string</info>  Return SeasLog version (SEASLOG_VERSION) as string.


id: sem_acquire
type: function
doc:
<comment>Description:</comment>
  Réserve un sémaphore
  
  <strong>sem_acquire()</strong> se bloque par défaut  (si nécessaire) jusqu'à ce que le sémaphore puisse être
  réservé. Un processus qui tente de réserver un sémaphore qu'il a déjà réservé restera en attente
  indéfinie, si cette acquisition excède le nombre max_acquire de réservations simultanées.
  
  À la fin d'un script, tous les sémaphores réservés mais non explicitement libérés, seront libérés
  automatiquement, et une alerte sera générée.

<comment>Param:</comment>
  <info>SysvSemaphore</info>  <strong>$semaphore</strong>     <strong>$semaphore</strong> est une ressource de sémaphore, obtenue de la fonction
                                <strong>sem_get()</strong>.
  <info>bool</info>           <strong>$non_blocking</strong>  Spécifie si le processus ne doit pas attendre l'acquisition du
                                sémaphore. Si <info>true</info>, l'appel retournera <info>false</info> immédiatement si un
                                sémaphore ne peut pas être acquis immédiatement.

<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>sem_get()</strong>
   * <strong>sem_release()</strong>


id: sem_get
type: function
doc:
<comment>Description:</comment>
  Retourne un identifiant de sémaphore
  
  <strong>sem_get()</strong> retourne un identifiant qui pourra être utilisé pour accéder à un sémaphore System V.
  
  Un deuxième appel à <strong>sem_get()</strong> avec la même clé retournera un identifiant différent, mais les deux
  identifiants permettront d'accéder au même sémaphore.
  
  Si <strong>$key</strong> est <return>0</return>, un nouvel sémaphore privé est crée pour chaque appel à <strong>sem_get()</strong>.

<comment>Param:</comment>
  <info>int</info>   <strong>$key</strong>           
  <info>int</info>   <strong>$max_acquire</strong>   Le nombre de processus qui peuvent réserver simultanément le sémaphore est
                       précisé dans le paramètre <strong>$max_acquire</strong>.
  <info>int</info>   <strong>$permissions</strong>   Les permissions du sémaphore. Actuellement, cette valeur n'est affectée que
                       si le processus est le seul processus actuellement attaché au sémaphore.
  <info>bool</info>  <strong>$auto_release</strong>  Le paramètre optionnel <strong>$auto_release</strong> spécifie si le sémaphore doit être
                       automatiquement libéré à la fermeture.

<comment>Return:</comment>
  <info>SysvSemaphore|false</info>  Retourne une ressource de sémaphore en cas de succès, et <info>false</info> en cas
                       d'erreur.

<comment>See Also:</comment>
   * <strong>sem_acquire()</strong>
   * <strong>sem_release()</strong>
   * <strong>ftok()</strong>


id: sem_release
type: function
doc:
<comment>Description:</comment>
  Libère un sémaphore
  
  <strong>sem_release()</strong> libère le sémaphore <strong>$sem_identifier</strong>, s'il a été réservé par le processus courant,
  sinon génère une erreur.
  
  Après libération du sémaphore, <strong>sem_acquire()</strong> peut être appelé pour le réserver à nouveau.

<comment>Param:</comment>
  <info>SysvSemaphore</info>  <strong>$semaphore</strong>  Un sémaphore, telle que retournée par la fonction <strong>sem_get()</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>sem_get()</strong>
   * <strong>sem_acquire()</strong>


id: sem_remove
type: function
doc:
<comment>Description:</comment>
  Détruit un sémaphore
  
  <strong>sem_remove()</strong> supprime le sémaphore donné.
  
  Après suppression du sémaphore, il n'est plus utilisable.

<comment>Param:</comment>
  <info>SysvSemaphore</info>  <strong>$semaphore</strong>  Un sémaphore, telle que retournée par la fonction <strong>sem_get()</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>sem_get()</strong>
   * <strong>sem_release()</strong>
   * <strong>sem_acquire()</strong>


id: serialize
type: function
doc:
<comment>Description:</comment>
  Génère une représentation stockable d'une valeur
  
  Retourne un tableau en chaine de caractères.
  
  C'est une technique pratique pour stocker ou passer des valeurs PHP entre scripts, sans perdre
  leur structure ni leur type.
  
  Pour récupérer une variable sérialisée et retrouver une valeur PHP, utilisez <strong>unserialize()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  La valeur à sérialiser. <strong>serialize()</strong> accepte tous les types sauf les ressources
                 ressource et certains objets (voir note ci-dessous). Vous pouvez même sérialiser un
                 tableau qui contient des références sur lui-même. Les références cycliques dans des
                 tableaux/objets seront également stockées. Toutes les autres références seront
                 perdues.
                 
                 Lors de la sérialisation d'un objet, PHP tentera d'appeler les fonctions membres
                 __serialize() ou __sleep() avant de sérialiser. Cela permet à l'objet de faire un
                 dernier nettoyage, etc. avant d'être sérialisé. De même, lorsque l'objet est
                 restauré en utilisant <strong>unserialize()</strong>, la fonction membre __unserialize() ou
                 __wakeup() est appelée.
                 
                 Les attributs privés d'un objet auront le nom de la classe préfixé au nom de
                 l'attribut ; les attributs protégés seront préfixés avec un astérisque '*'. Ces
                 valeurs préfixées ont des caractères nuls des deux cotés.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères contenant une représentation sous forme de flux d'octets
          qui peut être stocker partout.
          
          Il est à noter que c'est une chaîne binaire qui peut inclure des octets nuls, et doit donc
          être stockée et gérée comme telle. Par exemple, la sortie de <strong>serialize()</strong> doit généralement
          être stockée dans un champ de type BLOB d'une base de données, plutôt que dans un champ de
          type CHAR ou TEXT.

<comment>See Also:</comment>
   * <strong>unserialize()</strong>
   * <strong>var_export()</strong>
   * <strong>json_encode()</strong>
   * Serializing Objects
   * __sleep()
   * __wakeup()
   * __serialize()
   * __unserialize()


id: session_abort
type: function
doc:
<comment>Description:</comment>
  Abandonne les changements sur le tableau de session et termine la session
  
  <strong>session_abort()</strong> termine la session sans sauver les  données. Les valeurs originales de la session
  sont conservées.

<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>
   * $_SESSION
   * 
     La directive de configuration 
     session.auto_start
    
   * <strong>session_start()</strong>
   * <strong>session_reset()</strong>
   * <strong>session_commit()</strong>


id: session_cache_expire
type: function
doc:
<comment>Description:</comment>
  Récupère et/ou définie le délai d'expiration du cache
  
  <strong>session_cache_expire()</strong> retourne la configuration actuelle de <return>session.cache_expire</return>.
  
  Le délai d'expiration du cache est remis à sa valeur par défaut de 180, stockée dans
  session.cache_limiter, au démarrage de la requête. Par conséquent, vous devez appeler
  <strong>session_cache_expire()</strong> à chaque requête (et avant que <strong>session_start()</strong> ne soit appelée).

<comment>Param:</comment>
  <info>int|null</info>  <strong>$value</strong>  Si <strong>$value</strong> est fourni et non <info>null</info>, la configuration actuelle de cache expire sera
                    remplacée par <strong>$value</strong>.
                    
                     La directive <strong>$value</strong> n'a de valeur que si session.cache_limiter a une valeur
                    différente de <return>nocache</return>.
                    
                    La directive <strong>$value</strong> n'a de valeur que si session.cache_limiter a une valeur
                    différente de <return>nocache</return>.

<comment>Return:</comment>
  <info>int|false</info>  Retourne la configuration courante de <return>session.cache_expire</return>. La valeur retournée doit
             être lue en minutes, et vaut par défaut, 180. En cas d'échec de modification de la
             valeur, <info>false</info> est retourné.

<comment>See Also:</comment>
   * session.cache_expire
   * session.cache_limiter
   * <strong>session_cache_limiter()</strong>


id: session_cache_limiter
type: function
doc:
<comment>Description:</comment>
  Lit et/ou modifie le limiteur de cache de session
  
  <strong>session_cache_limiter()</strong> retourne la configuration courante du limiteur de cache.
  
  Le limiteur de cache contrôle les en-têtes HTTP envoyés au client. Certains en-têtes déterminent
  les règles de mise en cache de la page sur le navigateur. En configurant ce limiteur à <return>nocache</return>,
  par exemple, le navigateur ne mettra pas la page dans son cache. La valeur <return>public</return>, au contraire,
  permettra le cache. La valeur <return>private</return> désactive le cache pour le proxy et autorise le client à
  mettre en cache le contenu.
  
  En mode <return>private</return>, l'en-tête Expire envoyé au client peut poser des problèmes à certains
  navigateurs, comme, notamment, Mozilla. Vous pouvez éviter ce problème avec le mode
  <return>private_no_expire</return>. L'en-tête <return>Expire</return> n'est jamais envoyé au navigateur pour ce mode.
  
  Le fait de définir le limiteur de cache à  la valeur <return>''</return> désactivera automatiquement et totalement
  l'envoi des en-têtes de cache.
  
  Le limiteur de cache est remis à la valeur par défaut de session.cache_limiter à chaque démarrage
  de script PHP. Donc, vous devrez appeler <strong>session_cache_limiter()</strong> à chaque page, et avant
  <strong>session_start()</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$value</strong>  Si <strong>$value</strong> est fourni et non <info>null</info>, le limiteur de cache est reconfiguré avec
                       cette valeur.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le nom du limiteur de cache courant. En cas d'échec, <info>false</info> est retourné.

<comment>See Also:</comment>
   * session.cache_limiter


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


id: session_create_id
type: function
doc:
<comment>Description:</comment>
  Créer un nouvel ID de session
  
  <strong>session_create_id()</strong> est utilisé pour créer un nouvel ID de session pour la session courante. Ceci
  retourne un ID de session sans colision.
  
  Si la session n'est pas active, la vérification de colision est omise.
  
  L'ID de session est créé en accord avec les paramètres php.ini.
  
  Il est important d'utiliser le même ID utilisateur de votre serveur web pour le script de tâche de
  Ramasse-miettes (Garbage Collection). Sans quoi, vous risquez d'avoir des problèmes de permissions
  particulièrement avec les gestionnaires de sauvegarde des fichiers.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  Si <strong>$prefix</strong> est spécifié, le nouvel ID de session est préfixé par <strong>$prefix</strong>. Pas
                   tous les caractères sont autorisés dans l'ID de session. Les caractères parmi <return>a-z
                   A-Z 0-9 , (virgule) et - (moins)</return> sont autorisés..

<comment>Return:</comment>
  <info>string|false</info>  <strong>session_create_id()</strong> retourne un nouvel ID de session sans collision pour la session
                courante. Si c'est utilisé sans une session active, la vérification de collision est
                omise. En cas d'échec, <info>false</info> est retourné.

<comment>See Also:</comment>
   * <strong>session_regenerate_id()</strong>
   * <strong>session_start()</strong>
   * session.use_strict_mode
   * SessionHandler::create_sid


id: session_decode
type: function
doc:
<comment>Description:</comment>
  Décode les données encodées de session
  
  <strong>session_decode()</strong> décode les données de sessions sérialisées fournies dans le paramètre <strong>$data</strong>, et
  peuple la variable superglobale $_SESSION.
  
  Par défaut, la méthode de désérialisation utilisée,  est interne à PHP et n'est pas la même que la
  fonction <strong>unserialize()</strong>.  La méthode de sérialisation peut être définie en utilisant
  session.serialize_handler.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Les données encodées.

<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>session_encode()</strong>
   * session.serialize_handler


id: session_destroy
type: function
doc:
<comment>Description:</comment>
  Détruit une session
  
  <strong>session_destroy()</strong> détruit toutes les données associées à la session courante. Cette fonction ne
  détruit pas les variables globales associées à la session, de même, elle ne détruit pas le cookie
  de session. Pour accéder à nouveau aux variables de session, la fonction <strong>session_start()</strong> doit être
  appelée de nouveau.
  
  Vous n'avez pas besoin d'appeler <strong>session_destroy()</strong> depuis le programme généralement. Nettoyer le
  tableau $_SESSION plutôt que de détruire les données de session.
  
  Pour détruire complètement une session, l'identifiant de la session doit également être effacé. Si
  un cookie est utilisé pour propager l'identifiant de session (comportement par défaut), alors le
  cookie de session doit être effacé. La fonction <strong>setcookie()</strong> peut être utilisée pour cela.
  
  Quand session.use_strict_mode est activé. Vous n'avez pas besoin d'effacer le cookies d'ID de
  session obsolète car le module de session n'accepte pas les cookies d'ID de sessions quand il n'y
  a pas données associer avec ces ID de sessions et définira un nouvel cookie d'ID de session.
  Activer session.use_strict_mode est recommandé pour tous les sites.
  
  La suppression immédiate d'une session peut causer des résultats inattendus. Quand il y a des
  requêtes simultanées, les autres connexions peuvent soudainement perdre des données de session.
  Par exemple des requêtes depuis JavaScript et/ou des requêtes depuis des liens URL.
  
  Bien que le module de session actuel n'accepte pas un cookie d'ID de session vide, mais la
  suppression immédiate de session peut provoquer un cookie d'ID de session vide à cause d'une
  condition de concurrence côté client  (navigateur). Ceci provoquera la création de beaucoup d'ID
  de session inutile par le client.
  
  Pour éviter ceci, vous devez définir un horodatage à $_SESSION et refuser l'accès à toutes les
  dates ultérieures. Ou assurer vous que votre application n'a pas de requêtes simultanées. Ceci
  s'applique aussi à <strong>session_regenerate_id()</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>
   * session.use_strict_mode
   * <strong>session_reset()</strong>
   * <strong>session_regenerate_id()</strong>
   * <strong>unset()</strong>
   * <strong>setcookie()</strong>


id: session_encode
type: function
doc:
<comment>Description:</comment>
  Encode les données de session
  
  <strong>session_encode()</strong> retourne une chaîne sérialisée contenant les variables de la session courante
  encodées stockées dans la variable superglobale $_SESSION.
  
  Par défaut, la méthode de sérialisation utilisé est interne à PHP, et n'est pas la même que
  <strong>serialize()</strong>. La méthode de sérialisation peut être définie en utilisant l'option de configuration
  session.serialize_handler.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le contenu encodé de la session courante,  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>session_decode()</strong>
   * session.serialize_handler


id: session_gc
type: function
doc:
<comment>Description:</comment>
  Exécute le ramasse miette des données de session
  
  <strong>session_gc()</strong> est utilisé pour exécuter le ramasse miette (Garbage Collection abrégée GC). PHP
  utilise une méthode probabiliste pour exécuter le ramasse miette de session par défaut.
  
  Le ramassage de miette (GC) basé sur une méthode probabiliste fonctionne quelque peu mais a
  quelques problèmes. 1) Les données de session des sites à faible traffic ne seront peut être pas
  supprimés durant la durée préféré. 2) Les sites à fort traffic exécuteront potentiellement le
  ramasse miette à une trop grande fréquence. 3) Le ramasse miette est exécuté sur une requête
  utilisateur et celui-ci ressentira une latence due au ramasse miette.
  
  Par conséquent, il est recommandé d'exécuter le ramasse miette périodiquement sur les systèmes de
  productions, par exemple, "cron" pour les systèmes de type UNIX. Assurez-vous de désactiver le
  ramasse miette à méthode probabiliste en définissant session.gc_probability  à 0.

<comment>Return:</comment>
  <info>int|false</info>  <strong>session_gc()</strong> retourne le nombre de données de session effacé en tant que succès, <info>false</info>
             en cas d'échec.
             
             Les anciens gestionnaire de sauvegarde ne retourne pas le nombre de données de session
             effacé mais seulement le drapeau de succès/échec. Dans ce cas là, le nombre de données
             de session effacé est 1 quelque soit le nombre actuel de données effacé.

<comment>See Also:</comment>
   * <strong>session_start()</strong>
   * <strong>session_destroy()</strong>
   * session.gc_probability


id: session_get_cookie_params
type: function
doc:
<comment>Description:</comment>
  Lit la configuration du cookie de session
  
  Lit la configuration du cookie de session.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau, qui contient les éléments suivants : "<return>lifetime</return>" : durée de vie du
         cookie. "<return>path</return>" : le chemin où les informations sont stockées. "<return>domain</return>" : le domaine du
         cookie. "<return>secure</return>" : le cookie ne doit être envoyé que sur des connexions sécurisées.
         "<return>httponly</return>" :  le cookie ne sera accessible que via le protocole HTTP. "<return>samesite</return>" : Contrôle
         l'envoie entre domaine (cross-domain) du cookie.
         
         "<return>lifetime</return>" : durée de vie du cookie.
         
         "<return>path</return>" : le chemin où les informations sont stockées.
         
         "<return>domain</return>" : le domaine du cookie.
         
         "<return>secure</return>" : le cookie ne doit être envoyé que sur des connexions sécurisées.
         
         "<return>httponly</return>" :  le cookie ne sera accessible que via le protocole HTTP.
         
         "<return>samesite</return>" : Contrôle l'envoie entre domaine (cross-domain) du cookie.

<comment>See Also:</comment>
   * session.cookie_lifetime
   * session.cookie_path
   * session.cookie_domain
   * session.cookie_secure
   * session.cookie_httponly
   * session.cookie_samesite
   * <strong>session_set_cookie_params()</strong>


id: session_id
type: function
doc:
<comment>Description:</comment>
  Lit et/ou modifie l'identifiant courant de session
  
  <strong>session_id()</strong> est utilisé pour récupérer ou définir l'identifiant de session pour la session
  courante.
  
  La constante <info>SID</info> peut également être utilisée pour lire le nom de la session courante et
  l'identifiant de session à fournir dans les URL. Voyez aussi Gestion de session.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$id</strong>  Si <strong>$id</strong> est fourni et non <info>null</info>, il remplacera l'identifiant courant de session.
                    <strong>session_id()</strong> doit alors être appelé avant <strong>session_start()</strong>. Suivant le
                    gestionnaire de sessions que vous utilisez, tous les caractères ne seront pas
                    acceptés dans cette valeur. Par exemple, le gestionnaire de sessions par défaut,
                    basé sur les fichiers, n'accepte que les caractères compris dans l'intervalle
                    <return>a-z, A-Z et 0-9 , (virgule) et - (moins)</return>!
                    
                    Lorsque vous utilisez les sessions avec les cookies, le fait de spécifier un <strong>$id</strong>
                    pour <strong>session_id()</strong> fera qu'un nouveau cookie sera toujours envoyé lors de l'appel
                    à <strong>session_start()</strong>, sans se soucier si l'identifiant de session courant est
                    identique à celui qui vient d'être défini.

<comment>Return:</comment>
  <info>string|false</info>  <strong>session_id()</strong> retourne l'identifiant de session pour la session courante ou une
                chaîne vide (<return>""</return>) s'il n'y a pas de session courante (aucun identifiant de session
                n'existe). En cas d'échec, <info>false</info> est retourné.

<comment>See Also:</comment>
   * <strong>session_regenerate_id()</strong>
   * <strong>session_start()</strong>
   * <strong>session_set_save_handler()</strong>
   * session.save_handler


id: session_module_name
type: function
doc:
<comment>Description:</comment>
  Lit et/ou modifie le module de session courant
  
  <strong>session_module_name()</strong> récupère le nom du module courant de session, qui est aussi connue en tant
  que session.save_handler.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$module</strong>  Si <strong>$module</strong> est fourni et non <info>null</info>, cette valeur sera alors utilisée, et
                        remplacera la valeur courante. Passer <return>"user"</return> à ce paramètre est interdit. À
                        la place <strong>session_set_save_handler()</strong> doit être appellé pour définir un
                        gestionnaire de session définit par l'utilisateur.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le nom du module courant de session,  ou <info>false</info> si une erreur survient.


id: session_name
type: function
doc:
<comment>Description:</comment>
  Lit et/ou modifie le nom de la session
  
  <strong>session_name()</strong> retourne le nom de la session courante. Si le paramètre <strong>$name</strong> est fourni,
  <strong>session_name()</strong> modifiera le nom de la session et retournera l'ancien nom de la session.
  
  Si un nouveau nom de session <strong>$name</strong> est fourni, <strong>session_name()</strong> modifie le cookie HTTP (et le
  contenue de sortie quand <return>session.transid</return> est activé). Une fois que le cookie HTTP est envoyé,
  <strong>session_name()</strong> émet une erreur. <strong>session_name()</strong> doit être appelé avant <strong>session_start()</strong> pour que la
  session fonctionne correctement.
  
  Le nom de la session est réinitialisé à la valeur par défaut, stockée dans <return>session.name</return> lors du
  démarrage. Ainsi, vous devez appeler <strong>session_name()</strong> pour chaque demande (et avant que
  <strong>session_start()</strong> soit appelé).

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>  Le nom de session est utilisé comme nom pour les cookies et les URLs (i.e.
                      <return>PHPSESSID</return>). Il ne doit contenir que des caractères alphanumériques ; il doit
                      être court et descriptif (surtout pour les utilisateurs ayant activé l'alerte
                      cookie). Si <strong>$name</strong> est fourni et non <info>null</info>, le nom de la session courante sera
                      remplacé par cette valeur.
                      
                       Les noms de session ne peuvent pas contenir uniquement des chiffres, au moins
                      une lettre doit être présente. Sinon, un identifiant de session sera généré à
                      chaque fois.
                      
                      Les noms de session ne peuvent pas contenir uniquement des chiffres, au moins
                      une lettre doit être présente. Sinon, un identifiant de session sera généré à
                      chaque fois.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le nom de la session courante. Si le paramètre <strong>$name</strong> est fourni et que la
                fonction met à jour le nom de la session, alors l'ancien nom de session sera
                retourné,  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * 
     La directive de configuration session.name
    


id: session_regenerate_id
type: function
doc:
<comment>Description:</comment>
  Remplace l'identifiant de session courant par un nouveau
    
  
  <strong>session_regenerate_id()</strong> va remplacer l'identifiant de session courant par un nouveau, généré
  automatiquement, tout en conservant les valeurs de session.
  
  Lorsque l'option session.use_trans_sid est active, la sortie pour affichage doit commencer après
  l'appel à la fonction <strong>session_regenerate_id()</strong>. Sinon, l'ancien ID de session sera utilisé.
  
  Actuellement, session_regenerate_id ne gère pas bien un réseau instable. Par ex. réseau mobile et
  WiFi. Par conséquent, vous pouvez rencontrer une  perte de session en appelant
  session_regenerate_id.
  
  Vous ne devez pas détruire les anciennes données de session immédiatement,  mais devez utiliser
  l'horodatage de destruction et contrôler l'accès à  l'ancien ID de session. Sinon, l'accès
  simultané à la page peut entraîner un  état incohérent, ou vous avez peut-être perdu la session,
  ou il peut  provoquer un accès concurrent côté client (navigateur) et peut créer de  nombreux ID
  de session inutilement. La suppression immédiate de données de  session désactive également la
  détection et la prévention d'attaque de  détournement de session.

<comment>Param:</comment>
  <info>bool</info>  <strong>$delete_old_session</strong>  Si l'on doit effacer l'ancien fichier de session associé ou pas. Vous
                             ne devez pas supprimer l'ancienne session si vous avez besoin  d'éviter
                             les accès concurrents causés par la suppression ou de détecter/éviter
                             les attaques de détournement de session.

<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>session_id()</strong>
   * <strong>session_create_id()</strong>
   * <strong>session_start()</strong>
   * <strong>session_destroy()</strong>
   * <strong>session_reset()</strong>
   * <strong>session_name()</strong>


id: session_register_shutdown
type: function
doc:
<comment>Description:</comment>
  Fonction de fermeture de session
  
  Enregistre la fonction <strong>session_write_close()</strong> comme fonction de fermeture de session.

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


id: session_reset
type: function
doc:
<comment>Description:</comment>
  Réinitialise le tableau de session avec les valeurs originales
  
  <strong>session_reset()</strong> réinitialise une session avec les valeurs  originales sauvegardées dans le
  stockage de session. Cette fonction requiert  une session active et annule les changements dans
  $_SESSION.

<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>
   * $_SESSION
   * 
     La directive de configuration 
     session.auto_start     
    
   * <strong>session_start()</strong>
   * <strong>session_abort()</strong>
   * <strong>session_commit()</strong>


id: session_save_path
type: function
doc:
<comment>Description:</comment>
  Lit et/ou modifie le chemin de sauvegarde des sessions
  
  <strong>session_save_path()</strong> retourne le chemin du dossier actuellement utilisé pour sauver les données de
  sessions.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$path</strong>  Chemin des données de session. Si <strong>$path</strong> est spécifié et non <info>null</info>, le chemin du
                      dossier sera modifié. <strong>session_save_path()</strong> doit être appelé avant
                      <strong>session_start()</strong>.
                      
                       Sur certains systèmes d'exploitation, vous aurez à choisir un chemin vers un
                      dossier capable de gérer un grand nombre de petits fichiers efficacement. Par
                      exemple, sous Linux, reiserfs peut se rendre plus efficace que ext2fs.
                      
                      Sur certains systèmes d'exploitation, vous aurez à choisir un chemin vers un
                      dossier capable de gérer un grand nombre de petits fichiers efficacement. Par
                      exemple, sous Linux, reiserfs peut se rendre plus efficace que ext2fs.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le chemin du dossier courant utilisé pour y stocker les données,  ou <info>false</info>
                si une erreur survient.

<comment>See Also:</comment>
   * 
     La directive de configuration session.save_path
    


id: session_set_cookie_params
type: function
doc:
<comment>Description:</comment>
  Modifie les paramètres du cookie de session
  
  Signature alternative disponible à partir de PHP 7.3.0 :
  
  Modifie les paramètres de configuration du cookie de session, qui a été configuré dans le fichier
  php.ini. L'effet de cette fonction ne dure que pendant l'exécution du script courant. De ce fait,
  vous devez appeler <strong>session_set_cookie_params()</strong> pour chaque script et avant l'appel à
  <strong>session_start()</strong>.
  
  Cette fonction modifie à la volée les paramètres ini correspondants qui peuvent être récupérés au
  moyen de <strong>ini_get()</strong>.

<comment>Param:</comment>
  <info>int</info>          <strong>$lifetime_or_options</strong>  Lors de l'utilisation de la première signature, la durée de vie
                                     du cookie, en secondes. Voir la directive lifetime.
                                     
                                     Lors de l'utilisation de la deuxième signature,  un tableau
                                     associatif qui peut avoir comme clés <return>lifetime</return>, <return>path</return>, <return>domain</return>,
                                     <return>secure</return>, <return>httponly</return> et <return>samesite</return>. Les valeurs ont la même
                                     signification que celles décrits pour les paramètres avec le
                                     même nom. La valeur de l'élément <return>samesite</return> doit soit être <return>Lax</return>
                                     soit <return>Strict</return>. Si une options autorisé n'est pas donnée alors sa
                                     valeur par défaut sera identique à la valeur par défaut des
                                     paramètres explicite. Si l'élément <return>samesite</return> est omit, alors
                                     l'attribut SameSite du cookie ne sera pas définie.
  <info>string|null</info>  <strong>$path</strong>                 Le chemin dans le domaine où le cookie sera accessible.
                                     Utilisez un simple slash ('/') pour tous les chemins du
                                     domaine. Voir la directive path.
  <info>string|null</info>  <strong>$domain</strong>               Le domaine du cookie, par exemple 'www.php.net'. Pour rendre
                                     les cookies visibles sur tous les sous-domaines, le domaine
                                     doit être préfixé avec  un point, tel que '.php.net'. Voir la
                                     directive domain.
  <info>bool|null</info>    <strong>$secure</strong>               Si <info>true</info>, le cookie ne sera envoyé que sur une connexion
                                     sécurisée. Voir la directive secure.
  <info>bool|null</info>    <strong>$httponly</strong>             Si <info>true</info>, PHP va tenter d'envoyer l'option httponly  lors de la
                                     configuration du cookie. Voir la directive httponly.

<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>
   * session.cookie_lifetime
   * session.cookie_path
   * session.cookie_domain
   * session.cookie_secure
   * session.cookie_httponly
   * session.cookie_samesite
   * <strong>session_get_cookie_params()</strong>


id: session_set_save_handler
type: function
doc:
<comment>Description:</comment>
  Configure les fonctions de stockage de sessions
  
  Il est possible d'enregistrer le prototype suivant :
  
  <strong>session_set_save_handler()</strong> configure les fonctions de stockage de sessions, et permet de choisir
  des fonctions utilisateurs pour sauver et relire toutes les sessions. Cette fonction est très
  pratique lorsqu'il faut sauver les données de sessions en utilisant une autre technique que le
  système par fichier fourni par défaut, par exemple le stockage en base de données.

<comment>Param:</comment>
  <info>object</info>    <strong>$sessionhandler</strong>     Une instance d'une classe implémentant une ou plusieurs des
                                interfaces suivantes: SessionHandlerInterface, et optionellement
                                SessionIdInterface, et/ou SessionUpdateTimestampHandlerInterface,
                                comme la classe <class>SessionHandler</class>, pour l'enregistrement comme
                                gestionnaire de session.
  <info>bool</info>      <strong>$register_shutdown</strong>  Enregistre la fonction <strong>session_write_close()</strong> comme fonction
                                <strong>register_shutdown_function()</strong>.
  <info>callable</info>  <strong>$open</strong>               Une fonction de rappel avec la signature suivante :
                                <info>bool</info>open<info>string</info><strong>$savePath</strong><info>string</info><strong>$sessionName</strong>
                                
                                La fonction de rappel <return>open</return> fonctionne comme un constructeur dans une
                                classe, et est exécutée lorsque la session s'ouvre. C'est la
                                première fonction de rappel exécutée lorsque la session démarre
                                automatiquement ou manuellement avec la fonction <strong>session_start()</strong>. La
                                valeur retournée est <info>true</info> en cas de succès ou <info>false</info> si une erreur
                                survient.
  <info>callable</info>  <strong>$close</strong>              Une fonction de rappel avec la signature suivante : <info>bool</info>close
                                
                                La fonction de rappel <return>close</return> fonctionne comme un destructeur dans une
                                classe, et est exécutée une fois que la fonction de rappel write de
                                la session a terminé de s'exécuter. Elle est également appelé
                                lorsque la fonction <strong>session_write_close()</strong> est appelée. La valeur
                                retournée est <info>true</info> en cas de succès, ou <info>false</info> si une erreur
                                survient.
  <info>callable</info>  <strong>$read</strong>               Une fonction de rappel avec la signature suivante :
                                <info>string</info>read<info>string</info><strong>$sessionId</strong>
                                
                                La fonction de rappel <strong>$read</strong> doit toujours retournée une chaîne
                                sérialisée contenant les données de session encodées ou une chaîne
                                vide s'il n'y a aucune donnée à lire.
                                
                                Cette fonction de rappel est appelée en interne par PHP lorsque la
                                session commence ou lorsque la fonction <strong>session_start()</strong> est appelée.
                                Avant que cette fonction de rappel ne soit invoquée, PHP invoquera
                                la fonction de rappel <strong>$open</strong>.
                                
                                La valeur retournée par cette fonction de rappel doit être
                                exactement du même format de sérialisation que celui passé pour le
                                stockage à la fonction de rappel <strong>$write</strong>. La valeur retournée sera
                                désérialisée automatiquement par PHP et utilisée pour peupler la
                                variable superglobale $_SESSION. Malgré le fait que les données
                                ressemblent fortement aux données issuées de la fonction
                                <strong>serialize()</strong>, notez que c'est bien un format différent, qui est
                                spécifié via l'option de configuration session.serialize_handler.
  <info>callable</info>  <strong>$write</strong>              Une fonction de rappel avec la signature suivante :
                                <info>bool</info>write<info>string</info><strong>$sessionId</strong><info>string</info><strong>$data</strong>
                                
                                La fonction de rappel <strong>$write</strong> est appelée lorsque la session doit
                                être sauvegardée et fermée. Cette fonction de rappel reçoit
                                l'identifiant de la session courante ainsi qu'une version sérialisée
                                du contenu de la variable superglobale $_SESSION. La méthode de
                                sérialisation utilisée en interne par PHP est spécifiée via l'option
                                de configuration session.serialize_handler.
                                
                                Les données de session sérialisées passées à cette fonction de
                                rappel doivent être stockées en utilisant l'identifiant de session
                                fournie. Lors de la récupération de ces données, la fonction de
                                rappel <strong>$read</strong> doit retourner la valeur exacte, originalement passée à
                                la fonction de rappel <strong>$write</strong>.
                                
                                Cette fonction de rappel est invoquée lorsque PHP s'arrête ou
                                explicitement lorsque la fonction <strong>session_write_close()</strong> est appelée.
                                Notez qu'après l'exécution de cette fonction, PHP exécutera en
                                interne la fonction de rappel <strong>$close</strong>.  Le gestionnaire d'écriture
                                n'est pas exécuté tant que le flux de sortie n'aura pas été fermé.
                                Aussi, la sortie des requêtes de débogage du gestionnaire "write" ne
                                sera jamais affichée dans le navigateur. Si la sortie de débogage
                                est nécessaire, il est suggéré qu'elle soit plutôt orientée dans un
                                fichier.
                                
                                Le gestionnaire d'écriture n'est pas exécuté tant que le flux de
                                sortie n'aura pas été fermé. Aussi, la sortie des requêtes de
                                débogage du gestionnaire "write" ne sera jamais affichée dans le
                                navigateur. Si la sortie de débogage est nécessaire, il est suggéré
                                qu'elle soit plutôt orientée dans un fichier.
  <info>callable</info>  <strong>$destroy</strong>            Une fonction de rappel avec la signature suivante :
                                <info>bool</info>destroy<info>string</info><strong>$sessionId</strong>
                                
                                Cette fonction de rappel est exécutée lorsqu'une session est
                                détruite avec la fonction <strong>session_destroy()</strong> ou avec
                                <strong>session_regenerate_id()</strong> avec le paramètre de destruction définie à
                                <info>true</info>. La valeur retournée doit être <info>true</info> en cas de succès, ou <info>false</info>
                                si une erreur survient.
  <info>callable</info>  <strong>$gc</strong>                 Une fonction de rappel avec la signature suivante :
                                <info>bool</info>gc<info>int</info><strong>$lifetime</strong>
                                
                                La fonction de rappel de ramasse miettes (garbage collector) est
                                invoquée en interne par PHP périodiquement afin de purger les
                                anciennes données de session. La fréquence est contrôlé par les
                                options de configuration session.gc_probability et
                                session.gc_divisor. La valeur de la durée de vie passée à cette
                                fonction de rappel peut être définie via l'option de configuration
                                session.gc_maxlifetime. La valeur retournée doit être <info>true</info> en cas de
                                succès, ou <info>false</info> si une erreur survient.
  <info>callable</info>  <strong>$create_sid</strong>         Une fonction de rappel avec la signature suivante : <info>string</info>create_sid
                                
                                Cette fonction de rappel est exécutée lorsqu'un nouvel ID de session
                                est nécessaire. Aucun paramètre n'est fourni, et la valeur retournée
                                doit être une chaîne de caractères qui est un ID de session valide
                                pour votre gestionnaire.
  <info>callable</info>  <strong>$validate_sid</strong>       Une fonction de rappel avec la signature suivante :
                                <info>bool</info>validate_sid<info>string</info><strong>$key</strong>
                                
                                Cette fonction de rappel est exécuté quand une session va démarrer,
                                un ID de session est fournie et que session.use_strict_mode est
                                activé. <strong>$key</strong> est l'ID de session à valider. Un ID de session est
                                valide, si une session avec cet ID existe déjà. La valeur de retour
                                devrait être <info>true</info> en cas de succès, <info>false</info> en cas d'échec.
  <info>callable</info>  <strong>$update_timestamp</strong>   Une fonction de rappel avec la signature suivante :
                                <info>bool</info>update_timestamp<info>string</info><strong>$key</strong><info>string</info><strong>$val</strong>
                                
                                Cette fonction de rappel est exécuté quand une session est mise à
                                jour. <strong>$key</strong> est l'ID de session, <strong>$val</strong> sont les données de session. La
                                valeur de retour devrait être <info>true</info> en cas de succès, <info>false</info> en cas
                                d'échec.

<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>
   * 
     La directive de configuration session.save_handler
    
   * 
     La directive de configuration
     session.serialize_handler.
    
   * <strong>register_shutdown_function()</strong>
   * <strong>session_register_shutdown()</strong>
   * 
     Se reporter à save_handler.inc
     pour une mise en œuvre procédurales complète 
    


id: session_start
type: function
doc:
<comment>Description:</comment>
  Démarre une nouvelle session ou reprend une session existante
  
  <strong>session_start()</strong> crée une session ou restaure celle trouvée sur le serveur, via l'identifiant de
  session passé dans une requête GET, POST ou par un cookie.
  
  Lorsque <strong>session_start()</strong> est appelée ou lorsqu'une session démarre toute seule, PHP va appeler les
  gestionnaires d'ouverture et de lecture. Ce sont des gestionnaires internes fournis par PHP (comme
  fichiers, SQLite ou Memcached) ou encore des gestionnaires personnalisés définis au moyen de
  <strong>session_set_save_handler()</strong>. La fonction de lecture va récupérer toute session existante (stockée
  sous forme sérialisée) et va désérialiser les données pour peupler $_SESSION.
  
  Pour utiliser une session nommée, vous devez appeler <strong>session_name()</strong> avant d'appeler
  <strong>session_start()</strong>.
  
  Lorsque session.use_trans_sid est activée, la fonction <strong>session_start()</strong> enregistrera un
  gestionnaire interne de sortie pour la réécriture d'URL.
  
  Si un utilisateur utilise <return>ob_gzhandler</return> ou l'équivalent <strong>ob_start()</strong>, l'ordre d'appel des fonctions
  est important pour une sortie correcte. Par exemple,  <return>ob_gzhandler</return> doit être enregistré avant de
  démarrer la session.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  S'il est fourni, il s'agit d'un tableau associatif d'options qui remplacera  les
                   directives de configuration de session  actuellement définies. Les clés ne
                   doivent pas inclure le préfixe <return>session.</return>.
                   
                   En plus de l'ensemble normal des directives de configuration, une option
                   <return>read_and_close</return> peut également être fournie. Si la  valeur est définie sur <info>true</info>,
                   cela entraîne la fermeture immédiate de  la session après la lecture, ce qui
                   évite tout blocage inutile si les  données de session ne sont pas modifiées.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si une session a pu être démarrée avec succès, et <info>false</info> sinon.

<comment>See Also:</comment>
   * $_SESSION
   * 
     La directive de configuration session.auto_start
    
   * <strong>session_id()</strong>


id: session_status
type: function
doc:
<comment>Description:</comment>
  Détermine le statut de la session courante
  
  <strong>session_status()</strong> est utilisée pour connaitre l'état de la session courante.

<comment>Return:</comment>
  <info>int</info>  <info>PHP_SESSION_DISABLED</info> si les sessions sont désactivées.<info>PHP_SESSION_NONE</info> si les sessions sont
       activées, mais qu'aucune n'existe.<info>PHP_SESSION_ACTIVE</info> si les sessions sont activées, et qu'une
       existe.
       
       <info>PHP_SESSION_DISABLED</info> si les sessions sont désactivées.
       
       <info>PHP_SESSION_NONE</info> si les sessions sont activées, mais qu'aucune n'existe.
       
       <info>PHP_SESSION_ACTIVE</info> si les sessions sont activées, et qu'une existe.

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


id: session_unset
type: function
doc:
<comment>Description:</comment>
  Détruit toutes les variables d'une session
  
  <strong>session_unset()</strong> détruit toutes les variables de la session courante.

<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: session_write_close
type: function
doc:
<comment>Description:</comment>
  Écrit les données de session et ferme la session
  
  Termine la session courante, après avoir stocké les données.
  
  Les données de session sont généralement stockées à la fin de votre script, automatiquement, sans
  besoin d'appeler explicitement <strong>session_write_close()</strong>. Mais durant toute l'exécution du script, les
  données de session sont verrouillées en écriture, et un seul script peut opérer sur la session en
  même temps. Lorsque vous utilisez des frames avec des sessions, vous vous en rendrez compte en
  voyant les frames se rafraîchir les uns après les autres. Vous pouvez réduire le temps de calcul
  de ces pages en refermant la session aussitôt que possible, ce qui libère les données pour les
  autres scripts.

<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>session_register_shutdown()</strong>


id: set_error_handler
type: function
doc:
<comment>Description:</comment>
  Spécifie une fonction utilisateur comme gestionnaire d'erreurs
  
  <strong>set_error_handler()</strong> choisit la fonction utilisateur <strong>$callback</strong> pour gérer les erreurs dans un
  script.
  
  Cette fonction peut être utilisée pour définir des gestionnaires d'erreurs personnalisés pendant
  l'exécution, par exemple dans des applications qui ont besoin de nettoyer des fichiers/données
  lorsqu'une erreur critique se produit ou lorsqu'une erreur est déclenchée en réponse à certaines
  conditions (à l'aide de la fonction <strong>trigger_error()</strong>).
  
  Il faut se rappeler que la fonction standard de traitement des erreurs de PHP est alors
  complètement ignorée pour les erreurs de types spécifiés par <strong>$error_levels</strong> à moins que la fonction
  de rappel retourne <info>false</info>. Les paramètres de la fonction <strong>error_reporting()</strong> n'auront aucun effet et
  le gestionnaire d'erreurs sera appelé quoi qu'il arrive. Cependant, il est toujours possible de
  lire la valeur actuelle de la configuration de. error_reporting et faire réagir la fonction de
  gestion des erreurs en fonction.
  
  Notez aussi que c'est la responsabilité du gestionnaire d'erreurs d'arrêter l'exécution du script
  si nécessaire en appelant la fonction <strong>exit()</strong>. Si la fonction du gestionnaire d'erreurs retourne,
  l'exécution du script se poursuivra avec l'instruction suivante après celle qui a causé l'erreur.
  
  Les types d'erreur suivants ne peuvent pas être gérés avec cette fonction :  <info>E_ERROR</info>, <info>E_PARSE</info>,
  <info>E_CORE_ERROR</info>, <info>E_CORE_WARNING</info>, <info>E_COMPILE_ERROR</info>, <info>E_COMPILE_WARNING</info> indépendamment d'où elles sont
  levées, ainsi que la plupart des <info>E_STRICT</info> du fichier dans lequel  <strong>set_error_handler()</strong> est appelé.
  
  Si une erreur survient avant que le script ne soit exécuté (par exemple un téléchargement de
  fichier), le gestionnaire d'erreurs personnalisé ne pourra pas être appelé, car il n'est pas
  encore enregistré.

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$callback</strong>      Si <info>null</info> est fournie le gestionnaire est réinitialisé à son statut
                                par défaut. Sinon, le gestionnaire est une fonction de rappel avec
                                la signature suivante :
                                
                                
                                <info>bool</info>handler<info>int</info><strong>$errno</strong><info>string</info><strong>$errstr</strong><info>string</info><strong>$errfile</strong><info>int</info><strong>$errline</strong><info>array</info><strong>$errcontext</strong><strong>$errno</strong>
                                Le premier paramètre <strong>$errno</strong>, sera passé le niveau d'erreur, sous la
                                forme d'un entier. <strong>$errstr</strong> Le second paramètre <strong>$errstr</strong>, sera passé
                                le message d'erreur, sous forme de chaîne. <strong>$errfile</strong> Si la fermeture
                                accepte un troisième paramètre, <strong>$errfile</strong>, il sera passé le nom du
                                fichier dans lequel l'erreur a été identifiée, sous forme de chaîne.
                                <strong>$errline</strong> Si la fermeture accepte un quatrième paramètre, <strong>$errline</strong>,
                                il sera passé le numéro de ligne à laquelle l'erreur a été
                                identifiée, sous la forme d'un entier. <strong>$errcontext</strong> Si la fermeture
                                accepte un cinquième paramètre, <strong>$errcontext</strong>, il sera passé comme un
                                tableau qui pointe sur la table des symboles actifs à l'instant où
                                l'erreur est survenue. En d'autres termes, <strong>$errcontext</strong> contient un
                                tableau avec toutes les variables qui existaient lorsque l'erreur a
                                été déclenchée. Les gestionnaires d'erreurs utilisateur ne doit pas
                                modifier le contexte d'erreur.  Ce paramètre est OBSOLÈTE à partir
                                de PHP 7.2.0, et SUPPRIMÉ à partir de PHP 8.0.0. Si la fonction
                                définie ce paramètre sans valeur par défaut, une erreur de "too few
                                arguments" sera levée lors de son appel.
                                
                                Le premier paramètre <strong>$errno</strong>, sera passé le niveau d'erreur, sous la
                                forme d'un entier.
                                
                                Le second paramètre <strong>$errstr</strong>, sera passé le message d'erreur, sous
                                forme de chaîne.
                                
                                Si la fermeture accepte un troisième paramètre, <strong>$errfile</strong>, il sera
                                passé le nom du fichier dans lequel l'erreur a été identifiée, sous
                                forme de chaîne.
                                
                                Si la fermeture accepte un quatrième paramètre, <strong>$errline</strong>, il sera
                                passé le numéro de ligne à laquelle l'erreur a été identifiée, sous
                                la forme d'un entier.
                                
                                Si la fermeture accepte un cinquième paramètre, <strong>$errcontext</strong>, il sera
                                passé comme un tableau qui pointe sur la table des symboles actifs à
                                l'instant où l'erreur est survenue. En d'autres termes, <strong>$errcontext</strong>
                                contient un tableau avec toutes les variables qui existaient lorsque
                                l'erreur a été déclenchée. Les gestionnaires d'erreurs utilisateur
                                ne doit pas modifier le contexte d'erreur.
                                
                                Ce paramètre est OBSOLÈTE à partir de PHP 7.2.0, et SUPPRIMÉ à
                                partir de PHP 8.0.0. Si la fonction définie ce paramètre sans valeur
                                par défaut, une erreur de "too few arguments" sera levée lors de son
                                appel.
                                
                                Si la fonction retourne <info>false</info>, alors le gestionnaire d'erreurs
                                normal continue.
  <info>int</info>            <strong>$errno</strong>         Le premier paramètre <strong>$errno</strong>, sera passé le niveau d'erreur, sous la
                                forme d'un entier.
  <info>string</info>         <strong>$errstr</strong>        Le second paramètre <strong>$errstr</strong>, sera passé le message d'erreur, sous
                                forme de chaîne.
  <info>string</info>         <strong>$errfile</strong>       Si la fermeture accepte un troisième paramètre, <strong>$errfile</strong>, il sera
                                passé le nom du fichier dans lequel l'erreur a été identifiée, sous
                                forme de chaîne.
  <info>int</info>            <strong>$errline</strong>       Si la fermeture accepte un quatrième paramètre, <strong>$errline</strong>, il sera
                                passé le numéro de ligne à laquelle l'erreur a été identifiée, sous
                                la forme d'un entier.
  <info>array</info>          <strong>$errcontext</strong>    Si la fermeture accepte un cinquième paramètre, <strong>$errcontext</strong>, il sera
                                passé comme un tableau qui pointe sur la table des symboles actifs à
                                l'instant où l'erreur est survenue. En d'autres termes, <strong>$errcontext</strong>
                                contient un tableau avec toutes les variables qui existaient lorsque
                                l'erreur a été déclenchée. Les gestionnaires d'erreurs utilisateur
                                ne doit pas modifier le contexte d'erreur.
                                
                                Ce paramètre est OBSOLÈTE à partir de PHP 7.2.0, et SUPPRIMÉ à
                                partir de PHP 8.0.0. Si la fonction définie ce paramètre sans valeur
                                par défaut, une erreur de "too few arguments" sera levée lors de son
                                appel.
  <info>int</info>            <strong>$error_levels</strong>  Sert de masque pour appeler la fonction  <strong>$callback</strong> de la même façon
                                que l'option de configuration error_reporting contrôle les erreurs
                                qui sont affichées. Sans le masque, <strong>$callback</strong> sera appelé pour
                                toutes les erreurs, quelle que soit la valeur de error_reporting.

<comment>Return:</comment>
  <info>callable|null</info>  Retourne le dernier gestionnaire d'erreurs (s'il existe). Si le gestionnaire
                 d'erreurs natif est utilisé, <info>null</info> est retourné. Si le gestionnaire d'erreurs
                 précédent est une méthode d'une classe, cette fonction retournera un tableau indexé
                 de la classe et du nom de la méthode.

<comment>See Also:</comment>
   * <class>ErrorException</class>
   * <strong>error_reporting()</strong>
   * <strong>restore_error_handler()</strong>
   * <strong>trigger_error()</strong>
   * Constantes de niveau d'erreur


id: set_exception_handler
type: function
doc:
<comment>Description:</comment>
  Définit une fonction utilisateur de gestion d'exceptions
    
  
  <strong>set_exception_handler()</strong> définit le gestionnaire d'exceptions par défaut si une exception n'est pas
  attrapée avec un bloc d'essai/d'attrape. L'exécution sera stoppée après l'appel à la fonction
  <strong>$callback</strong>.

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$callback</strong>  La fonction à appeler quand une exception non attrapée se produit. Cette
                            fonction de gestion doit accepter un paramètre, qui sera l'objet
                            <class>Throwable</class> qui a été lancé. Les classes <class>Error</class> et <class>Exception</class> implémentent
                            l'interface <class>Throwable</class>. Ceci est la signature du gestionnaire :
                            
                            <info>void</info>handler<info>Throwable</info><strong>$ex</strong>
                            
                            <info>null</info> peut être passé à la place, pour ré-initialiser ce gestionnaire en
                            son statut initial.

<comment>Return:</comment>
  <info>callable|null</info>  Retourne le gestionnaire précédemment défini ou <info>null</info> en cas d'erreur. Si aucun
                 gestionnaire n'a été précédemment défini, <info>null</info> est également retourné.

<comment>See Also:</comment>
   * <strong>restore_exception_handler()</strong>
   * <strong>restore_error_handler()</strong>
   * <strong>error_reporting()</strong>
   * Les exceptions


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


id: set_include_path
type: function
doc:
<comment>Description:</comment>
  Modifie la valeur de la directive de configuration include_path
  
  Modifie la valeur de la directive de configuration include_path, pour la durée du script en cours.

<comment>Param:</comment>
  <info>string</info>  <strong>$include_path</strong>  La nouvelle valeur pour la directive de configuration include_path

<comment>Return:</comment>
  <info>string|false</info>  Retourne l'ancienne valeur de include_path en cas de succès ou <info>false</info> si une erreur
                survient.

<comment>See Also:</comment>
   * <strong>ini_set()</strong>
   * <strong>get_include_path()</strong>
   * <strong>restore_include_path()</strong>
   * <strong>include()</strong>


id: set_time_limit
type: function
doc:
<comment>Description:</comment>
  Fixe le temps maximum d'exécution d'un script
  
  Fixe le délai d'expiration d'un script, en secondes. Si cette limite est atteinte, le script
  s'interrompt, et renvoie une erreur fatale. La valeur par défaut est 30 secondes ou, si c'est le
  cas, la valeur de la directive <return>max_execution_time</return> définie dans le php.ini.
  
  Lorsqu'elle est appelée, <strong>set_time_limit()</strong> remet le compteur à zéro. En d'autres termes, si la
  limite par défaut est à 30 secondes, et qu'après 25 secondes d'exécution du script l'appel
  <return>set_time_limit(20)</return> est fait, alors le script tournera pendant un total de 45 secondes avant de
  finir.

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>  Le temps maximal d'exécution, en secondes. S'il vaut <return>0</return>, aucune limite n'est
                 imposée.

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

<comment>See Also:</comment>
   * max_execution_time
   * max_input_time


id: setcookie
type: function
doc:
<comment>Description:</comment>
  Envoie un cookie
  
  Signature alternative disponible à partir de PHP 7.3.0 (pas supporté avec les paramètres nommés) :
  
  <strong>setcookie()</strong> définit un cookie qui sera envoyé avec le reste des en-têtes HTTP. Comme pour les
  autres en-têtes, les cookies doivent être envoyés avant toute autre sortie (c'est une restriction
  du protocole HTTP, pas de PHP). Cela vous impose d'appeler cette fonction avant toute balise <return>\<html&gt;</return> ou <return>\<head&gt;</return> et aussi des caractères d'espacement blanc.
  
  Une fois que les cookies ont été placés, ils seront accessibles lors du prochain chargement de
  page dans le tableau $_COOKIE. Les valeurs des cookies peuvent aussi exister dans la variable
  $_REQUEST.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>                Le nom du cookie.
  <info>string</info>  <strong>$value</strong>               La valeur du cookie. Cette valeur est stockée sur l'ordinateur du
                               client ; ne stockez pas d'informations importantes. Si le paramètre
                               <strong>$name</strong> vaut <return>'cookiename'</return>, cette valeur est récupéré avec
                               $_COOKIE['cookiename'].
  <info>int</info>     <strong>$expires_or_options</strong>  Le temps après lequel le cookie expire. C'est un timestamp Unix,
                               donc, ce sera un nombre de secondes depuis l'époque Unix (1 janvier
                               1970). Une façon de définir cette valeur est d'ajouter le nombre de
                               secondes avant que le cookie n'expire au résultat d'un appel à
                               <strong>time()</strong>. Par exemple <return>time()+60*60*24*30</return> configurera le cookie pour
                               qu'il expire dans 30 jours. Une autre possibilité consiste à utiliser
                               la fonction  <strong>mktime()</strong>. Si vous ne spécifiez pas ce paramètre ou s'il
                               vaut 0, le cookie expirera à la fin de la session (lorsque le
                               navigateur sera fermé).
                               
                                Vous pourrez noter que le paramètre <strong>$expires_or_options</strong> prend un
                               horodatage unique, et non pas la date au format <return>Jour, JJ-Mois-AAAA
                               HH:MM:SS GMT</return>, car PHP fait la conversion en interne.
                               
                               Vous pourrez noter que le paramètre <strong>$expires_or_options</strong> prend un
                               horodatage unique, et non pas la date au format <return>Jour, JJ-Mois-AAAA
                               HH:MM:SS GMT</return>, car PHP fait la conversion en interne.
  <info>string</info>  <strong>$path</strong>                Le chemin sur le serveur sur lequel le cookie sera disponible. Si la
                               valeur est <return>'/'</return>, le cookie sera disponible sur l'ensemble du domaine
                               <strong>$domain</strong>. Si la valeur est <return>'/foo/'</return>, le cookie sera uniquement
                               disponible dans le répertoire <return>/foo/</return> ainsi que tous ses
                               sous-répertoires comme <return>/foo/bar/</return> dans le domaine <strong>$domain</strong>. La valeur
                               par défaut est le répertoire courant où le cookie a été défini.
  <info>string</info>  <strong>$domain</strong>              Le (sous-)domaine pour lequel le cookie est disponible. Définir ceci
                               à un sous-domaine (tel que <return>'www.example.com'</return>) rendra le cookie
                               disponible pour ce sous-domaine ainsi que tous ses sous-domaines (par
                               exemple : w2.www.example.com). Pour rendre le cookie disponible sur
                               tout le domaine (ainsi que tous ses sous-domaines), définissez
                               simplement la valeur avec le nom de domaine (<return>'example.com'</return>, avec cet
                               exemple).
                               
                               Les anciens navigateurs continuant d'implémenter la RFC 2109
                               (obsolète) peuvent nécessiter un <return>.</return> pour rendre disponible tous les
                               sous-domaines.
  <info>bool</info>    <strong>$secure</strong>              Indique si le cookie doit uniquement être transmis à travers une
                               connexion sécurisée HTTPS depuis le client. Lorsque ce paramètre vaut
                               <info>true</info>, le cookie ne sera envoyé que si la connexion est sécurisée.
                               Côté serveur, c'est au développeur d'envoyer ce genre de cookie
                               uniquement sur les connexions sécurisées (par exemple, en utilisant
                               la variable $_SERVER["HTTPS"]).
  <info>bool</info>    <strong>$httponly</strong>            Lorsque ce paramètre vaut <info>true</info>, le cookie ne sera accessible que par
                               le protocole HTTP. Cela signifie que le cookie ne sera pas accessible
                               via des langages de scripts, comme Javascript. Il a été suggéré que
                               cette configuration permet de limiter les attaques via XSS (bien
                               qu'elle ne soit pas supportée par tous les navigateurs), néanmoins ce
                               fait est souvent contesté. <info>true</info> ou <info>false</info>
  <info>array</info>   <strong>$options</strong>             Un tableau associatif qui peut avoir comme clés <return>expires</return>, <return>path</return>,
                               <return>domain</return>, <return>secure</return>, <return>httponly</return> et <return>samesite</return>. Si une autre clé est présente
                               une erreur de niveau <info>E_WARNING</info> est émise. Les valeurs ont la même
                               signification que celles décrits pour les paramètres avec le même
                               nom. La valeur de l'élément <return>samesite</return> doit être <return>None</return>, <return>Lax</return> ou <return>Strict</return>.
                               Si une options autorisé n'est pas donnée alors sa valeur par défaut
                               sera  identique à la valeur par défaut des paramètres explicite. Si
                               l'élément <return>samesite</return> est omit, alors l'attribut SameSite du cookie  ne
                               sera pas définie.

<comment>Return:</comment>
  <info>bool</info>  Si quelque chose a été envoyé sur la sortie standard avant l'appel à cette fonction,
        <strong>setcookie()</strong> échouera et retournera <info>false</info>. Si <strong>setcookie()</strong> réussi, elle retournera <info>true</info>. Cela
        n'indique pas si le client accepte ou pas le cookie.

<comment>See Also:</comment>
   * <strong>header()</strong>
   * <strong>setrawcookie()</strong>
   * Section sur les cookies
   * RFC 6265
   * RFC 2109


id: setlocale
type: function
doc:
<comment>Description:</comment>
  Modifie les informations de localisation
  
  Signature alternative (non supporté avec les arguments nommés) :
  
  Définit les informations de localisation.
  
  L'information locale est maintenue par processus, non par thread. Si vous faites fonctionner PHP
  sur un serveur multithreadé, vous pourriez obtenir des changements soudains des configurations
  locales pendant qu'un script fonctionne, même si celui-ci n'appelle jamais la fonction
  <strong>setlocale()</strong>. Ceci survient à cause des autres scripts qui fonctionnent dans des threads différents
  du même processus. Ces scripts changent les configurations locales dans le processus au complet en
  utilisant la fonction <strong>setlocale()</strong>. Sur Windows, les informations de locale sont maintenue par
  thread à partir de PHP 7.0.5.

<comment>Param:</comment>
  <info>int</info>     <strong>$category</strong>      <strong>$category</strong> est une constante (ou une chaîne) qui spécifie la catégorie de
                         fonctions affectées par la configuration de localisation : <info>LC_ALL</info> pour
                         toutes les constantes suivantes <info>LC_COLLATE</info> pour la comparaison de chaînes
                         de caractères. Voir  <strong>strcoll()</strong> <info>LC_CTYPE</info> pour la classification et la
                         conversion de caractères.  Voir <strong>ctype_alpha()</strong> <info>LC_MONETARY</info> pour <strong>localeconv()</strong>
                         <info>LC_NUMERIC</info> pour le séparateur décimal. Voir  <strong>localeconv()</strong> <info>LC_TIME</info> pour le
                         format de date et d'heure avec <strong>strftime()</strong> <info>LC_MESSAGES</info> pour les réponses
                         système (disponible si PHP a été compilé avec <return>libintl</return>)
                         
                         <info>LC_ALL</info> pour toutes les constantes suivantes
                         
                         <info>LC_COLLATE</info> pour la comparaison de chaînes de caractères. Voir  <strong>strcoll()</strong>
                         
                         <info>LC_CTYPE</info> pour la classification et la conversion de caractères.  Voir
                         <strong>ctype_alpha()</strong>
                         
                         <info>LC_MONETARY</info> pour <strong>localeconv()</strong>
                         
                         <info>LC_NUMERIC</info> pour le séparateur décimal. Voir  <strong>localeconv()</strong>
                         
                         <info>LC_TIME</info> pour le format de date et d'heure avec <strong>strftime()</strong>
                         
                         <info>LC_MESSAGES</info> pour les réponses système (disponible si PHP a été compilé avec
                         <return>libintl</return>)
  <info>string</info>  <strong>$locales</strong>       Si <strong>$locales</strong> est la chaîne vide (<return>""</return>), les noms de locales seront pris dans
                         l'environnement, à partir des variables de même nom que les catégories
                         ci-dessus, ou depuis "LANG".
                         
                         Si <strong>$locales</strong> vaut <return>"0"</return>, la configuration locale ne sera pas modifiée, et la
                         configuration courante sera retournée.
                         
                         Si <strong>$locales</strong> est suivi par des paramètres additionnels, alors chaque
                         paramètre tente d'être défini comme nouvelle locale jusqu'à ce qu'un
                         réussisse. Cela est pratique si la locale est connue sous différents noms
                         sur des systèmes différents ou bien pour prévoir une autre valeur en cas de
                         non disponibilité de la locale choisie.
  <info>string</info>  <strong>$rest</strong>          Paramètres optionnels de chaîne à essayer comme paramètre de locale jusqu'à
                         une réussite.
  <info>array</info>   <strong>$locale_array</strong>  Chaque élément du tableau est essayé à être définie comme la nouvelle
                         locale jusqu'à une réussite. Ceci est utile si une locale est connue sous
                         différent noms sur des systèmes différents ou pour fournis une solution de
                         repli pour une locale potentiellement indisponible.

<comment>Return:</comment>
  <info>string|false</info>  Retourne la nouvelle configuration locale, ou <info>false</info> si la localisation n'est pas
                implémentée sur votre plate-forme, si la variable de localisation n'existe pas, ou
                si la catégorie spécifiée n'est pas valide.
                
                Un nom de catégorie invalide générera un message d'alerte. La liste des noms de
                locales/catégories peut être trouvée en consultant la RFC 1766 ainsi que l'ISO 639.
                Les différentes plates-formes possèdent des conventions de nommages différentes.
                
                La valeur retournée par <strong>setlocale()</strong> dépend du système sur lequel PHP est installé.
                <strong>setlocale()</strong> retourne exactement ce que la fonction système <return>setlocale</return> retourne.


id: setrawcookie
type: function
doc:
<comment>Description:</comment>
  Envoie un cookie sans encoder sa valeur en URL
  
  Signature alternative disponible à partir de PHP 7.3.0 (pas supporté avec les paramètres nommés) :
  
  <strong>setrawcookie()</strong> est identique à <strong>setcookie()</strong> excepté que la valeur du cookie ne sera pas
  automatiquement encodée URL lors de l'envoi au navigateur.

<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>setcookie()</strong>


id: settype
type: function
doc:
<comment>Description:</comment>
  Affecte un type à une variable
  
  Force le type de la variable <strong>$var</strong> en <strong>$type</strong>.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$var</strong>   La variable à convertir.
  <info>string</info>  <strong>$type</strong>  Les valeurs possibles pour le paramètre <strong>$type</strong> sont :  "boolean" ou "bool"
                 "integer" ou "int"  "float" ou "double"  "<return>string</return>"  "<return>array</return>"  "<return>object</return>"  "<info>null</info>"
                 
                 "boolean" ou "bool"
                 
                 "integer" ou "int"
                 
                 "float" ou "double"
                 
                 "<return>string</return>"
                 
                 "<return>array</return>"
                 
                 "<return>object</return>"
                 
                 "<info>null</info>"

<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>gettype()</strong>
   * conversion de type
   * transtypage automatique


id: sha1
type: function
doc:
<comment>Description:</comment>
  Calcule le sha1 d'une chaîne de caractères
  
  Calcule le sha1 de la chaîne de caractères <strong>$string</strong> en utilisant <return>US Secure Hash Algorithm 1</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  La chaîne d'entrée.
  <info>bool</info>    <strong>$binary</strong>  Si le paramètre optionnel <strong>$binary</strong> est passé à <info>true</info>, le sha1 est retourné sous
                   forme binaire brute avec une taille de 20 caractères, sinon, il est retourné sous
                   la forme d'un nombre hexadécimal d'une taille de 40 caractères.

<comment>Return:</comment>
  <info>string</info>  Retourne le sha1, sous la forme d'une chaîne de caractères.

<comment>See Also:</comment>
   * <strong>sha1_file()</strong>
   * <strong>crc32()</strong>
   * <strong>md5()</strong>
   * <strong>hash()</strong>
   * <strong>crypt()</strong>
   * <strong>password_hash()</strong>


id: sha1_file
type: function
doc:
<comment>Description:</comment>
  Calcule le sha1 d'un fichier
  
  Calcule le sha1 du fichier spécifié par le paramètre <strong>$filename</strong> en utilisant  <return>US Secure Hash
  Algorithm 1</return>, puis retourne ce sha1. Le sha1 est un nombre hexadécimal de 40 caractères.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le nom du fichier à hacher.
  <info>bool</info>    <strong>$binary</strong>    Lorsque <info>true</info>, retourne le prétraitement en format binaire brut avec une
                     grandeur de 20.

<comment>Return:</comment>
  <info>string|false</info>  Retourne une chaîne de caractères en cas de succès, <info>false</info> autrement.

<comment>See Also:</comment>
   * <strong>sha1()</strong>
   * <strong>md5_file()</strong>
   * <strong>crc32()</strong>


id: shell_exec
type: function
doc:
<comment>Description:</comment>
  Exécute une commande via le Shell et retourne le résultat sous forme de chaîne
    
  
  <strong>shell_exec()</strong> est identique aux  guillemets obliques.
  
  Sur Windows, le tube sous-jacent est ouvert en mode texte qui peut causer la fonction à échouer
  pour des sorties binaires. Considérer l'utilisation de <strong>popen()</strong> pour de tel cas.

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

<comment>Return:</comment>
  <info>string|false|null</info>  Une chaîne de caractères contenant le résultat de la commande exécuté, <info>false</info> si
                     le pipe ne peut pas être établie, ou <info>null</info> si une erreur survient ou si la
                     commande ne produit aucune sortie.
                     
                     Cette fonction peut retourner <info>null</info> lorsqu'une erreur survient mais aussi
                     lorsque le programme ne produit aucune sortie. Il n'est pas possible de
                     détecter les échecs d'exécution en utilisant cette fonction. La fonction <strong>exec()</strong>
                     doit être utilisée lorsque vous souhaitez récupérer le code de sortie de votre
                     programme.

<comment>See Also:</comment>
   * <strong>exec()</strong>
   * <strong>escapeshellcmd()</strong>


id: shm_attach
type: function
doc:
<comment>Description:</comment>
  Crée ou ouvre un segment de mémoire partagée
  
  <strong>shm_attach()</strong> retourne une instance qui permettra d'accéder à la mémoire partagée de type System V.
  Au premier appel, la mémoire sera créée, avec la taille <strong>$size</strong> et avec les permissions <strong>$permissions</strong>
  
  Aux appels suivants avec la même clé <strong>$key</strong>, <strong>shm_attach()</strong> retournera une nouvelle instance, mais
  cette instance accédera toujours à la même portion de mémoire partagée. Dans ce cas, <strong>$size</strong> et
  <strong>$permissions</strong> seront ignorés.

<comment>Param:</comment>
  <info>int</info>       <strong>$key</strong>          Un identifiant numérique de la mémoire partagée
  <info>int|null</info>  <strong>$size</strong>         La taille mémoire. S'il n'est pas fourni, vaut par défaut la valeur de
                          <return>sysvshm.init_mem</return> du fichier php.ini, sinon 10000 octets.
  <info>int</info>       <strong>$permissions</strong>  Les permissions (optionnelles). Par défaut, vaut 0666.

<comment>Return:</comment>
  <info>SysvSharedMemory|false</info>  Retourne une instance de <class>SysvSharedMemory</class> en cas de succès,  ou <info>false</info> si
                          une erreur survient.

<comment>See Also:</comment>
   * <strong>shm_detach()</strong>
   * <strong>ftok()</strong>


id: shm_detach
type: function
doc:
<comment>Description:</comment>
  Libère un segment de mémoire partagée
  
  <strong>shm_detach()</strong> libère le segment de mémoire partagée identifié par <strong>$shm</strong> et créé par <strong>shm_attach()</strong>.
  N'oubliez pas que cette mémoire partagée existe toujours sous Unix, et que les données sont
  toujours accessibles.

<comment>Param:</comment>
  <info>SysvSharedMemory</info>  <strong>$shm</strong>  Un segment de mémoire partagée obtenue depuis <strong>shm_attach()</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>shm_attach()</strong>
   * <strong>shm_remove()</strong>
   * <strong>shm_remove_var()</strong>


id: shm_get_var
type: function
doc:
<comment>Description:</comment>
  Lit une variable dans la mémoire partagée
  
  <strong>shm_get_var()</strong> retourne la variable repérée par <strong>$variable_key</strong>, dans le segment de mémoire partagée
  identifié par <strong>$shm_identifier</strong>. La variable est toujours présente en mémoire partagée.

<comment>Param:</comment>
  <info>SysvSharedMemory</info>  <strong>$shm</strong>  Un segment de mémoire partagée obtenue depuis <strong>shm_attach()</strong>.
  <info>int</info>               <strong>$key</strong>  La clé de la variable.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la variable correspondant à la clé donnée.

<comment>See Also:</comment>
   * <strong>shm_has_var()</strong>
   * <strong>shm_put_var()</strong>


id: shm_has_var
type: function
doc:
<comment>Description:</comment>
  Vérifie si une variable existe en mémoire partagée
  
  Vérifie si une variable existe en mémoire partagée.

<comment>Param:</comment>
  <info>SysvSharedMemory</info>  <strong>$shm</strong>  Un segment de mémoire partagée obtenue depuis <strong>shm_attach()</strong>.
  <info>int</info>               <strong>$key</strong>  Le nom de la variable.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la variable existe, et <info>false</info> sinon;

<comment>See Also:</comment>
   * <strong>shm_get_var()</strong>
   * <strong>shm_put_var()</strong>


id: shm_put_var
type: function
doc:
<comment>Description:</comment>
  Insère ou modifie une variable de la mémoire partagée
  
  <strong>shm_put_var()</strong> insère ou modifie la variable <strong>$value</strong> avec la clé <strong>$key</strong> dans le segment de mémoire
  <strong>$shm</strong>.
  
  Des alertes (niveau <info>E_WARNING</info>) seront émises si <strong>$shm</strong> n'est pas un segment de mémoire type System V
  valide, ou s'il n'y a pas assez de mémoire pour votre requête.

<comment>Param:</comment>
  <info>SysvSharedMemory</info>  <strong>$shm</strong>    Un segment de mémoire partagée obtenue depuis <strong>shm_attach()</strong>.
  <info>int</info>               <strong>$key</strong>    La clé de la variable.
  <info>mixed</info>             <strong>$value</strong>  La variable. Tous les types de variables supportés par la fonction
                            <strong>serialize()</strong> peuvent être utilisés : cela signifie que tous les types,
                            sauf les ressources et quelques objets internes, peuvent être
                            sérialisés.

<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>shm_get_var()</strong>
   * <strong>shm_has_var()</strong>


id: shm_remove
type: function
doc:
<comment>Description:</comment>
  Supprime un segment de mémoire partagée sous Unix
  
  <strong>shm_remove()</strong> supprime le segment de mémoire partagée <strong>$shm</strong>. Toutes les données seront supprimées.

<comment>Param:</comment>
  <info>SysvSharedMemory</info>  <strong>$shm</strong>  Un segment de mémoire partagée obtenue depuis <strong>shm_attach()</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>shm_remove_var()</strong>


id: shm_remove_var
type: function
doc:
<comment>Description:</comment>
  Efface une variable de la mémoire partagée
  
  Efface la variable <strong>$key</strong> de la mémoire partagée <strong>$shm</strong> et libère la mémoire.

<comment>Param:</comment>
  <info>SysvSharedMemory</info>  <strong>$shm</strong>  Un segment de mémoire partagée obtenue depuis <strong>shm_attach()</strong>.
  <info>int</info>               <strong>$key</strong>  La clé de la variable.

<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>shm_remove()</strong>


id: shmop_close
type: function
doc:
<comment>Description:</comment>
  Ferme un bloc de mémoire partagée
  
  Cette fonction n'a aucun effet. Antérieur à PHP 8.0.0, cette fonction était utilisé pour fermer
  une ressource.
  
  <strong>shmop_close()</strong> sert à fermer un bloc de mémoire partagée.

<comment>Param:</comment>
  <info>Shmop</info>  <strong>$shmop</strong>  La ressource de mémoire partagée créé par <strong>shmop_open()</strong>.

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

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


id: shmop_delete
type: function
doc:
<comment>Description:</comment>
  Détruit un bloc de mémoire partagée
  
  <strong>shmop_delete()</strong> sert à détruire un bloc de mémoire partagée.

<comment>Param:</comment>
  <info>Shmop</info>  <strong>$shmop</strong>  La ressource de mémoire partagée créé par <strong>shmop_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: shmop_open
type: function
doc:
<comment>Description:</comment>
  Crée ou ouvre un bloc de mémoire partagée
  
  <strong>shmop_open()</strong> peut créer ou ouvrir un bloc de mémoire partagée.

<comment>Param:</comment>
  <info>int</info>     <strong>$key</strong>          Identifiant système pour le bloc de mémoire partagé. Ce paramètre peut être
                        passé comme un décimal ou un hexadécimal.
  <info>string</info>  <strong>$mode</strong>         Vous pouvez utiliser : <return>"a"</return> pour accès (utilise <return>SHM_RDONLY</return> pour shmat)
                        utilisez cette option pour ouvrir un bloc déjà existant en lecture seule.
                        <return>"c"</return> pour création (utilise <return>IPC_CREATE</return>) utilisez cette option pour créer un
                        nouveau bloc, ou, si un segment avec le même identifiant existe, essayer d'y
                        accéder en lecture et écriture. <return>"w"</return> pour accès en lecture et écriture.
                        Utilisez  cette option lorsque vous devez accéder en lecture et  écriture à
                        un segment de mémoire partagée.  C'est le cas le plus courant. <return>"n"</return> crée un
                        nouveau segment de mémoire partagée (utilise <return>IPC_CREATE|IPC_EXCL</return>). Utilisez
                        cette option lorsque vous voulez créer un nouveau segment de mémoire
                        partagée sauf s'il en existe déjà un corrompu avec la même option. Ceci est
                        très pratique pour des raisons de sécurité, pour éviter des trous de
                        sécurité qui exploiteraient la course aux ressources.
                        
                        <return>"a"</return> pour accès (utilise <return>SHM_RDONLY</return> pour shmat) utilisez cette option pour
                        ouvrir un bloc déjà existant en lecture seule.
                        
                        <return>"c"</return> pour création (utilise <return>IPC_CREATE</return>) utilisez cette option pour créer un
                        nouveau bloc, ou, si un segment avec le même identifiant existe, essayer d'y
                        accéder en lecture et écriture.
                        
                        <return>"w"</return> pour accès en lecture et écriture. Utilisez  cette option lorsque vous
                        devez accéder en lecture et  écriture à un segment de mémoire partagée.
                        C'est le cas le plus courant.
                        
                        <return>"n"</return> crée un nouveau segment de mémoire partagée (utilise
                        <return>IPC_CREATE|IPC_EXCL</return>). Utilisez cette option lorsque vous voulez créer un
                        nouveau segment de mémoire partagée sauf s'il en existe déjà un corrompu
                        avec la même option. Ceci est très pratique pour des raisons de sécurité,
                        pour éviter des trous de sécurité qui exploiteraient la course aux
                        ressources.
  <info>int</info>     <strong>$permissions</strong>  Les permissions que vous donnez à ce bloc. Ce sont les mêmes que pour les
                        fichiers. Ces permissions doivent être passées sous forme d'octal (i.e.
                        0644).
  <info>int</info>     <strong>$size</strong>         La taille du bloc mémoire partagé que vous voulez créer, en octets

<comment>Return:</comment>
  <info>Shmop|false</info>  En cas de succès, <strong>shmop_open()</strong> retourne une instance de <class>Shmop</class> que vous pouvez
               utiliser pour accéder à la mémoire que vous venez de créer. <info>false</info> sera retourné en
               cas d'échec.

<comment>See Also:</comment>
   * <strong>shmop_close()</strong>
   * <strong>shmop_delete()</strong>


id: shmop_read
type: function
doc:
<comment>Description:</comment>
  Lit des données à partir d'un bloc
  
  <strong>shmop_read()</strong> lit une chaîne dans un bloc de mémoire partagée.

<comment>Param:</comment>
  <info>Shmop</info>  <strong>$shmop</strong>   L'identifiant du bloc mémoire partagé, créé par la fonction <strong>shmop_open()</strong>
  <info>int</info>    <strong>$offset</strong>  Position depuis laquelle on doit commencer à lire; doit être supérieur ou égal à
                  zéro et inférieur ou égal à la taille réelle du segment de mémoire partagée.
  <info>int</info>    <strong>$size</strong>    Le nombre d'octets à lire; doit être supérieur ou égal à zéro, et la somme de
                  <strong>$offset</strong> et <strong>$size</strong> doit être inférieure ou égale à la taille réelle du segment de
                  mémoire partagée. <return>0</return> lit shmop_size($shmid) - $start octets.

<comment>Return:</comment>
  <info>string</info>  Retourne les données ou <info>false</info> si une erreur survient.

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


id: shmop_size
type: function
doc:
<comment>Description:</comment>
  Lire la taille du bloc de mémoire partagée
  
  <strong>shmop_size()</strong> sert à connaître la taille en octets d'un bloc de mémoire partagée.

<comment>Param:</comment>
  <info>Shmop</info>  <strong>$shmop</strong>  L'identifiant du bloc mémoire partagé créé par la fonction <strong>shmop_open()</strong>

<comment>Return:</comment>
  <info>int</info>  Retourne un entier, qui représente le nombre d'octets qu'occupe la mémoire partagée.


id: shmop_write
type: function
doc:
<comment>Description:</comment>
  Écrire dans un bloc de mémoire partagée
  
  <strong>shmop_write()</strong> écrit une chaîne dans un bloc de mémoire partagée.

<comment>Param:</comment>
  <info>Shmop</info>   <strong>$shmop</strong>   L'identifiant du bloc mémoire partagé, créé par la fonction <strong>shmop_open()</strong>
  <info>string</info>  <strong>$data</strong>    Une chaîne à écrire dans le bloc de la mémoire partagée
  <info>int</info>     <strong>$offset</strong>  Spécifie la position à partir de laquelle les données doivent être écrites dans
                   la mémoire partagée. L'offset doit être supérieur ou égal à zéro et inférieur ou
                   égal à la taille réelle du segment de mémoire partagée.

<comment>Return:</comment>
  <info>int</info>  La taille des données écrites.

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


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


id: shuffle
type: function
doc:
<comment>Description:</comment>
  Mélange les éléments d'un tableau
  
  Mélange les éléments du tableau <strong>$array</strong>.
  
  Cette fonction ne génère pas de valeurs cryptographiquement sûres, et ne doit pas être utilisée à
  des fins cryptographiques, ou à des fins qui exigent que les valeurs renvoyées soient
  indéchiffrables.
  
  Si de l'aléatoire cryptographiquement sûre est requis, le <class>Random\Randomizer</class> peut être utilisé avec
  le moteur <class>Random\Engine\Secure</class>. Pour des cas d'usage simple, les fonctions <strong>random_int()</strong> et
  <strong>random_bytes()</strong> fournissent une API pratique et sûre qui est qui est soutenu par le CSPRNG du
  système d'exploitation.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Le tableau.

<comment>Return:</comment>
  <info>true</info>  Retourne toujours <info>true</info>.

<comment>See Also:</comment>
   * <strong>Random\Randomizer::shuffleArray()</strong>
   * <strong>Random\Randomizer::shuffleBytes()</strong>
   * <strong>Random\Randomizer::pickArrayKeys()</strong>
   * Les fonctions de tri des tableaux


id: simdjson_decode
type: function
doc:
<comment>Description:</comment>
  Decodes a JSON string
  
  Takes a JSON encoded string and converts it into a PHP value. This uses a faster Simultaneous
  Instruction, Multiple Data implementation than <strong>json_decode()</strong> when it is supported by the computer
  architecture.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>         The <strong>$json</strong> <info>string</info> being decoded.
                        
                        This function only works with UTF-8 encoded strings.
                        
                        This function parses valid inputs which <strong>json_decode()</strong> can decode, provided
                        that they are less than 4 GiB long.
  <info>bool</info>    <strong>$associative</strong>  When <info>true</info>, JSON objects will be returned as associative tableaus; when
                        <info>false</info>, JSON objects will be returned as objets.
  <info>int</info>     <strong>$depth</strong>        Maximum nesting depth of the structure being decoded. The value must be
                        greater than <return>0</return>, and less than or equal to <return>2147483647</return>.
                         Callers should use reasonably small values, because larger depths require
                        more buffer space and will increase the recursion depth, unlike the current
                        <strong>json_decode()</strong> implementation.

<comment>Return:</comment>
  <info>mixed</info>  Returns the value encoded in <strong>$json</strong> in appropriate PHP type. Values <return>true</return>, <return>false</return> and <return>null</return> are
         returned as <info>true</info>, <info>false</info> and <info>null</info> respectively.

<comment>See Also:</comment>
   * <strong>json_encode()</strong>
   * <strong>json_decode()</strong>


id: simdjson_is_valid
type: function
doc:
<comment>Description:</comment>
  Check if a JSON string is valid
  
  Takes a JSON encoded string and returns true if it is valid.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>   The <strong>$json</strong> <info>string</info> being validated.
                  
                  This function only works with UTF-8 encoded strings.
                  
                  This function validates inputs which <strong>json_decode()</strong> can decode, provided that they
                  are less than 4 GiB long.
  <info>int</info>     <strong>$depth</strong>  Maximum nesting depth of the structure being validated. The value must be greater
                  than <return>0</return>, and less than or equal to <return>2147483647</return>.
                   Callers should use reasonably small values, because larger depths require more
                  buffer space and will increase the recursion depth, unlike the current
                  <strong>json_decode()</strong> implementation.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if <strong>$json</strong> is a valid JSON string, <info>false</info> otherwise.

<comment>See Also:</comment>
   * <strong>json_encode()</strong>
   * <strong>json_decode()</strong>


id: simdjson_key_count
type: function
doc:
<comment>Description:</comment>
  Returns the value at a JSON pointer.
  
  Count the number of elements of the object/array found at the requested JSON pointer.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>                  The <strong>$json</strong> <info>string</info> being queried.
  <info>string</info>  <strong>$key</strong>                   The JSON pointer <info>string</info>.
  <info>int</info>     <strong>$depth</strong>                 Maximum nesting depth of the structure being validated. The value
                                 must be greater than <return>0</return>, and less than or equal to <return>2147483647</return>.
                                  Callers should use reasonably small values, because larger depths
                                 require more buffer space and will increase the recursion depth,
                                 unlike the current <strong>json_decode()</strong> implementation.
  <info>bool</info>    <strong>$throw_if_uncountable</strong>  When true, a <class>SimdJsonException</class> will be thrown instead of returning
                                 0 when the value the JSON pointer points to is neither an object
                                 nor an array.

<comment>Return:</comment>
  <info>int</info>  Returns an entier with the number of elements of the value at the given JSON pointer.


id: simdjson_key_exists
type: function
doc:
<comment>Description:</comment>
  Check if the JSON contains the value referred to by a JSON pointer.
  
  Count the number of elements of the object/array found at the requested JSON pointer.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>                  The <strong>$json</strong> <info>string</info> being queried.
  <info>string</info>  <strong>$key</strong>                   The JSON pointer <info>string</info>.
  <info>int</info>     <strong>$depth</strong>                 Maximum nesting depth of the structure being validated. The value
                                 must be greater than <return>0</return>, and less than or equal to <return>2147483647</return>.
                                  Callers should use reasonably small values, because larger depths
                                 require more buffer space and will increase the recursion depth,
                                 unlike the current <strong>json_decode()</strong> implementation.
  <info></info>        <strong>$throw_if_uncountable</strong>  When true, a <class>SimdJsonException</class> will be thrown instead of returning
                                 0 when the value the JSON pointer points to is neither an object
                                 nor an array.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the JSON pointer is valid and refers to a value found within a valid JSON
        string. Returns <info>false</info> if the JSON is valid but does not contain the JSON pointer.


id: simdjson_key_value
type: function
doc:
<comment>Description:</comment>
  Decodes the value of a JSON string located at the requested JSON pointer.
  
  Decodes and returns the value found at the requested JSON pointer.

<comment>Param:</comment>
  <info>string</info>  <strong>$json</strong>         The <strong>$json</strong> <info>string</info> being queried and decoded.
                        
                        This function only works with UTF-8 encoded strings.
                        
                        This function parses valid inputs which <strong>json_decode()</strong> can decode, provided
                        that they are less than 4 GiB long.
  <info>string</info>  <strong>$key</strong>          The JSON pointer <info>string</info>.
  <info>bool</info>    <strong>$associative</strong>  When <info>true</info>, JSON objects will be returned as associative tableaus; when
                        <info>false</info>, JSON objects will be returned as objets.
  <info>int</info>     <strong>$depth</strong>        Maximum nesting depth of the structure being decoded. The value must be
                        greater than <return>0</return>, and less than or equal to <return>2147483647</return>.
                         Callers should use reasonably small values, because larger depths require
                        more buffer space and will increase the recursion depth, unlike the current
                        <strong>json_decode()</strong> implementation.

<comment>Return:</comment>
  <info>mixed</info>  Returns the part of the value encoded in <strong>$json</strong> that <strong>$key</strong> refers to in appropriate PHP type.
         Values <return>true</return>, <return>false</return> and <return>null</return> are returned as <info>true</info>, <info>false</info> and <info>null</info> respectively.

<comment>See Also:</comment>
   * <strong>json_encode()</strong>
   * <strong>simdjson_decode()</strong>


