# php_manual

id: vsprintf
type: function
doc:
<comment>Description:</comment>
  Retourne une chaîne formatée
  
  <strong>vsprintf()</strong> fonctionne comme <strong>sprintf()</strong>, mais accepte un tableau comme argument, au lieu d'une liste
  d'arguments.

<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>array</info>   <strong>$values</strong>  

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne formatée à partir du tableau de valeurs <strong>$values</strong>, et en utilisant le
          format <strong>$format</strong>.

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


id: wddx_add_vars
type: function
doc:
<comment>Description:</comment>
  Ajoute des variables à un paquet WDDX
  
  Sert à enregistrer et à ajouter les variables passées en argument au paquet repéré par son
  identifiant <strong>$packet_id</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$packet_id</strong>  Un paquet WDDX, retourné par la fonction <strong>wddx_packet_start()</strong>.
  <info>mixed</info>     <strong>$var_name</strong>   Peut être une chaîne de caractères nommant une variable ou un tableau
                        contenant des noms de variables ou d'autres tableaux, etc..
  <info>mixed</info>     <strong>$var_names</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: wddx_deserialize
type: function
doc:
<comment>Description:</comment>
  Désérialise un paquet WDDX
  
  Désérialise un paquet <strong>$packet</strong> WDDX.
  
  Ne passez pas d'entrée utilisateur non vérifiée à <strong>wddx_deserialize()</strong>. La désérialisation peut
  faire que le code soit chargé, et exécuté lors de l'instanciation et l'autochargement de l'objet,
  et un utilisateur mal intentionné peut être capable d'y loger un exploit. Utilisez une format,
  sûr, d'échange de données standardisé comme JSON (à l'aide de <strong>json_decode()</strong> et <strong>json_encode()</strong>) si
  vous devez passer des données sérialisé à l'utilisateur.

<comment>Param:</comment>
  <info>string</info>  <strong>$packet</strong>  Un paquet WDDX, sous la forme d'une chaîne de caractères ou d'un flux.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur désérialisée, pouvant être une chaîne de caractères, un nombre ou un
         tableau. Notez que les structures sont désérialisées dans des tableaux associatifs.


id: wddx_packet_end
type: function
doc:
<comment>Description:</comment>
  Clôt un paquet WDDX
  
  Clôt un paquet WDDX.

<comment>Param:</comment>
  <info>resource</info>  <strong>$packet_id</strong>  Un paquet WDDX, retourné par la fonction <strong>wddx_packet_start()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères contenant le paquet WDDX.


id: wddx_packet_start
type: function
doc:
<comment>Description:</comment>
  Commence un nouveau paquet WDDX avec une structure
  
  <strong>wddx_packet_start()</strong> sert à créer un nouveau paquet WDDX, pour pouvoir y faire des ajouts
  incrémentaux de variables. Elle va automatiquement créer une définition de structure dans le
  paquet, pour accueillir des variables.

<comment>Param:</comment>
  <info>string</info>  <strong>$comment</strong>  Une chaîne de caractères optionnelle contenant le commentaire.

<comment>Return:</comment>
  <info>resource</info>  Retourne un identifiant de paquet pour utilisation ultérieure avec les fonctions WDDX,
            ou <info>false</info> si une erreur survient.


id: wddx_serialize_value
type: function
doc:
<comment>Description:</comment>
  Enregistre une valeur dans un paquet WDDX
  
  Enregistre une valeur donnée dans un paquet WDDX.

<comment>Param:</comment>
  <info>mixed</info>   <strong>$var</strong>      La valeur à sérialiser.
  <info>string</info>  <strong>$comment</strong>  Une chaîne de caractères optionnelle contenant un commentaire qui apparaît dans
                    l'en-tête du paquet.

<comment>Return:</comment>
  <info>string</info>  Retourne le paquet WDDX, ou <info>false</info> si une erreur survient.


id: wddx_serialize_vars
type: function
doc:
<comment>Description:</comment>
  Enregistre plusieurs valeurs dans un paquet WDDX
  
  Sert à créer un paquet WDDX avec une structure qui contient la représentation des variables
  passées en arguments.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$var_name</strong>   Peut être soit une chaîne de caractères nommant une variable ou un tableau
                     contenant des noms de variables ou d'autres tableaux, etc..
  <info>mixed</info>  <strong>$var_names</strong>  

<comment>Return:</comment>
  <info>string</info>  Retourne le paquet WDDX, ou <info>false</info> si une erreur survient.


id: win32_continue_service
type: function
doc:
<comment>Description:</comment>
  Reprise d'un service en pause
  
  Reprise d'un service en pause. Requiert des privilèges d'administrateur ou  un compte avec les
  droits appropriés définis dans l'ACL du service.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  Le nom court du service.
  <info>string</info>  <strong>$machine</strong>      Nom de la machine (optionnel). Si omis, la machine locale sera utilisée.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.
        
        Avant la version 1.0.0, retournait <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem
        with the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Les codes erreur Win32


id: win32_create_service
type: function
doc:
<comment>Description:</comment>
  Crée une nouvelle entrée pour service dans la base de données SCM
  
  Tente d'ajouter un service dans la base de données SCM. Des privilèges  d'administrateur sont
  nécessaires pour que cela réussisse.

<comment>Param:</comment>
  <info>array</info>   <strong>$details</strong>                Un tableau des détails des services : <strong>$service</strong> Le nom court du
                                  service. C'est le nom que vous utiliserez pour contrôler le
                                  service en utilisant la commande <return>net</return>. Le service doit être unique
                                  (deux services ne peuvent partager le même nom), et idéalement,
                                  devrait éviter d'avoir des espaces dans son nom. <strong>$display</strong>Le nom
                                  d'affichage du service. C'est le nom que vous verrez dans l'Applet
                                  Services. <strong>$description</strong> La description longue du service. C'est la
                                  description que vous verrez dans l'Applet des services. <strong>$user</strong> Le
                                  nom de l'utilisateur sous lequel vous voulez que le service
                                  s'exécute. Si oublié, le service fonctionnera en tant que
                                  LocalSystem. Si le nom de l'utilisateur est spécifié, vous devez
                                  aussi fournir un mot de passe. <strong>$password</strong> Le mot de passe qui
                                  correspond à <strong>$user</strong>. <strong>$path</strong> Le chemin complet au module exécutable
                                  qui sera démarré lorsque le service est démarré. Si oublié, le
                                  chemin du processus courant de PHP sera utilisé. <strong>$params</strong>
                                  Paramètres de commande à passer au service lorsqu'il démarre. Si
                                  vous voulez exécuter un script PHP en tant que service, alors le
                                  premier paramètre devrait être le chemin complet au script PHP que
                                  vous prévoyez exécuter. Si le nom du script ou le chemin
                                  contiennent des espaces, alors, entourez le chemin complet du
                                  script PHP par des <return>"</return> <strong>$load_order</strong> Contrôle le load_order. Cela
                                  n'est pas encore complètement supporté. <strong>$svc_type</strong> Fixe le type de
                                  service. Si oublié, la valeur par défaut est
                                  <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info>. Ne changez pas ceci à moins que
                                  vous savez vraiment ce que vous faites. <strong>$start_type</strong> Spécifie
                                  comment le service devrait être démarré. La valeur par défaut est
                                  <info>WIN32_SERVIDE_AUTO_START</info> qui signifie que le service sera démarré
                                  lorsque la machine démarrera. <strong>$error_control</strong> Informe le SCM à
                                  propos de ce qu'il devrait faire lorsqu'il détecte un problème
                                  avec le service. La valeur par défaut est
                                  <info>WIN32_SERVER_ERROR_IGNORE</info>. Le changement de cette valeur n'est pas
                                  encore complètement supporté. <strong>$delayed_start</strong> Si <strong>$delayed_start</strong> est
                                  défini à <info>true</info>, alors il informera le SCM que ce service doit être
                                  démarré après les services démarrés automatiquement et un certain
                                  délai.  N'importe quel service peut être marqué comme étant un
                                  service retardé après le démarrage automatique ; cependant, cette
                                  configuration n'a aucun effet tant que le paramètre <strong>$start_type</strong> du
                                  service vaut <info>WIN32_SERVICE_AUTO_START</info>.  Cette configuration n'est
                                  application que sous Windows Vista et les serveurs Windows 2008 et
                                  suivants. <strong>$base_priority</strong> Pour réduire l'impacte sur l'utilisation
                                  du processeur, il peut être nécessaire de définir une priorité
                                  plus basse qu'à la normale.  Le paramètre <strong>$base_priority</strong> peut être
                                  défini à une des constantes définies dans les classes de basse
                                  priorité Win32. <strong>$dependencies</strong> Pour définir les dépendances de
                                  votre service, il est nécessaire de  définir ce paramètre avec la
                                  liste des noms des service dans un tableau. <strong>$recovery_delay</strong> Ce
                                  paramètre défini le délai entre la défaillance et l'exécution de
                                  l'action de récupération. La valeur est en millisecondes.  La
                                  valeur par défaut est 60000. <strong>$recovery_action_1</strong> L'action qui sera
                                  exécuté lors de la première défaillance. L'action  par défaut est
                                  <info>WIN32_SC_ACTION_NONE</info>.  Le paramètre <strong>$recovery_action_1</strong> peut être
                                  défini  avec l'une des constantes définie dans les Actions de
                                  récupération Win32. <strong>$recovery_action_2</strong> L'action qui sera exécuté
                                  lors de la deuxième défaillance. L'action  par défaut est
                                  <info>WIN32_SC_ACTION_NONE</info>.  Le paramètre <strong>$recovery_action_2</strong> peut être
                                  défini  avec l'une des constantes définie dans les Actions de
                                  récupération Win32. <strong>$recovery_action_3</strong> L'action qui sera exécuté
                                  lors des défaillances suivantes. L'action  par défaut est
                                  <info>WIN32_SC_ACTION_NONE</info>.  Le paramètre <strong>$recovery_action_3</strong> peut être
                                  défini  avec l'une des constantes définie dans les Actions de
                                  récupération Win32. <strong>$recovery_reset_period</strong> Le compteur des
                                  défaillance sera réinitialisé après le délai défini  dans ce
                                  paramètre. Le délai est exprimé en secondes.  La valeur par défaut
                                  est <return>86400</return>. <strong>$recovery_enabled</strong> Définir ce paramètre à <info>true</info> pour
                                  activer les options de récupération, et <info>false</info>  pour les
                                  désactiver.   La valeur par défaut est <info>false</info> <strong>$recovery_reboot_msg</strong>
                                  Ajouter ce paramètre pour définir le message enregistré dans le
                                  jounal  d'évènements Windows avant le redémarrage. Utilisé
                                  uniquement si l'une  des actions est défini à
                                  <info>WIN32_SC_ACTION_REBOOT</info>. <strong>$recovery_command</strong> Ajouter ce paramètre
                                  pour définir la commande a exécuter lorsqu'une  action est définie
                                  à  <info>WIN32_SC_ACTION_RUN_COMMAND</info>.
                                  
                                  Le nom court du service. C'est le nom que vous utiliserez pour
                                  contrôler le service en utilisant la commande <return>net</return>. Le service doit
                                  être unique (deux services ne peuvent partager le même nom), et
                                  idéalement, devrait éviter d'avoir des espaces dans son nom.
                                  
                                  Le nom d'affichage du service. C'est le nom que vous verrez dans
                                  l'Applet Services.
                                  
                                  La description longue du service. C'est la description que vous
                                  verrez dans l'Applet des services.
                                  
                                  Le nom de l'utilisateur sous lequel vous voulez que le service
                                  s'exécute. Si oublié, le service fonctionnera en tant que
                                  LocalSystem. Si le nom de l'utilisateur est spécifié, vous devez
                                  aussi fournir un mot de passe.
                                  
                                  Le mot de passe qui correspond à <strong>$user</strong>.
                                  
                                  Le chemin complet au module exécutable qui sera démarré lorsque le
                                  service est démarré. Si oublié, le chemin du processus courant de
                                  PHP sera utilisé.
                                  
                                  Paramètres de commande à passer au service lorsqu'il démarre. Si
                                  vous voulez exécuter un script PHP en tant que service, alors le
                                  premier paramètre devrait être le chemin complet au script PHP que
                                  vous prévoyez exécuter. Si le nom du script ou le chemin
                                  contiennent des espaces, alors, entourez le chemin complet du
                                  script PHP par des <return>"</return>
                                  
                                  Contrôle le load_order. Cela n'est pas encore complètement
                                  supporté.
                                  
                                  Fixe le type de service. Si oublié, la valeur par défaut est
                                  <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info>. Ne changez pas ceci à moins que
                                  vous savez vraiment ce que vous faites.
                                  
                                  Spécifie comment le service devrait être démarré. La valeur par
                                  défaut est <info>WIN32_SERVIDE_AUTO_START</info> qui signifie que le service
                                  sera démarré lorsque la machine démarrera.
                                  
                                  Informe le SCM à propos de ce qu'il devrait faire lorsqu'il
                                  détecte un problème avec le service. La valeur par défaut est
                                  <info>WIN32_SERVER_ERROR_IGNORE</info>. Le changement de cette valeur n'est pas
                                  encore complètement supporté.
                                  
                                  Si <strong>$delayed_start</strong> est défini à <info>true</info>, alors il informera le SCM que
                                  ce service doit être démarré après les services démarrés
                                  automatiquement et un certain délai.
                                  
                                  N'importe quel service peut être marqué comme étant un service
                                  retardé après le démarrage automatique ; cependant, cette
                                  configuration n'a aucun effet tant que le paramètre <strong>$start_type</strong> du
                                  service vaut <info>WIN32_SERVICE_AUTO_START</info>.
                                  
                                  Cette configuration n'est application que sous Windows Vista et
                                  les serveurs Windows 2008 et suivants.
                                  
                                  Pour réduire l'impacte sur l'utilisation du processeur, il peut
                                  être nécessaire de définir une priorité plus basse qu'à la
                                  normale.
                                  
                                  Le paramètre <strong>$base_priority</strong> peut être défini à une des constantes
                                  définies dans les classes de basse priorité Win32.
                                  
                                  Pour définir les dépendances de votre service, il est nécessaire
                                  de  définir ce paramètre avec la liste des noms des service dans
                                  un tableau.
                                  
                                  Ce paramètre défini le délai entre la défaillance et l'exécution
                                  de  l'action de récupération. La valeur est en millisecondes.
                                  
                                  La valeur par défaut est 60000.
                                  
                                  L'action qui sera exécuté lors de la première défaillance.
                                  L'action  par défaut est <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  Le paramètre <strong>$recovery_action_1</strong> peut être défini  avec l'une des
                                  constantes définie dans les Actions de récupération Win32.
                                  
                                  L'action qui sera exécuté lors de la deuxième défaillance.
                                  L'action  par défaut est <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  Le paramètre <strong>$recovery_action_2</strong> peut être défini  avec l'une des
                                  constantes définie dans les Actions de récupération Win32.
                                  
                                  L'action qui sera exécuté lors des défaillances suivantes.
                                  L'action  par défaut est <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  Le paramètre <strong>$recovery_action_3</strong> peut être défini  avec l'une des
                                  constantes définie dans les Actions de récupération Win32.
                                  
                                  Le compteur des défaillance sera réinitialisé après le délai
                                  défini  dans ce paramètre. Le délai est exprimé en secondes.
                                  
                                  La valeur par défaut est <return>86400</return>.
                                  
                                  Définir ce paramètre à <info>true</info> pour activer les options de
                                  récupération, et <info>false</info>  pour les désactiver.
                                  
                                  La valeur par défaut est <info>false</info>
                                  
                                  Ajouter ce paramètre pour définir le message enregistré dans le
                                  jounal  d'évènements Windows avant le redémarrage. Utilisé
                                  uniquement si l'une  des actions est défini à
                                  <info>WIN32_SC_ACTION_REBOOT</info>.
                                  
                                  Ajouter ce paramètre pour définir la commande a exécuter
                                  lorsqu'une  action est définie à  <info>WIN32_SC_ACTION_RUN_COMMAND</info>.
  <info></info>        <strong>$service</strong>                Le nom court du service. C'est le nom que vous utiliserez pour
                                  contrôler le service en utilisant la commande <return>net</return>. Le service doit
                                  être unique (deux services ne peuvent partager le même nom), et
                                  idéalement, devrait éviter d'avoir des espaces dans son nom.
  <info></info>        <strong>$display</strong>                Le nom d'affichage du service. C'est le nom que vous verrez dans
                                  l'Applet Services.
  <info></info>        <strong>$description</strong>            La description longue du service. C'est la description que vous
                                  verrez dans l'Applet des services.
  <info></info>        <strong>$user</strong>                   Le nom de l'utilisateur sous lequel vous voulez que le service
                                  s'exécute. Si oublié, le service fonctionnera en tant que
                                  LocalSystem. Si le nom de l'utilisateur est spécifié, vous devez
                                  aussi fournir un mot de passe.
  <info></info>        <strong>$password</strong>               Le mot de passe qui correspond à <strong>$user</strong>.
  <info></info>        <strong>$path</strong>                   Le chemin complet au module exécutable qui sera démarré lorsque le
                                  service est démarré. Si oublié, le chemin du processus courant de
                                  PHP sera utilisé.
  <info></info>        <strong>$params</strong>                 Paramètres de commande à passer au service lorsqu'il démarre. Si
                                  vous voulez exécuter un script PHP en tant que service, alors le
                                  premier paramètre devrait être le chemin complet au script PHP que
                                  vous prévoyez exécuter. Si le nom du script ou le chemin
                                  contiennent des espaces, alors, entourez le chemin complet du
                                  script PHP par des <return>"</return>
  <info></info>        <strong>$load_order</strong>             Contrôle le load_order. Cela n'est pas encore complètement
                                  supporté.
  <info></info>        <strong>$svc_type</strong>               Fixe le type de service. Si oublié, la valeur par défaut est
                                  <info>WIN32_SERVICE_WIN32_OWN_PROCESS</info>. Ne changez pas ceci à moins que
                                  vous savez vraiment ce que vous faites.
  <info></info>        <strong>$start_type</strong>             Spécifie comment le service devrait être démarré. La valeur par
                                  défaut est <info>WIN32_SERVIDE_AUTO_START</info> qui signifie que le service
                                  sera démarré lorsque la machine démarrera.
  <info></info>        <strong>$error_control</strong>          Informe le SCM à propos de ce qu'il devrait faire lorsqu'il
                                  détecte un problème avec le service. La valeur par défaut est
                                  <info>WIN32_SERVER_ERROR_IGNORE</info>. Le changement de cette valeur n'est pas
                                  encore complètement supporté.
  <info></info>        <strong>$delayed_start</strong>          Si <strong>$delayed_start</strong> est défini à <info>true</info>, alors il informera le SCM que
                                  ce service doit être démarré après les services démarrés
                                  automatiquement et un certain délai.
                                  
                                  N'importe quel service peut être marqué comme étant un service
                                  retardé après le démarrage automatique ; cependant, cette
                                  configuration n'a aucun effet tant que le paramètre <strong>$start_type</strong> du
                                  service vaut <info>WIN32_SERVICE_AUTO_START</info>.
                                  
                                  Cette configuration n'est application que sous Windows Vista et
                                  les serveurs Windows 2008 et suivants.
  <info></info>        <strong>$base_priority</strong>          Pour réduire l'impacte sur l'utilisation du processeur, il peut
                                  être nécessaire de définir une priorité plus basse qu'à la
                                  normale.
                                  
                                  Le paramètre <strong>$base_priority</strong> peut être défini à une des constantes
                                  définies dans les classes de basse priorité Win32.
  <info></info>        <strong>$dependencies</strong>           Pour définir les dépendances de votre service, il est nécessaire
                                  de  définir ce paramètre avec la liste des noms des service dans
                                  un tableau.
  <info></info>        <strong>$recovery_delay</strong>         Ce paramètre défini le délai entre la défaillance et l'exécution
                                  de  l'action de récupération. La valeur est en millisecondes.
                                  
                                  La valeur par défaut est 60000.
  <info></info>        <strong>$recovery_action_1</strong>      L'action qui sera exécuté lors de la première défaillance.
                                  L'action  par défaut est <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  Le paramètre <strong>$recovery_action_1</strong> peut être défini  avec l'une des
                                  constantes définie dans les Actions de récupération Win32.
  <info></info>        <strong>$recovery_action_2</strong>      L'action qui sera exécuté lors de la deuxième défaillance.
                                  L'action  par défaut est <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  Le paramètre <strong>$recovery_action_2</strong> peut être défini  avec l'une des
                                  constantes définie dans les Actions de récupération Win32.
  <info></info>        <strong>$recovery_action_3</strong>      L'action qui sera exécuté lors des défaillances suivantes.
                                  L'action  par défaut est <info>WIN32_SC_ACTION_NONE</info>.
                                  
                                  Le paramètre <strong>$recovery_action_3</strong> peut être défini  avec l'une des
                                  constantes définie dans les Actions de récupération Win32.
  <info></info>        <strong>$recovery_reset_period</strong>  Le compteur des défaillance sera réinitialisé après le délai
                                  défini  dans ce paramètre. Le délai est exprimé en secondes.
                                  
                                  La valeur par défaut est <return>86400</return>.
  <info></info>        <strong>$recovery_enabled</strong>       Définir ce paramètre à <info>true</info> pour activer les options de
                                  récupération, et <info>false</info>  pour les désactiver.
                                  
                                  La valeur par défaut est <info>false</info>
  <info></info>        <strong>$recovery_reboot_msg</strong>    Ajouter ce paramètre pour définir le message enregistré dans le
                                  jounal  d'évènements Windows avant le redémarrage. Utilisé
                                  uniquement si l'une  des actions est défini à
                                  <info>WIN32_SC_ACTION_REBOOT</info>.
  <info></info>        <strong>$recovery_command</strong>       Ajouter ce paramètre pour définir la commande a exécuter
                                  lorsqu'une  action est définie à  <info>WIN32_SC_ACTION_RUN_COMMAND</info>.
  <info>string</info>  <strong>$machine</strong>                Le nom optionnel de la machine sur lequel vous voulez créer le
                                  service. Si oublié, cela utilisera la machine locale.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.
        
        Avant la version 1.0.0, retournait <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem
        with the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_delete_service()</strong>
   * Les classes de basse priorité Win32
   * Les actions de récupération Win32
   * Les codes erreurs Win32


id: win32_delete_service
type: function
doc:
<comment>Description:</comment>
  Supprime une entrée de service de la base de données SCM
  
  Essaie de supprimer un service de la base de données SCM. Les privilèges d'administrateur sont
  requis pour que cette fonction réussisse.
  
  Cette fonction ne fait que marquer le service pour suppression. Si d'autre processus (comme
  l'Applet Services) sont ouverts, alors la suppression sera reportée jusqu'à ce que ces
  applications soient fermées. Si un service est marqué pour suppression, d'autres tentatives de
  suppression échoueront et les tentatives de créer un nouveau service avec ce nom échoueront aussi.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  Le nom court du service.
  <info>string</info>  <strong>$machine</strong>      Le nom optionnel de la machine. Si oublié, cela utilisera la machine locale.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.
        
        Avant la version 1.0.0, retournait <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem
        with the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_create_service()</strong>
   * Les codes erreur Win32


id: win32_get_last_control_message
type: function
doc:
<comment>Description:</comment>
  Retourne le dernier message de contrôle qui a été envoyé à ce service
  
  Retourne le code de contrôle qui a été envoyé en dernier à ce processus de service. Lorsqu'il
  fonctionne en tant que service, vous devriez vérifier périodiquement pour déterminer si le service
  doit être arrêté.
  
  Depuis la version 0.2.0, cette fonction fonctionne uniquement en ligne de  commande. Elle est
  désactivé dans les autres cas.

<comment>Return:</comment>
  <info>int</info>  Retourne une constante de contrôle qui sera une parmi les constantes de contrôle des messages
       de service Win32Service : <info>WIN32_SERVICE_CONTROL_CONTINUE</info>, <info>WIN32_SERVICE_CONTROL_DEVICEEVENT</info>,
       <info>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</info>, <info>WIN32_SERVICE_CONTROL_INTERROGATE</info>,
       <info>WIN32_SERVICE_CONTROL_NETBINDADD</info>, <info>WIN32_SERVICE_CONTROL_NETBINDDISABLE</info>,
       <info>WIN32_SERVICE_CONTROL_NETBINDENABLE</info>, <info>WIN32_SERVICE_CONTROL_NETBINDREMOVE</info>,
       <info>WIN32_SERVICE_CONTROL_PARAMCHANGE</info>, <info>WIN32_SERVICE_CONTROL_PAUSE</info>,
       <info>WIN32_SERVICE_CONTROL_POWEREVENT</info>, <info>WIN32_SERVICE_CONTROL_PRESHUTDOWN</info>,
       <info>WIN32_SERVICE_CONTROL_SESSIONCHANGE</info>, <info>WIN32_SERVICE_CONTROL_SHUTDOWN</info>,
       <info>WIN32_SERVICE_CONTROL_STOP</info>.
       
       Si la valeur se situe entre 128 et 255, le code de contrôle est personnalisé.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * les constantes de contrôle des messages de service Win32Service


id: win32_pause_service
type: function
doc:
<comment>Description:</comment>
  Met en pause un service
  
  Met en pause un service. Requiert des privilèges d'administrateur ou  un compte avec les droits
  appropriés définis dans l'ACL du service.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  Le nom court du service.
  <info>string</info>  <strong>$machine</strong>      Nom de la machine (optionnel). Si omis, la machine locale sera utilisée.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.
        
        Avant la version 1.0.0, retournait <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem
        with the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Les codes erreur Win32


id: win32_query_service_status
type: function
doc:
<comment>Description:</comment>
  Questionne le statut d'un service
  
  Questionne le statut courant pour un service, retournant un tableau d'informations.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  Le nom court du service.
  <info>string</info>  <strong>$machine</strong>      Le nom optionnel de la machine. Si oublié, cela utilisera la machine locale.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant les informations suivantes en cas de succès.
         
         Avant la version 1.0.0, <info>false</info> if there is a problem with the parameters or a Win32 Error
         Code on failure.
         
         <strong>$ServiceType</strong> Le dwServiceType. Voir les  masques de type de service Win32Service.
         <strong>$CurrentState</strong> Le dwCurrentState. Voir les constantes de statut des services Win32Service.
         <strong>$ControlsAccepted</strong> Quels contrôles de service sont acceptés par le service. Voir les masques
         acceptés pour les messages de contrôle de service Win32Service. <strong>$Win32ExitCode</strong> Si le
         service quitte, le code de retour du processus. Cette valeur est égale  à
         <info>WIN32_ERROR_SERVICE_SPECIFIC_ERROR</info> si le mode de  sortie n'est pas gracieux. Voir  codes
         d'erreur Win32Service  et <strong>win32_set_service_exit_mode()</strong>. <strong>$ServiceSpecificExitCode</strong> Si le
         service quitte avec une condition d'erreur, le code spécifique du service qui sera
         enregistré dans le journal d'évènements est visible ici. Cette valeur est égale à la valeur
         définie par   <strong>win32_set_service_exit_code()</strong>. <strong>$CheckPoint</strong> Si le service s'arrête, garde le
         nombre courant de point de contrôle. Ceci est utilisé par SCM comme un genre de battement
         de cœur pour détecter un processus de service arrêté. La valeur du point de contrôle est
         mieux interprétée en conjonction avec la valeur WaitHint. <strong>$WaitHint</strong> Si le service s'arrête,
         il fixera un WaitHint à une valeur de point de contrôle qui indiquera l'exécution 100%.
         Cela peut être utilisé pour implanter un indicateur de progrès. <strong>$ProcessId</strong> L'identifiant de
         processus de fenêtre. Si 0, le processus ne fonctionne pas. <strong>$ServiceFlags</strong> Le
         dwServiceFlags. Voir les constantes utilisées pour les drapeaux des services Win32Service.
         
         Le dwServiceType. Voir les  masques de type de service Win32Service.
         
         Le dwCurrentState. Voir les constantes de statut des services Win32Service.
         
         Quels contrôles de service sont acceptés par le service. Voir les masques acceptés pour les
         messages de contrôle de service Win32Service.
         
         Si le service quitte, le code de retour du processus. Cette valeur est égale  à
         <info>WIN32_ERROR_SERVICE_SPECIFIC_ERROR</info> si le mode de  sortie n'est pas gracieux. Voir  codes
         d'erreur Win32Service  et <strong>win32_set_service_exit_mode()</strong>.
         
         Si le service quitte avec une condition d'erreur, le code spécifique du service qui sera
         enregistré dans le journal d'évènements est visible ici. Cette valeur est égale à la valeur
         définie par   <strong>win32_set_service_exit_code()</strong>.
         
         Si le service s'arrête, garde le nombre courant de point de contrôle. Ceci est utilisé par
         SCM comme un genre de battement de cœur pour détecter un processus de service arrêté. La
         valeur du point de contrôle est mieux interprétée en conjonction avec la valeur WaitHint.
         
         Si le service s'arrête, il fixera un WaitHint à une valeur de point de contrôle qui
         indiquera l'exécution 100%. Cela peut être utilisé pour implanter un indicateur de progrès.
         
         L'identifiant de processus de fenêtre. Si 0, le processus ne fonctionne pas.
         
         Le dwServiceFlags. Voir les constantes utilisées pour les drapeaux des services
         Win32Service.

<comment>See Also:</comment>
   * Les constantes Win32Service prédéfinies


id: win32_send_custom_control
type: function
doc:
<comment>Description:</comment>
  Envoyer un contrôle personnalisé au service
  
  Voir Microsoft ControlService function pour plus de détails.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  Le nom abrégé du service.
  <info>int</info>     <strong>$control</strong>      La valeur de contrôle personnalisé entre 128 et 255.
  <info>string</info>  <strong>$machine</strong>      Nom de la machine en option. Si omis, l'ordinateur local est utilisé.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.
        
        Avant la version 1.0.0, retournait <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem
        with the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * Win32 Error Codes


id: win32_set_service_exit_code
type: function
doc:
<comment>Description:</comment>
  Définir ou renvoyer le code de sortie pour le service en cours d'exécution
  
  Change ou retourne le code de sortie. Le code de sortie est utilisé uniquement  si le mode de
  sortie n'est pas gracieux.  Si la valeur n'est pas zéro, la configuration de récupération peut
  être utilisée  après l'échec du service. Voir les  codes d'erreur système Microsoft pour plus de
  détails
  
  Cette fonction fonctionne uniquement dans SAPI "cli". Sur d'autres SAPI, cette  fonction est
  désactivée.

<comment>Param:</comment>
  <info>int</info>  <strong>$exitCode</strong>  Le code de retour utilisé à la sortie.

<comment>Return:</comment>
  <info>int</info>  Retourne le code de sortie actuel ou l'ancien.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_mode()</strong>


id: win32_set_service_exit_mode
type: function
doc:
<comment>Description:</comment>
  Définir ou renvoyer le mode de sortie pour le service en cours d'exécution
  
  Si le paramètre <strong>$gracefulMode</strong> est fourni, le mode de  sortie est modifié. Lorsque le mode de
  sortie n'est pas gracefuly, le code de  sortie utilisé peut être défini avec la fonction
  <strong>win32_set_service_exit_code()</strong>.
  
  Cette fonction fonctionne uniquement dans SAPI "cli". Sur d'autres SAPI, cette  fonction est
  désactivée.

<comment>Param:</comment>
  <info>bool</info>  <strong>$gracefulMode</strong>  <info>true</info> pour la sortie gracieuse. <info>false</info> pour la sortie avec erreur.

<comment>Return:</comment>
  <info>bool</info>  Retournez le mode de sortie actuel ou ancien.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_set_service_exit_code()</strong>


id: win32_set_service_status
type: function
doc:
<comment>Description:</comment>
  Met à jour le statut d'un service
  
  Informe le SCM d'un statut courant d'un service qui fonctionne. Cet appel est seulement valide
  pour un processus de service qui fonctionne.
  
  Depuis la version 0.2.0, cette fonction fonctionne uniquement en ligne de  commande. Elle est
  désactivé dans les autres cas.

<comment>Param:</comment>
  <info>int</info>  <strong>$status</strong>      Le code de statut de service, un de <info>WIN32_SERVICE_RUNNING</info>,
                    <info>WIN32_SERVICE_STOPPED</info>, <info>WIN32_SERVICE_STOP_PENDING</info>, <info>WIN32_SERVICE_START_PENDING</info>,
                    <info>WIN32_SERVICE_CONTINUE_PENDING</info>, <info>WIN32_SERVICE_PAUSE_PENDING</info>,
                    <info>WIN32_SERVICE_PAUSED</info>.
  <info>int</info>  <strong>$checkpoint</strong>  Cette valeur sera incrémentée par le service périodiquement pour reporter sa
                    progression lors des opérations de démarrage, d'arrêt, de pause ou de reprise.
                    Par exemple, le service incrémentera cette valeur lorsqu'il aura terminé chaque
                    étape de son initialisation lors de son démarrage.
                    
                    <strong>$checkpoint</strong> n'est valide que lorsque <strong>$status</strong> est une des constantes suivantes :
                    <info>WIN32_SERVICE_STOP_PENDING</info>, <info>WIN32_SERVICE_START_PENDING</info>,
                    <info>WIN32_SERVICE_CONTINUE_PENDING</info> ou <info>WIN32_SERVICE_PAUSE_PENDING</info>.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.
        
        Avant la version 1.0.0, retournait <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem
        with the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_start_service_ctrl_dispatcher()</strong>
   * <strong>win32_get_last_control_message()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * Les constantes de statut des services Win32Service


id: win32_start_service
type: function
doc:
<comment>Description:</comment>
  Démarre un service
  
  Essaie de démarrer le service nommé. Requiert des privilèges d'administrateur ou  un compte avec
  les droits appropriés définis dans l'ACL du service.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  Le nom court du service.
  <info>string</info>  <strong>$machine</strong>      Le nom optionnel de la machine. Si oublié, cela utilisera la machine locale.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.
        
        Avant la version 1.0.0, retournait <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem
        with the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_stop_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Codes erreur Win32


id: win32_start_service_ctrl_dispatcher
type: function
doc:
<comment>Description:</comment>
  Enregistre un script avec SCM, alors il peut être interprété en tant que service avec le nom donné
  
  Lorsque exécuté via le Gestionnaire de Contrôle de Service, un processus de service est requis
  pour "archiver" avec lui pour établir un service de surveillance et de communication ergonomique.
  Cette fonction effectue un archivage en démarrant un thread pour gérer les communications de bas
  niveau avec le gestionnaire de contrôle de service.
  
  Une fois démarré, le processus du service doit faire 2 choses. La première est d'indiquer au
  Service Control Manager que le service est en cours d'exécution. La seconde est d'appeler la
  fonction <strong>win32_set_service_status()</strong> avec la constante <info>WIN32_SERVICE_RUNNING</info>. Si vous avez besoin
  de lancer des processus longs avant que le service ne soit lancé, alors vous pouvez utiliser la
  constante <info>WIN32_SERVICE_START_PENDING</info>. La seconde est de continuer à vérifier en utilisant le
  Service Control Manager sachant qu'il peut déterminer si le service se termine ou non. Ceci
  consiste à appeler, périodiquement, la fonction <strong>win32_get_last_control_message()</strong> et à traiter le
  code retourné.
  
  Depuis la version 0.2.0, cette fonction fonctionne uniquement en ligne de  commande. Elle est
  désactivé dans les autres cas.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>          Le court nom du service, comme enregistré par <strong>win32_create_service()</strong>.
  <info>bool</info>    <strong>$gracefulMode</strong>  <info>true</info> pour la sortie gracieuse. <info>false</info> pour la sortie avec erreur. Voir
                         <strong>win32_set_service_exit_mode()</strong> pour plus de détails.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.
        
        Avant la version 1.0.0, retournait <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem
        with the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_set_service_status()</strong>
   * <strong>win32_get_last_control_message()</strong>
   * <strong>win32_set_service_exit_mode()</strong>
   * <strong>win32_set_service_exit_code()</strong>
   * Les codes erreur Win32


id: win32_stop_service
type: function
doc:
<comment>Description:</comment>
  Arrête un service
  
  Arrête un service nommé. Requiert des privilèges d'administrateur ou  un compte avec les droits
  appropriés définis dans l'ACL du service.

<comment>Param:</comment>
  <info>string</info>  <strong>$servicename</strong>  Le nom court du service.
  <info>string</info>  <strong>$machine</strong>      Le nom optionnel de la machine. Si oublié, cela utilisera la machine locale.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.
        
        Avant la version 1.0.0, retournait <info>WIN32_NO_ERROR</info> on success, <info>false</info> if there is a problem
        with the parameters or a Win32 Error Code on failure.

<comment>See Also:</comment>
   * <strong>win32_start_service()</strong>
   * <strong>win32_pause_service()</strong>
   * <strong>win32_continue_service()</strong>
   * <strong>win32_send_custom_control()</strong>
   * Codes erreur Win32


id: wincache_fcache_fileinfo
type: function
doc:
<comment>Description:</comment>
  Extrait des informations sur les fichiers mis en cache dans le cache de fichiers
    
  
  Extrait des informations sur le contenu du cache de fichiers et son utilisation.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  Si le tableau retourné doit contenir des informations sur chaque entrée du
                      cache en plus du résumé sur les fichiers du cache.

<comment>Return:</comment>
  <info>array|false</info>  Tableau de méta-données sur le cache de fichier  ou <info>false</info> si une erreur survient
               
               Le tableau retourné par cette fonction contient les éléments suivants :
               <return>total_cache_uptime</return> - Temps d'activité total en secondes du cache de fichiers
               <return>total_file_count</return> - Nombre total de fichiers actuellement dans le cache de fichiers
               <return>total_hit_count</return> - Nombre de fois où les fichiers ont été servis à partir du cache du
               fichiers <return>total_miss_count</return> - Nombre de fois que les fichiers n'ont pas été trouvés
               dans le cache de fichiers <return>file_entries</return> - Tableau contenant les informations sur tous
               les fichiers mis en cache: <return>file_name</return> - Nom et chemin absolu du fichier en cache
               <return>add_time</return> - Temps en secondes depuis que le fichier a été ajouté au cache de fichiers
               <return>use_time</return> - Temps en secondes depuis que le fichier a été consulté dans le cache de
               fichier <return>last_check</return> - Temps en secondes depuis la dernière vérification de
               modifications <return>hit_count</return> - Nombre de fois que le fichier a été servis à partir du
               cache <return>file_size</return> - Taille en bytes du fichier caché
               
               <return>total_cache_uptime</return> - Temps d'activité total en secondes du cache de fichiers
               
               <return>total_file_count</return> - Nombre total de fichiers actuellement dans le cache de fichiers
               
               <return>total_hit_count</return> - Nombre de fois où les fichiers ont été servis à partir du cache du
               fichiers
               
               <return>total_miss_count</return> - Nombre de fois que les fichiers n'ont pas été trouvés dans le
               cache de fichiers
               
               <return>file_entries</return> - Tableau contenant les informations sur tous les fichiers mis en cache:
               <return>file_name</return> - Nom et chemin absolu du fichier en cache  <return>add_time</return> - Temps en secondes
               depuis que le fichier a été ajouté au cache de fichiers <return>use_time</return> - Temps en secondes
               depuis que le fichier a été consulté dans le cache de fichier <return>last_check</return> - Temps en
               secondes depuis la dernière vérification de modifications <return>hit_count</return> - Nombre de fois
               que le fichier a été servis à partir du cache <return>file_size</return> - Taille en bytes du fichier
               caché
               
               <return>file_name</return> - Nom et chemin absolu du fichier en cache
               
               <return>add_time</return> - Temps en secondes depuis que le fichier a été ajouté au cache de fichiers
               
               <return>use_time</return> - Temps en secondes depuis que le fichier a été consulté dans le cache de
               fichier
               
               <return>last_check</return> - Temps en secondes depuis la dernière vérification de modifications
               
               <return>hit_count</return> - Nombre de fois que le fichier a été servis à partir du cache
               
               <return>file_size</return> - Taille en bytes du fichier caché

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_fcache_meminfo
type: function
doc:
<comment>Description:</comment>
  Extrait des informations sur l'utilisation de la mémoire du cache de fichiers.
    
  
  Extrait des informations sur l'utilisation de la mémoire du cache de fichiers.

<comment>Return:</comment>
  <info>array|false</info>  Tableau de méta-données sur l'utilisation de la mémoire du cache de fichiers  ou
               <info>false</info> si une erreur survient
               
               Le tableau retourné par cette fonction contient les éléments suivants:  <return>memory_total</return>
               - Quantité de mémoire en octets allouée pour le cache de fichiers <return>memory_free</return> -
               Quantité de mémoire libre en octets disponible pour le cache de fichiers
               <return>num_used_blks</return> - Nombre de blocs mémoire utilisés par le cache de fichiers
               <return>num_free_blks</return> - Nombre de blocs mémoire libres disponibles pour le cache de fichiers
               <return>memory_overhead</return> - Quantité de mémoire en bytes utilisée pour la structure interne du
               cache de fichiers
               
               <return>memory_total</return> - Quantité de mémoire en octets allouée pour le cache de fichiers
               
               <return>memory_free</return> - Quantité de mémoire libre en octets disponible pour le cache de
               fichiers
               
               <return>num_used_blks</return> - Nombre de blocs mémoire utilisés par le cache de fichiers
               
               <return>num_free_blks</return> - Nombre de blocs mémoire libres disponibles pour le cache de fichiers
               
               <return>memory_overhead</return> - Quantité de mémoire en bytes utilisée pour la structure interne du
               cache de fichiers

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_lock
type: function
doc:
<comment>Description:</comment>
  Acquière un verrou exclusif sur une clé donnée
  
  Obtient un verrou exclusif sur une clé donnée. L'exécution du script courant sera bloqué tant que
  le verrou ne pourra pas être obtenu. Une fois le verrou obtenu, les autres scripts tentant de
  requérir le verrou en utilisant la même clé seront bloqués, tant que le script courant n'aura pas
  libéré le verrou en utilisant la fonction <strong>wincache_unlock()</strong>.
  
  L'utilisation de la fonction <strong>wincache_lock()</strong> et de la fonction <strong>wincache_unlock()</strong> peut conduire à
  des verrous morts lors de l'exécution de scripts PHP sur des environnements multiprocessus, comme
  FastCGI. N'utilisez pas ces fonctions tant que vous n'êtes pas absolument certain d'en avoir
  besoin. Pour la majorité des opérations sur le cache utilisateur, il n'est pas nécessaire de les
  utiliser.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>       Nom de la clé du cache dont nous souhaitons obtenir un verrou.
  <info>bool</info>    <strong>$isglobal</strong>  Contrôle si le contexte du verrou est local ou au niveau système. Les verrous
                     locaux ont un contexte au niveau applicatif dans le cas de l'utilisation sous
                     IIS Fast CGI ou au niveau de tous les processus PHP qui ont le même identifiant
                     parent de processus.

<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>wincache_unlock()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wincache_ocache_fileinfo
type: function
doc:
<comment>Description:</comment>
  Extrait des informations sur les fichiers mis en cache dans le cache opcode
    
  
  Extrait des informations sur le contenu du cache opcode et son utilisation.
  
  Cette fonction a été SUPPRIMÉE à partir de PHP 7.0.0.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  Contrôle si le tableau retourné doit contenir des informations sur les entrées
                      individuelles du cache en plus du résumé sur le cache opcode.

<comment>Return:</comment>
  <info>array|false</info>  Tableau de méta-données sur le cache opcode   ou <info>false</info> si une erreur survient
               
               Le tableau retourné par cette fonction contient les éléments suivants:
               <return>total_cache_uptime</return> -  Temps d'activité total en secondes du cache opcode
               <return>total_file_count</return> - Nombre total de fichiers actuellement dans le cache opcode
               <return>total_hit_count</return> - Nombre total de fois où l'opcode compilé a été servis par le cache
               <return>total_miss_count</return> - Nombre de fois où l'opcode compilé n'a pas été trouvé dans le
               cache <return>is_local_cache</return> - true si les méta-données du cache sont pour une instance de
               cache local,  false si les méta-données sont pour le cache global. <return>file_entries</return> -
               Tableau contenant les informations sur tous les fichiers mis en cache: <return>file_name</return> -
               Nom de fichier absolu du fichier en cache <return>add_time</return> - Temps en secondes depuis l'ajout
               du fichier dans le cache opcode <return>use_time</return> - Temps en secondes depuis la consultation
               du fichier dans le cache opcode <return>last_check</return> - Temps en secondes depuis où le fichier a
               été vérifié pour les modifications <return>hit_count</return> - Nombre de fois où le fichier a été
               servis par le cache <return>function_count</return> - Nombre de fonctions dans le cache <return>class_count</return> -
               Nombre de classes dans le cache
               
               <return>total_cache_uptime</return> -  Temps d'activité total en secondes du cache opcode
               
               <return>total_file_count</return> - Nombre total de fichiers actuellement dans le cache opcode
               
               <return>total_hit_count</return> - Nombre total de fois où l'opcode compilé a été servis par le cache
               
               <return>total_miss_count</return> - Nombre de fois où l'opcode compilé n'a pas été trouvé dans le
               cache
               
               <return>is_local_cache</return> - true si les méta-données du cache sont pour une instance de cache
               local,  false si les méta-données sont pour le cache global.
               
               <return>file_entries</return> - Tableau contenant les informations sur tous les fichiers mis en cache:
               <return>file_name</return> - Nom de fichier absolu du fichier en cache <return>add_time</return> - Temps en secondes
               depuis l'ajout du fichier dans le cache opcode <return>use_time</return> - Temps en secondes depuis la
               consultation du fichier dans le cache opcode <return>last_check</return> - Temps en secondes depuis où
               le fichier a été vérifié pour les modifications <return>hit_count</return> - Nombre de fois où le
               fichier a été servis par le cache <return>function_count</return> - Nombre de fonctions dans le cache
               <return>class_count</return> - Nombre de classes dans le cache
               
               <return>file_name</return> - Nom de fichier absolu du fichier en cache
               
               <return>add_time</return> - Temps en secondes depuis l'ajout du fichier dans le cache opcode
               
               <return>use_time</return> - Temps en secondes depuis la consultation du fichier dans le cache opcode
               
               <return>last_check</return> - Temps en secondes depuis où le fichier a été vérifié pour les
               modifications
               
               <return>hit_count</return> - Nombre de fois où le fichier a été servis par le cache
               
               <return>function_count</return> - Nombre de fonctions dans le cache
               
               <return>class_count</return> - Nombre de classes dans le cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ocache_meminfo
type: function
doc:
<comment>Description:</comment>
  Extrait des informations sur l'utilisation du cache opcode 
    
  
  Extrait des informations sur l'utilisation de la mémoire par le cache opcode.

<comment>Return:</comment>
  <info>array|false</info>  Tableau de méta-données sur l'utilisation de la mémoire cache opcode  ou <info>false</info> si une
               erreur survient
               
               Le tableau retourné par cette fonction contient les éléments suivants :  <return>memory_total</return>
               - Quantité de mémoire en octets, allouée pour le cache opcode <return>memory_free</return> - Quantité
               de mémoire libre en octets, disponible pour le cache opcode <return>num_used_blks</return> - Nombre de
               blocs mémoire utilisés par le cache opcode <return>num_free_blks</return> - Nombre de blocs mémoire
               libres disponibles pour le cache opcode <return>memory_overhead</return> - Quantité de mémoire en
               octets utilisée pour la structure interne du cache opcode
               
               <return>memory_total</return> - Quantité de mémoire en octets, allouée pour le cache opcode
               
               <return>memory_free</return> - Quantité de mémoire libre en octets, disponible pour le cache opcode
               
               <return>num_used_blks</return> - Nombre de blocs mémoire utilisés par le cache opcode
               
               <return>num_free_blks</return> - Nombre de blocs mémoire libres disponibles pour le cache opcode
               
               <return>memory_overhead</return> - Quantité de mémoire en octets utilisée pour la structure interne du
               cache opcode
               
               Cette fonction a été SUPPRIMÉE à partir de PHP 7.0.0.

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_refresh_if_changed
type: function
doc:
<comment>Description:</comment>
  Actualise les entrées du cache pour les fichiers mis en cache
    
  
  Actualise les entrées du cache pour les fichiers dont les noms ont été passés dans les arguments
  d'entrée. Si aucun argument n'est précisé, alors, actualise toutes les entrées du cache.

<comment>Param:</comment>
  <info>array</info>  <strong>$files</strong>  Tableau de noms de fichiers pour les fichiers qui ont besoin d'être actualisés. Un
                 chemin de fichier absolu ou relatif peut être utilisé.

<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>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_rplist_fileinfo
type: function
doc:
<comment>Description:</comment>
  Récupère des informations du cache sur un chemin de fichier résolu
  
  Récupère des informations sur une cartographie en cache entre des chemins relatifs de fichiers et
  leurs correspondances en chemins absolus.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  

<comment>Return:</comment>
  <info>array|false</info>  Un tableau de données méta contenant le contenu du cache d'un chemin de fichier
               résolu  ou <info>false</info> si une erreur survient
               
               Le tableau retourné par cette fonction contient les éléments suivants :
               <return>total_file_count</return> - nombre total de chemins de fichiers stockés dans le cache
               <return>rplist_entries</return> - un tableau contenant les informations sur les chemins de fichier
               présents en cache : <return>resolve_path</return> - chemin vers le fichier <return>subkey_data</return> - chemin absolu
               correspondant
               
               <return>total_file_count</return> - nombre total de chemins de fichiers stockés dans le cache
               
               <return>rplist_entries</return> - un tableau contenant les informations sur les chemins de fichier
               présents en cache : <return>resolve_path</return> - chemin vers le fichier <return>subkey_data</return> - chemin absolu
               correspondant
               
               <return>resolve_path</return> - chemin vers le fichier
               
               <return>subkey_data</return> - chemin absolu correspondant

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_rplist_meminfo
type: function
doc:
<comment>Description:</comment>
  Récupère des informations sur l'utilisation de la mémoire par le cache de chemin de fichier résolu
  
  Récupère des informations sur l'utilisation de la mémoire par le cache de chemin de fichier
  résolu.

<comment>Return:</comment>
  <info>array|false</info>  Un tableau de données méta qui décrit l'utilisation de la mémoire par le cache de
               chemin de fichier résolu.  ou <info>false</info> si une erreur survient
               
               Le tableau retourné par cette fonction contient les éléments suivants : <return>memory_total</return>
               - nombre total de mémoire, en octets, alouée au cache de chemins de fichiers résolus
               <return>memory_free</return> - mémoire libre, en octets, disponible pour le cache de chemins de
               fichiers résolus <return>num_used_blks</return> - blocs mémoires utilisés par le cache de chemins de
               fichiers résolus <return>num_free_blks</return> - nombre de blocs mémoires de libre pour le cache des
               chemins de fichiers résolus <return>memory_overhead</return> - mémoire, en octets, utilisée pour la
               structure interne du cache des chemins de fichiers résolus
               
               <return>memory_total</return> - nombre total de mémoire, en octets, alouée au cache de chemins de
               fichiers résolus
               
               <return>memory_free</return> - mémoire libre, en octets, disponible pour le cache de chemins de
               fichiers résolus
               
               <return>num_used_blks</return> - blocs mémoires utilisés par le cache de chemins de fichiers résolus
               
               <return>num_free_blks</return> - nombre de blocs mémoires de libre pour le cache des chemins de
               fichiers résolus
               
               <return>memory_overhead</return> - mémoire, en octets, utilisée pour la structure interne du cache des
               chemins de fichiers résolus

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_scache_info
type: function
doc:
<comment>Description:</comment>
  Récupère des informations sur des fichiers mis en cache
  
  Récupère des informations sur le contenu du cache et son utilisation.

<comment>Param:</comment>
  <info>bool</info>  <strong>$summaryonly</strong>  Contrôle si le tableau retourné doit contenir des informations sur des entrées
                      individuelles du cache en plus du résumé du cache.

<comment>Return:</comment>
  <info>array|false</info>  Un tableau de données méta sur le cache pour cette session ou <info>false</info> si une erreur
               survient
               
               Le tableau retourné par cette fonction contient les éléments suivants :
               <return>total_cache_uptime</return> - durée total (en secondes) d'activation du cache <return>total_item_count</return>
               - nombre total d'éléments contenus actuellement dans le cache <return>is_local_cache</return> - <info>true</info>
               si les méta-données du cache sont pour une instance de cache locale, <info>false</info> si elles
               sont pour un cache global <return>total_hit_count</return> - nombre total de fois que les données ont
               été servis depuis le cache <return>total_miss_count</return> - nombre total de fois que les données
               ont été trouvées dans le cache <return>scache_entries</return> - un tableau contenant les informations
               sur les éléments mis en cache : <return>key_name</return> - nom de la clé utilisé pour stocker les
               données <return>value_type</return> - type de la valeur stockée <return>use_time</return> - durée, en secondes, depuis
               le dernier accès du fichier depuis le cache opcode <return>last_check</return> - durée, en secondes,
               depuis la dernière fois où le fichier a été vérifié afin de détection des
               modifications <return>ttl_seconds</return> - durée restante avant suppression des données du cache, 0
               signifiant qu'elles ne seront jamais supprimées <return>age_seconds</return> - l'âge des données dans
               le cache (i.e. depuis leurs insertions) <return>hitcount</return> - nombre de fois que les données ont
               été servies depuis le cache
               
               <return>total_cache_uptime</return> - durée total (en secondes) d'activation du cache
               
               <return>total_item_count</return> - nombre total d'éléments contenus actuellement dans le cache
               
               <return>is_local_cache</return> - <info>true</info> si les méta-données du cache sont pour une instance de cache
               locale, <info>false</info> si elles sont pour un cache global
               
               <return>total_hit_count</return> - nombre total de fois que les données ont été servis depuis le cache
               
               <return>total_miss_count</return> - nombre total de fois que les données ont été trouvées dans le
               cache
               
               <return>scache_entries</return> - un tableau contenant les informations sur les éléments mis en cache
               : <return>key_name</return> - nom de la clé utilisé pour stocker les données <return>value_type</return> - type de la
               valeur stockée <return>use_time</return> - durée, en secondes, depuis le dernier accès du fichier
               depuis le cache opcode <return>last_check</return> - durée, en secondes, depuis la dernière fois où le
               fichier a été vérifié afin de détection des modifications <return>ttl_seconds</return> - durée
               restante avant suppression des données du cache, 0 signifiant qu'elles ne seront
               jamais supprimées <return>age_seconds</return> - l'âge des données dans le cache (i.e. depuis leurs
               insertions) <return>hitcount</return> - nombre de fois que les données ont été servies depuis le cache
               
               <return>key_name</return> - nom de la clé utilisé pour stocker les données
               
               <return>value_type</return> - type de la valeur stockée
               
               <return>use_time</return> - durée, en secondes, depuis le dernier accès du fichier depuis le cache
               opcode
               
               <return>last_check</return> - durée, en secondes, depuis la dernière fois où le fichier a été vérifié
               afin de détection des modifications
               
               <return>ttl_seconds</return> - durée restante avant suppression des données du cache, 0 signifiant
               qu'elles ne seront jamais supprimées
               
               <return>age_seconds</return> - l'âge des données dans le cache (i.e. depuis leurs insertions)
               
               <return>hitcount</return> - nombre de fois que les données ont été servies depuis le cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_scache_meminfo
type: function
doc:
<comment>Description:</comment>
  Récupère des informations sur l'utilisation de la mémoire du cache
  
  Récupère des informations sur l'utilisation mémoire du cache.

<comment>Return:</comment>
  <info>array|false</info>  Un tableau de données méta sur l'utilisation de la mémoire du cache ou <info>false</info> si une
               erreur survient
               
               Le tableau retourné par cette fonction contient les éléments suivants : <return>memory_total</return>
               - mémoire, en octets, allouée au cache <return>memory_free</return> - mémoire disponible, en octets,
               pour le cache <return>num_used_blks</return> - nombre de blocs mémoires utilisés par le cache
               <return>num_free_blks</return> - nombre de blocs mémoires disponibles pour le cache <return>memory_overhead</return> -
               mémoire, en octets, utilisé par les structures internes du cache
               
               <return>memory_total</return> - mémoire, en octets, allouée au cache
               
               <return>memory_free</return> - mémoire disponible, en octets, pour le cache
               
               <return>num_used_blks</return> - nombre de blocs mémoires utilisés par le cache
               
               <return>num_free_blks</return> - nombre de blocs mémoires disponibles pour le cache
               
               <return>memory_overhead</return> - mémoire, en octets, utilisé par les structures internes du cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wincache_ucache_add
type: function
doc:
<comment>Description:</comment>
  Ajoute une nouvelle variable au cache utilisateur
    
  
  Ajoute une variable au cache utilisateur, uniquement si elle n'existe pas déjà dans le cache. La
  variable restera dans le cache tant que le délai d'expiration n'est pas atteint ou qu'elle n'est
  effacée par la fonction <strong>wincache_ucache_delete()</strong> ou la fonction <strong>wincache_ucache_clear()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     Stocke la variable en utilisant le nom <strong>$key</strong>. Si une variable correspondant à la
                   même clé est déjà présente dans le cache, la fonction échouera et retournera
                   <info>false</info>. Le paramètre <strong>$key</strong> est sensible à la casse. Pour écraser cette valeur, si
                   <strong>$key</strong> est présent, utilisez plutôt la fonction <strong>wincache_ucache_set()</strong>. <strong>$key</strong> peut
                   également être un tableau de paires nom =&gt; valeur où les noms seront utilisés
                   comme clés. Ce format peut être utilisé pour ajouter de multiples valeurs dans le
                   cache en une seule opération.
  <info>mixed</info>   <strong>$value</strong>   La valeur de la variable à stocker. Le paramètre <strong>$Value</strong> supporte tous les types
                   de données, sauf les ressources, comme des pointeurs de fichiers. Ce paramètre
                   sera ignoré si le premier argument est un tableau. De façon général, il convient
                   de passer la valeur <info>null</info> au paramètre <strong>$value</strong> lors de l'utilisation d'un tableau
                   pour le paramètre <strong>$key</strong>. Si le paramètre <strong>$value</strong> est un objet, ou un tableau
                   contenant des objets, alors les objets seront sérialisés. Reportez-vous à la
                   fonction __sleep() pour plus de détails sur la sérialisation d'objets.
  <info>array</info>   <strong>$values</strong>  Tableau associatif de clés et de valeurs.
  <info>int</info>     <strong>$ttl</strong>     Durée de vie de la variable dans le cache, en secondes. Après la durée spécifiée
                   par le paramètre <strong>$ttl</strong>, la variable stockée sera supprimée du cache. Ce paramètre
                   prend, comme valeur par défaut, zéro (<return>0</return>), ce qui signifie que la variable restera
                   dans le cache tant qu'elle n'est pas explicitement effacée en utilisant la
                   fonction <strong>wincache_ucache_delete()</strong> ou la fonction <strong>wincache_ucache_clear()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Si le paramètre <strong>$key</strong> est une chaîne de caractères, la fonction retourne <info>true</info> en cas de
        succès, <info>false</info> si une erreur survient.
        
        Si le paramètre <strong>$key</strong> est un tableau, la fonction retourne :  Si toutes les paires nom =&gt;
        valeur du tableau peuvent être définies, la fonction retournera un tableau vide ;  Si toutes
        les paires nom =&gt; valeur du tableau ne peuvent être définies, la fonction retournera
        <info>false</info> ;  Si certaines peuvent être définies, et d'autres non, la fonction retournera un
        tableau de paires nom =&gt; valeur n'ayant pû être définies dans le cache utilisateur.
        
        Si toutes les paires nom =&gt; valeur du tableau peuvent être définies, la fonction
        retournera un tableau vide ;
        
        Si toutes les paires nom =&gt; valeur du tableau ne peuvent être définies, la fonction
        retournera <info>false</info> ;
        
        Si certaines peuvent être définies, et d'autres non, la fonction retournera un tableau de
        paires nom =&gt; valeur n'ayant pû être définies dans le cache utilisateur.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __sleep()


id: wincache_ucache_cas
type: function
doc:
<comment>Description:</comment>
  Compare la variable avec son ancienne valeur et lui assigne une nouvelle valeur
  
  Compare la variable associée avec la clé <strong>$key</strong> avec la valeur <strong>$old_value</strong> et si elle correspond, lui
  assigne la nouvelle valeur <strong>$new_value</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>        La clé <strong>$key</strong> utilisé pour stocker la variable dans le cache. <strong>$key</strong> est sensible
                      à la casse.
  <info>int</info>     <strong>$old_value</strong>  L'ancienne valeur de la variable pointée par le paramètre <strong>$key</strong> dans le cache
                      utilisateur. La valeur doit être de type <return>long</return>, sinon, la fonction retournera
                      <info>false</info>.
  <info>int</info>     <strong>$new_value</strong>  La nouvelle valeur qui sera assignée à la variable pointée par la clé <strong>$key</strong> si
                      la correspondance a été trouvée. La valeur doit être de type <return>long</return>, sinon, la
                      fonction retournera <info>false</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>wincache_ucache_inc()</strong>
   * <strong>wincache_ucache_dec()</strong>


id: wincache_ucache_clear
type: function
doc:
<comment>Description:</comment>
  Supprime le contenu d'une entrée du cache utilisateur
  
  Supprime toutes les valeurs stockées dans le cache utilisateur.

<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>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_dec
type: function
doc:
<comment>Description:</comment>
  Décrémente la valeur associée à une clé
  
  Décrémente de 1 ou <strong>$dec_by</strong> de la valeur associée avec la clé <strong>$key</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      La clé <strong>$key</strong> utilisée pour stoker la variable dans le cache. Le paramètre <strong>$key</strong>
                    est sensible à la casse.
  <info>int</info>     <strong>$dec_by</strong>   La valeur utilisée pour décrémenter la variable associée à la clé <strong>$key</strong>. Si
                    l'argument est un nombre à virgule flottante, il sera arrondi à l'entier le plus
                    proche. La variable associée avec la clé <strong>$key</strong> doit être de type <return>long</return>, sinon, la
                    fonction retournera <info>false</info>.
  <info>bool</info>    <strong>$success</strong>  Sera définie à <info>true</info> en cas de succès, <info>false</info> si une erreur survient.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur décrémentée en cas de succès, <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>wincache_ucache_inc()</strong>
   * <strong>wincache_ucache_cas()</strong>


id: wincache_ucache_delete
type: function
doc:
<comment>Description:</comment>
  Supprime les variables du cache utilisateur
  
  Supprime les éléments pointés par la clé <strong>$key</strong> du cache utilisateur.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  La clé <strong>$key</strong> utilisée pour stoker la variable dans le cache. Le paramètre <strong>$key</strong> est
               sensible à la casse. <strong>$key</strong> peut être un tableau de clé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.
        
        Si le paramètre <strong>$key</strong> est un tableau, alors la fonction retournera <info>false</info> si un des éléments
        du tableau n'a pu être supprimé du cache utilisateur, sinon, elle retournera un tableau
        contenant toutes les clés ayant été supprimées avec succès.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_exists
type: function
doc:
<comment>Description:</comment>
  Vérifie si une variable existe dans le cache utilisateur
  
  Vérifie si une variable dont la clé est <strong>$key</strong> existe ou non dans le cache utilisateur.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  La clé <strong>$key</strong> utilisée pour stoker la variable dans le cache. Le paramètre <strong>$key</strong> est
                sensible à la casse.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la variable dont la clé est <strong>$key</strong> existe, <info>false</info> sinon.

<comment>See Also:</comment>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>


id: wincache_ucache_get
type: function
doc:
<comment>Description:</comment>
  Récupère une variable stokée dans le cache utilisateur
  
  Récupère une variable stokée dans le cache utilisateur.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>      La clé <strong>$key</strong> utilisée pour stoker la variable dans le cache. Le paramètre <strong>$key</strong> est
                   sensible à la casse. <strong>$key</strong> peut être un tableau de clés. Dans ce cas, la valeur
                   retournée sera un tableau de valeurs de chaque éléments du tableau <strong>$key</strong>. Si un
                   objet ou un tableau contenant des objets est retourné, alors les objets seront
                   désérialisés. Reportez-vous à la fonction __wakeup() pour plus de détails sur les
                   désérialisation des objets.
  <info>bool</info>   <strong>$success</strong>  Sera définie à <info>true</info> en cas de succès, <info>false</info> si une erreur survient.

<comment>Return:</comment>
  <info>mixed</info>  Si le paramètre <strong>$key</strong> est une chaîne de caractères, la fonction retournera la valeur de la
         variable stokée avec cette clé. Le paramètre <strong>$success</strong> sera défini à <info>true</info> en cas de succès,
         et à <info>false</info> si une erreur survient.
         
         Si le paramètre <strong>$key</strong> est un tableau, le paramètre <strong>$success</strong> sera toujours défini à <info>true</info>. Le
         tableau retourné (paires de nom =&gt; valeur) contiendra uniquement les paires nom =&gt;
         valeur pour lesquelles la récupération depuis le cache utilisateur a été un succès. Si
         aucune des clés du tableau ne correspond à des entrées du cache utilisateur, un tableau
         vide sera retourné.

<comment>See Also:</comment>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __wakeup()


id: wincache_ucache_inc
type: function
doc:
<comment>Description:</comment>
  Incrémente la valeur associée à une clé
  
  Incrémente, de 1 ou de la valeur du paramètre <strong>$inc_by</strong>, la valeur associée avec la clé <strong>$key</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      La clé <strong>$key</strong> utilisée pour stoker la variable dans le cache. Le paramètre <strong>$key</strong>
                    est sensible à la casse.
  <info>int</info>     <strong>$inc_by</strong>   La valeur utilisée pour incrémenter la variable associée à la clé <strong>$key</strong>. Si
                    l'argument est un nombre à virgule flottante, elle sera arrondie à l'entier le
                    plus proche. La variable associée à la clé <strong>$key</strong> doit être de type <return>long</return>, sinon la
                    fonction échouera et retournera <info>false</info>.
  <info>bool</info>    <strong>$success</strong>  Sera défini à <info>true</info> en cas de succès, <info>false</info> si une erreur survient.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur incrémentée en cas de succès, <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>wincache_ucache_dec()</strong>
   * <strong>wincache_ucache_cas()</strong>


id: wincache_ucache_info
type: function
doc:
<comment>Description:</comment>
  Récupère des informations sur des données stokées dans le cache utilisateur
  
  Récupère des informations sur des données stokées dans le cache utilisateur.

<comment>Param:</comment>
  <info>bool</info>    <strong>$summaryonly</strong>  Contrôle si le tableau résultant doit contenir les informations sur des
                        entrées individuelles en plus du résumé du cache utilisateur.
  <info>string</info>  <strong>$key</strong>          La clé de l'entrée du cache utilisateur. Si spécifiée, alors le tableau
                        résultant contiendra des informations uniquement sur cette entrée du cache.
                        Si non spécifiée, et le paramètre <strong>$summaryonly</strong> est défini à <info>false</info>, alors le
                        tableau résultant contiendra des informations sur toutes les entrées du
                        cache.

<comment>Return:</comment>
  <info>array|false</info>  Un tableau de données méta sur le cache utilisateur ou <info>false</info> si une erreur survient
               
               Le tableau retourné par cette fonction contient les éléments suivants :
               <return>total_cache_uptime</return> - durée, en secondes, depuis l'activation de ce cache utilisateur
               <return>total_item_count</return> - nombre total d'éléments contenus dans le cache utilisateur
               <return>is_local_cache</return> - <info>true</info> si les données méta du cache sont pour une instance locale du
               cache, <info>false</info> si elles sont pour le cache global <return>total_hit_count</return> - durée depuis
               laquelle les données ont été servies depuis le cache <return>total_miss_count</return> - durée depuis
               laquelle les données n'ont pu être trouvée dans le cache <return>ucache_entries</return> - un tableau
               contenant les informations sur les éléments mis en cache : <return>key_name</return> - nom de la clé
               utilisée pour stoker les données <return>value_type</return> - type de valeur stokée pour cette clé
               <return>use_time</return> - durée, en secondes, depuis laquelle le fichier a été accédé dans le cache
               opcode <return>last_check</return> - durée, en secondes, depuis laquelle le fichier a été vérifié pour
               y détecter les modifications <return>is_session</return> - indique si la donnée est une variable de
               session <return>ttl_seconds</return> - durée de vie de la donnée dans le cache ; 0 signifie
               indéfiniment <return>age_seconds</return> - durée depuis laquelle la donné a été ajoutée dans le cache
               <return>hitcount</return> - nombre de fois que la donnée a été servie depuis le cache
               
               <return>total_cache_uptime</return> - durée, en secondes, depuis l'activation de ce cache utilisateur
               
               <return>total_item_count</return> - nombre total d'éléments contenus dans le cache utilisateur
               
               <return>is_local_cache</return> - <info>true</info> si les données méta du cache sont pour une instance locale du
               cache, <info>false</info> si elles sont pour le cache global
               
               <return>total_hit_count</return> - durée depuis laquelle les données ont été servies depuis le cache
               
               <return>total_miss_count</return> - durée depuis laquelle les données n'ont pu être trouvée dans le
               cache
               
               <return>ucache_entries</return> - un tableau contenant les informations sur les éléments mis en cache
               : <return>key_name</return> - nom de la clé utilisée pour stoker les données <return>value_type</return> - type de
               valeur stokée pour cette clé <return>use_time</return> - durée, en secondes, depuis laquelle le
               fichier a été accédé dans le cache opcode <return>last_check</return> - durée, en secondes, depuis
               laquelle le fichier a été vérifié pour y détecter les modifications <return>is_session</return> -
               indique si la donnée est une variable de session <return>ttl_seconds</return> - durée de vie de la
               donnée dans le cache ; 0 signifie indéfiniment <return>age_seconds</return> - durée depuis laquelle la
               donné a été ajoutée dans le cache <return>hitcount</return> - nombre de fois que la donnée a été
               servie depuis le cache
               
               <return>key_name</return> - nom de la clé utilisée pour stoker les données
               
               <return>value_type</return> - type de valeur stokée pour cette clé
               
               <return>use_time</return> - durée, en secondes, depuis laquelle le fichier a été accédé dans le cache
               opcode
               
               <return>last_check</return> - durée, en secondes, depuis laquelle le fichier a été vérifié pour y
               détecter les modifications
               
               <return>is_session</return> - indique si la donnée est une variable de session
               
               <return>ttl_seconds</return> - durée de vie de la donnée dans le cache ; 0 signifie indéfiniment
               
               <return>age_seconds</return> - durée depuis laquelle la donné a été ajoutée dans le cache
               
               <return>hitcount</return> - nombre de fois que la donnée a été servie depuis le cache

<comment>See Also:</comment>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_ocache_meminfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ucache_meminfo
type: function
doc:
<comment>Description:</comment>
  Récupère des informations sur l'utilisation mémoire du cache utilisateur
  
  Récupère des informations sur l'utilisation mémoire du cache utilisateur.

<comment>Return:</comment>
  <info>array|false</info>  Tableau de données méta sur l'utilisation mémoire du cache utilisateur ou <info>false</info> si
               une erreur survient
               
               Le tableau retourné par cette fonction contient les éléments suivants : <return>memory_total</return>
               - quantité de mémoire, en octets, allouée au cache utilisateur <return>memory_free</return> - quantité
               de mémoire libre, en octets, disponible pour le cache utilisateur <return>num_used_blks</return> -
               nombre de blocs mémoire utilisés par le cache utilisateur <return>num_free_blks</return> - nombre de
               blocs mémoire libres disponible depuis le cache utilisateur <return>memory_overhead</return> -
               quantité de mémoire, en octets, utilisé pour la structure interne du cache
               utilisateur
               
               <return>memory_total</return> - quantité de mémoire, en octets, allouée au cache utilisateur
               
               <return>memory_free</return> - quantité de mémoire libre, en octets, disponible pour le cache
               utilisateur
               
               <return>num_used_blks</return> - nombre de blocs mémoire utilisés par le cache utilisateur
               
               <return>num_free_blks</return> - nombre de blocs mémoire libres disponible depuis le cache utilisateur
               
               <return>memory_overhead</return> - quantité de mémoire, en octets, utilisé pour la structure interne
               du cache utilisateur

<comment>See Also:</comment>
   * <strong>wincache_fcache_fileinfo()</strong>
   * <strong>wincache_fcache_meminfo()</strong>
   * <strong>wincache_ocache_fileinfo()</strong>
   * <strong>wincache_rplist_fileinfo()</strong>
   * <strong>wincache_rplist_meminfo()</strong>
   * <strong>wincache_refresh_if_changed()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>
   * <strong>wincache_scache_meminfo()</strong>


id: wincache_ucache_set
type: function
doc:
<comment>Description:</comment>
  Ajoute une variable au cache utilisateur et écrase la variable si elle existe déjà dans le cache
  
  Ajoute une variable au cache utilisateur. Écrase une variable si elle existe déjà dans le cache.
  La variable ainsi créée ou mise à jour restera dans le cache utilisateur tant que le délai
  d'expiration n'est pas atteint ou tant qu'elle n'est pas supprimée avec la fonction
  <strong>wincache_ucache_delete()</strong> ou la fonction <strong>wincache_ucache_clear()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>     Stocke la variable en utilisant la clé <strong>$key</strong>. Si une variable utilisant la même clé
                  <strong>$key</strong> est déjà présente, la fonction écrasera la précédente valeur avec la
                  nouvelle. Le paramètre <strong>$key</strong> est sensible à la casse. <strong>$key</strong> peut également être un
                  tableau de paires nom =&gt; valeur où les noms seront utilisés comme clés. Ceci
                  peut être utile pour ajouter plusieurs valeurs dans le cache en une seule
                  opération.
  <info>mixed</info>  <strong>$value</strong>   Valeur de la variable à stocker. Le paramètre <strong>$Value</strong> supporte tous les types de
                  données, sauf les ressources, comme les pointeurs de fichiers. Ce paramètre est
                  ignoré si le premier argument est un tableau. Il est de convention de passer la
                  valeur <info>null</info> comme valeur du paramètre <strong>$value</strong> lors de l'utilisation d'un tableau
                  dans le paramètre <strong>$key</strong>. Si le paramètre <strong>$value</strong> est un objet, ou un tableau
                  contenant des objets, alors tous les objets seront sérialisés. Reportez-vous à la
                  fonction __sleep() pour plus de détails sur la sérialisation d'objets.
  <info>array</info>  <strong>$values</strong>  Tableau associatif de clés et de valeurs.
  <info>int</info>    <strong>$ttl</strong>     Durée de vie de la variable dans le cache, en secondes. Après la durée spécifiée
                  par le paramètre <strong>$ttl</strong>, la variable stockée sera effacée du cache utilisateur. Ce
                  paramètre prend par défaut la valeur zéro (<return>0</return>), ce qui signifie que la variable
                  restera dans le cache tant qu'elle ne sera pas explicitement supprimée en appelant
                  la fonction <strong>wincache_ucache_delete()</strong> ou la fonction <strong>wincache_ucache_clear()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Si <strong>$key</strong> est une chaîne de caractères, la fonction retournera <info>true</info> en cas de succès, <info>false</info> si
        une erreur survient.
        
        Si <strong>$key</strong> est un tableau, la fonction retournera :  Si toutes les paires nom =&gt; valeur du
        tableau ont pu être définies, la fonction retournera un tableau vide.  Si toutes les paires
        nom =&gt; valeur du tableau n'ont pu être définies, la fonction retournera <info>false</info>.  Si
        quelques paires ont été définies, et d'autres non, la fonction retournera un tableau de
        paires nom =&gt; valeur qui n'ont pas pu être définies dans le cache utilisateur.
        
        Si toutes les paires nom =&gt; valeur du tableau ont pu être définies, la fonction
        retournera un tableau vide.
        
        Si toutes les paires nom =&gt; valeur du tableau n'ont pu être définies, la fonction
        retournera <info>false</info>.
        
        Si quelques paires ont été définies, et d'autres non, la fonction retournera un tableau de
        paires nom =&gt; valeur qui n'ont pas pu être définies dans le cache utilisateur.

<comment>See Also:</comment>
   * <strong>wincache_ucache_add()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * __sleep()


id: wincache_unlock
type: function
doc:
<comment>Description:</comment>
  Libère un verrou exclusif sur une clé donnée
  
  Libère un verrou exclusif qui a été obtenu sur une clé donnée en utilisant la fonction
  <strong>wincache_lock()</strong>. Si un autre processus est en attente de ce verrou, pour cette clé, il obtiendra
  le verrou.
  
  L'utilisation des fonctions <strong>wincache_lock()</strong> et <strong>wincache_unlock()</strong> peut provoquer des verrous morts
  lors de l'exécution de scripts PHP dans un environnement multiprocessus comme FastCGI. N'utilisez
  pas ces fonctions tant que vous n'êtes pas sûr d'en avoir besoin. Pour la majorité des opérations
  sur le cache utilisateur, il n'est pas nécessaire de les utiliser.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  Nom de la clé du cache pour laquelle le verrou doit être libéré.

<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>wincache_lock()</strong>
   * <strong>wincache_ucache_set()</strong>
   * <strong>wincache_ucache_get()</strong>
   * <strong>wincache_ucache_delete()</strong>
   * <strong>wincache_ucache_clear()</strong>
   * <strong>wincache_ucache_exists()</strong>
   * <strong>wincache_ucache_meminfo()</strong>
   * <strong>wincache_ucache_info()</strong>
   * <strong>wincache_scache_info()</strong>


id: wkhtmltox\Image\Converter::__construct
type: function
doc:
<comment>Description:</comment>
  Cré un nouveau convertisseur d'image
  
  Crée un convertisseur d'image, en utilisant optionnellement un buffer d'entrée ainsi qu'une
  configuration

<comment>Param:</comment>
  <info>string</info>  <strong>$buffer</strong>    HTML
  <info>array</info>   <strong>$settings</strong>  NomDescriptionValeurHistoriqueinURL ou chemin du fichier d'entrée, si la sortie
                     "-" est utilisée/chemin/vers/markup.html&gt;= 0.1.0outChemin du fichier de
                     sortie, si la sortie "-" est utilisée ; par défaut, un buffer inter est
                     utilisé/chemin/vers/sortie.png&gt;= 0.1.0fmtformat de sortie à
                     utiliser""defaultjpgsortie sous la forme d'un JPEGpngsortie sous la forme d'un
                     PNGbmpsortie sous la forme d'un bitmapsvgsortie sous la forme d'un SVG&gt;=
                     0.1.0transparentlors d'une sortie en PNG ou SVG, rend l'arrière plan
                     transparentbooléen&gt;= 0.1.0screenWidthla largeur d'écran à utiliser pour le
                     rendu en pixels800&gt;= 0.1.0smartWidthlorsque vaut <info>true</info>, la largeur de l'écran
                     est étendu à la largeur du contenubooléen&gt;= 0.1.0qualityFacteur de
                     compression à utiliser lorsque la sortie est une image JPEG94&gt;=
                     0.1.0crop.leftGauche/coordonnée en X de la fenêtre à capturer, en
                     pixels200&gt;= 0.1.0crop.topHaut/coordonnée en Y de la fenêtre à capturer, en
                     pixels200&gt;= 0.1.0crop.widthLargeur de la fenêtre à capturer, en
                     pixels200&gt;= 0.1.0crop.heightHauteur de la fenêtre à capturer, en
                     pixels200&gt;= 0.1.0load.cookieJarChemin du fichier utilisé pour charger et
                     stocker les cookies./tmp/cookies.txt&gt;= 0.1.0load.usernameuser name to use
                     when loging into a websitebart&gt;= 0.1.0load.passwordthe password to used when
                     logging into a websiteelbarto&gt;= 0.1.0load.jsdelaythe amount of time in
                     milliseconds to wait after a page is loaded until it is captured1200&gt;=
                     0.1.0load.zoomFactorhow much zoom should be applied to the content2.2&gt;=
                     0.1.0load.customHeaderscustom headers to send when requesting the main web
                     page&gt;= 0.1.0load.repertCustomHeadersset true to send with all
                     requestsboolean&gt;= 0.1.0load.cookiescookie string to send when requesting the
                     main web page&gt;= 0.1.0load.postpost string to send when requesting the main
                     web page&gt;= 0.1.0load.blockLocalFileAccessdisallow local and piped files to
                     access other local filesboolean&gt;= 0.1.0load.stopSlowScriptstop slow running
                     javascriptbooleanload.debugJavascriptallow javascript to raise
                     warningsboolean&gt;= 0.1.0load.loadErrorHandlingset error handling
                     strategyabortabort the convertion processskipdo not add the object to the final
                     outputignoretry to add the object to the final output&gt;= 0.1.0load.proxy&gt;=
                     0.1.0web.backgroundinclude background image in outputboolean&gt;=
                     0.1.0web.loadImagesinclude images in outputboolean&gt;=
                     0.1.0web.enableJavascriptenable or disable javascriptboolean&gt;=
                     0.1.0web.enableIntelligentShrinkingenable to attempt to fit more content on
                     page, only applies to PDF outputboolean&gt;= 0.1.0web.minimumFontSizethe
                     minimum font size allowed9&gt;= 0.1.0web.printMediaTypeprint content using
                     print media type instead of screen media typeboolean&gt;=
                     0.1.0web.defaultEncodingcontent to use where no encoding is specifiedutf-8&gt;=
                     0.1.0web.userStyleSheetURL or path to a user specified style
                     sheet/path/to/style.css&gt;= 0.1.0web.enablePluginsenable or disable NS
                     pluginsboolean&gt;= 0.1.0


id: wkhtmltox\Image\Converter::convert
type: function
doc:
<comment>Description:</comment>
  Réalise une conversion d'image
  
  Réalise une conversion dans le buffer de sortie.

<comment>Return:</comment>
  <info>string|null</info>  La valeur retournée contiendra le contenu du buffer de conversion


id: wkhtmltox\Image\Converter::getVersion
type: function
doc:
<comment>Description:</comment>
  Détermine la version du convertisseur
  
  Détermine la version du convertisseur, tel que rapporté par libwkhtmltox

<comment>Return:</comment>
  <info>string</info>  Retourne la version, sous la forme d'une chaîne de caractères
          
          Ceci n'est actuellement pas implémenté par libwkhtmltox


id: wkhtmltox\PDF\Converter
type: class
doc:
<comment>Description:</comment>
  Convertie un HTML en entrée, ou définit un jeux d'entrées HTML, en un PDF en sortie


id: wkhtmltox\PDF\Converter::__construct
type: function
doc:
<comment>Description:</comment>
  Cré un nouveau convertisseur PDF
  
  Crée un nouveau convertisseur PDF, en utilisant optionnellement, une configuration.

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  NomDescriptionValeursHistoriquesize.pageSizeTaille du papier du document
                    finalA4&gt;= 0.1.0size.widthLargeur du document final210mm&gt;=
                    0.1.0size.heightHauteur du document final297mm&gt;= 0.1.0orientationorientation
                    du document finalPaysagePortrait&gt;= 0.1.0colorModeMode couleur du document
                    finalColeurNiveau de gris&gt;= 0.1.0resolutionrésoluition du document finalLa
                    plupart du temps, n'a aucun effet&gt;= 0.1.0dpidpi à utiliser lors de
                    l'impression80&gt;= 0.1.0pageOffsetEntier à ajouter aux numéros de pages générés
                    pour l'en-tête, le pieds de page et le sommaire&gt;= 0.1.0copies&gt;=
                    0.1.0collateSi l'on doit assembler les copiesbooléen&gt;= 0.1.0outlineGénère un
                    plan PDFbooléen&gt;= 0.1.0outlineDepthProfondeur maximal du plan&gt;=
                    0.1.0dumpOutlineChemin du fichier pour extraire le plan XML&gt;= 0.1.0outChemin
                    pour le fichier final, si la sortie "-" est utilisé&gt;= 0.1.0documentTitleTitre
                    du document final&gt;= 0.1.0useCompressionActive ou désactive la compression
                    sans perteboolean&gt;= 0.1.0margin.topTaile de la marge du haut2cm&gt;=
                    0.1.0margin.bottomTaille de la marge du bas2cm&gt;= 0.1.0margin.leftTaille de la
                    marge de gauche2cm&gt;= 0.1.0margin.rightTaille de la marge de droite2cm&gt;=
                    0.1.0imageDPIDPI maximal pour les images dans le document final&gt;=
                    0.1.0imageQualityLe facteur de compression jpeg pour les images dans le document
                    final94&gt;= 0.1.0load.cookieJarChemin vers le fichier utilisé pour charger et
                    stocker les coockies/tmp/cookies.txt&gt;= 0.1.0


id: wkhtmltox\PDF\Converter::add
type: function
doc:
<comment>Description:</comment>
  Ajoute un objet pour la conversion
  
  Ajoute l'objet fourni pour la conversion

<comment>Param:</comment>
  <info>wkhtmltox\PDF\Object</info>  <strong>$object</strong>  L'objet à ajouter

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


id: wkhtmltox\PDF\Converter::convert
type: function
doc:
<comment>Description:</comment>
  Lance la conversion PDF
  
  Lance la conversion de tous les objets précédemment ajoutés.

<comment>Return:</comment>
  <info>string|null</info>  La valeur retournée contiendra le contenu du buffer de conversion.


id: wkhtmltox\PDF\Converter::getVersion
type: function
doc:
<comment>Description:</comment>
  Détermine la version du convertisseur
  
  Détermine la version du convertisseur, tel que rapporté par libwkhtmltox.

<comment>Return:</comment>
  <info>string</info>  Retourne la version sous la forme d'une chaîne de caractères.


id: wkhtmltox\PDF\Object::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet PDF
  
  Crée un nouvel objet PDF depuis le buffer fourni, et optionnellement, configure les options.

<comment>Param:</comment>
  <info>string</info>  <strong>$buffer</strong>    HTML
  <info>array</info>   <strong>$settings</strong>  NomDescriptionValeurHistoriquepageURL ou chemin du fichier HTML à
                     convertir&gt;= 0.1.0useExternalLinksA définir à <info>true</info> pour convertir les liens
                     externes des données d'entrée en lien PDF externes dans les données de
                     sortiebooléen&gt;= 0.1.0useLocalLinksA définir à <info>true</info> pour convertir les liens
                     internes dans les données d'entrées en lien PDF internes dans les données de
                     sortiebooléen&gt;= 0.1.0produceFormsA définir à <info>true</info> pour convertir les
                     formulaires HTML en formulaires PDFbooléen&gt;=
                     0.1.0replacementsnon-documenté&gt;= 0.1.0includeInOutlineA définir à <info>true</info> pour
                     inclure les sections depuis cet objet dans le contour et le
                     sommairebooléen&gt;= 0.1.0pagesCountA définir à <info>true</info> pour inclure dans le
                     sommaire le nombre de pages de cet objetbooléen&gt;= 0.1.0tocXslA définir pour
                     convertir cet objet en un objet de sommaire&gt;= 0.1.0toc.useDottedLinesA
                     définir à <info>true</info> pour utiliser des pointillés dans le sommairebooléen&gt;=
                     0.1.0toc.captionTextLa légende pour le sommaire&gt;= 0.1.0toc.forwardLinksA
                     définir à <info>true</info> pour créer des liens depuis le sommaire vers le
                     contenubooléen&gt;= 0.1.0toc.backLinksA définir à <info>true</info> pour créer des liens
                     depuis le contenu vers le sommairebooléen&gt;=
                     0.1.0toc.indentationL'indentation pour le sommaire2em&gt;= 0.1.0toc.fontScaleLe
                     facteur pour diminuer la police de caractère à tous les niveaux du
                     sommaire0.8&gt;= 0.1.0header.fontSizeLa taille de la police de caractère à
                     utiliser dans l'en-tête13&gt;= 0.1.0header.fontNameLe nom de la police de
                     caractères à utiliser dans l'en-têtetimes&gt;= 0.1.0header.leftLe text pour le
                     côté gauche de l'en-tête&gt;= 0.1.0header.centerLe texte pour le centre de
                     l'en-tête&gt;= 0.1.0header.rightLe texte pour le côté droit de l'en-tête&gt;=
                     0.1.0header.lineActive ou désactive la règle horizontal sous
                     l'en-têteboolean&gt;= 0.1.0header.spacingL'espace entre l'en-tête et le
                     contenu1.8&gt;= 0.1.0header.htmlUrlULR ou le chemin vers le fichier HTML à
                     utiliser dans l'en-tête&gt;= 0.1.0footer.fontSizeLa taille de la police de
                     caractère à utiliser dans le bas de page13&gt;= 0.1.0footer.fontNameLe nom de
                     la police de caractère à utiliser dans le bas de pagetimes&gt;=
                     0.1.0footer.leftLe texte pour le côté gauche du bas de page&gt;=
                     0.1.0footer.centerLe texte pour le centre du bas de page&gt;=
                     0.1.0footer.rightLe texte pour le côté droit du bas de page&gt;=
                     0.1.0footer.lineActive ou désactive la règle horizontale sous le bas de
                     pagebooléen&gt;= 0.1.0footer.spacingL'espace entre le bas de page et le
                     contenu1.8&gt;= 0.1.0footer.htmlUrlURL ou le chemin du fichier HTML à utiliser
                     dans le bas de page&gt;= 0.1.0load.usernameuser name to use when loging into a
                     websitebart&gt;= 0.1.0load.passwordthe password to used when logging into a
                     websiteelbarto&gt;= 0.1.0load.jsdelaythe amount of time in milliseconds to wait
                     after a page is loaded until it is captured1200&gt;= 0.1.0load.zoomFactorhow
                     much zoom should be applied to the content2.2&gt;=
                     0.1.0load.customHeaderscustom headers to send when requesting the main web
                     page&gt;= 0.1.0load.repertCustomHeadersset true to send with all
                     requestsboolean&gt;= 0.1.0load.cookiescookie string to send when requesting the
                     main web page&gt;= 0.1.0load.postpost string to send when requesting the main
                     web page&gt;= 0.1.0load.blockLocalFileAccessdisallow local and piped files to
                     access other local filesboolean&gt;= 0.1.0load.stopSlowScriptstop slow running
                     javascriptbooleanload.debugJavascriptallow javascript to raise
                     warningsboolean&gt;= 0.1.0load.loadErrorHandlingset error handling
                     strategyabortabort the convertion processskipdo not add the object to the final
                     outputignoretry to add the object to the final output&gt;= 0.1.0load.proxy&gt;=
                     0.1.0web.backgroundinclude background image in outputboolean&gt;=
                     0.1.0web.loadImagesinclude images in outputboolean&gt;=
                     0.1.0web.enableJavascriptenable or disable javascriptboolean&gt;=
                     0.1.0web.enableIntelligentShrinkingenable to attempt to fit more content on
                     page, only applies to PDF outputboolean&gt;= 0.1.0web.minimumFontSizethe
                     minimum font size allowed9&gt;= 0.1.0web.printMediaTypeprint content using
                     print media type instead of screen media typeboolean&gt;=
                     0.1.0web.defaultEncodingcontent to use where no encoding is specifiedutf-8&gt;=
                     0.1.0web.userStyleSheetURL or path to a user specified style
                     sheet/path/to/style.css&gt;= 0.1.0web.enablePluginsenable or disable NS
                     pluginsboolean&gt;= 0.1.0


id: wordwrap
type: function
doc:
<comment>Description:</comment>
  Effectue la césure d'une chaîne
  
  Effectue la césure d'une chaîne.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>          La chaîne d'entrée.
  <info>int</info>     <strong>$width</strong>           Le nombre de caractères à partir duquel la chaîne sera coupée.
  <info>string</info>  <strong>$break</strong>           La ligne est rompue en utilisant ce paramètre optionnel.
  <info>bool</info>    <strong>$cut_long_words</strong>  Si le paramètre <strong>$cut_long_words</strong> vaut <info>true</info>, la césure de la chaîne sera
                           toujours à la taille <strong>$width</strong> ou avant. Si vous avez un mot qui est plus
                           long que la taille de césure, il sera coupé en morceaux : voir le second
                           exemple. Lorsque vaut <info>false</info>, la fonction ne va pas couper le mot, même si
                           le paramètre <strong>$width</strong> est plus petit que la taille du mot.

<comment>Return:</comment>
  <info>string</info>  Retourne la chaîne fournie coupée à la longueur spécifiée.

<comment>See Also:</comment>
   * <strong>nl2br()</strong>
   * <strong>chunk_split()</strong>


id: xattr_get
type: function
doc:
<comment>Description:</comment>
  Récupère un attribut étendu
    
  
  <strong>xattr_get()</strong> récupère la valeur de l'attribut étendu nommé <strong>$name</strong> du fichier <strong>$path</strong>.
  
  Les attributs étendus ont deux espaces de noms
  différents : <return>user</return> et <return>root</return>. L'espace de noms
  <return>user</return> est disponible pour tous les utilisateurs tandis que l'espace de
  noms <return>root</return> n'est disponible que pour les utilisateurs ayant les privilèges
  <return>root</return>. xattr opère sur l'espace de noms <return>user</return> par
  défaut, mais vous pouvez changer cela en utilisant l'argument
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le fichier depuis lequel on récupère l'attribut.
  <info>string</info>  <strong>$name</strong>      Le nom de l'attribut.
  <info>int</info>     <strong>$flags</strong>     FLags xattr supportés<info>XATTR_DONTFOLLOW</info>Ne pas suivre les liens symboliques mais
                     opère directement sur le lien lui-même.<info>XATTR_ROOT</info>Définie l'attribut dans
                     l'espace de noms racine. Nécessaire les privilèges d'administrateur.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne contenant la valeur ou <info>false</info> si l'attribut n'existe pas.

<comment>See Also:</comment>
   * <strong>xattr_list()</strong>
   * <strong>xattr_set()</strong>
   * <strong>xattr_remove()</strong>


id: xattr_list
type: function
doc:
<comment>Description:</comment>
  Récupère une liste d'attributs étendus
    
  
  <strong>xattr_list()</strong> récupère une liste de noms d'attributs étendus d'un fichier désigné par le paramètre
  <strong>$path</strong>.
  
  Les attributs étendus ont deux espaces de noms
  différents : <return>user</return> et <return>root</return>. L'espace de noms
  <return>user</return> est disponible pour tous les utilisateurs tandis que l'espace de
  noms <return>root</return> n'est disponible que pour les utilisateurs ayant les privilèges
  <return>root</return>. xattr opère sur l'espace de noms <return>user</return> par
  défaut, mais vous pouvez changer cela en utilisant l'argument
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le chemin vers le fichier.
  <info>int</info>     <strong>$flags</strong>     FLags xattr supportés<info>XATTR_DONTFOLLOW</info>Ne pas suivre les liens symboliques mais
                     opère directement sur le lien lui-même.<info>XATTR_ROOT</info>Définie l'attribut dans
                     l'espace de noms racine. Nécessaire les privilèges d'administrateur.

<comment>Return:</comment>
  <info>array</info>  Cette fonction retourne un tableau contenant les noms des attributs étendus.

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


id: xattr_remove
type: function
doc:
<comment>Description:</comment>
  Efface un attribut étendu
    
  
  <strong>xattr_remove()</strong> efface un attribut étendu nommé <strong>$name</strong> d'un fichier désigné par le paramètre <strong>$path</strong>.
  
  Les attributs étendus ont deux espaces de noms
  différents : <return>user</return> et <return>root</return>. L'espace de noms
  <return>user</return> est disponible pour tous les utilisateurs tandis que l'espace de
  noms <return>root</return> n'est disponible que pour les utilisateurs ayant les privilèges
  <return>root</return>. xattr opère sur l'espace de noms <return>user</return> par
  défaut, mais vous pouvez changer cela en utilisant l'argument
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le fichier depuis lequel nous effaçons l'attribut.
  <info>string</info>  <strong>$name</strong>      Le nom de l'attribut à effacer.
  <info>int</info>     <strong>$flags</strong>     Options xattr disponibles<info>XATTR_DONTFOLLOW</info>Ne pas suivre les liens symboliques
                     mais opère directement sur le lien lui-même.<info>XATTR_ROOT</info>Définie l'attribut dans
                     l'espace de noms racine. Nécessaire les privilèges d'administrateur.

<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>xattr_list()</strong>
   * <strong>xattr_set()</strong>
   * <strong>xattr_get()</strong>


id: xattr_set
type: function
doc:
<comment>Description:</comment>
  Définit un attribut étendu
    
  
  <strong>xattr_set()</strong> définie la valeur d'un attribut étendu nommé <strong>$name</strong> à la valeur <strong>$value</strong> d'un fichier
  désigné par le paramètre <strong>$path</strong>.
  
  Les attributs étendus ont deux espaces de noms
  différents : <return>user</return> et <return>root</return>. L'espace de noms
  <return>user</return> est disponible pour tous les utilisateurs tandis que l'espace de
  noms <return>root</return> n'est disponible que pour les utilisateurs ayant les privilèges
  <return>root</return>. xattr opère sur l'espace de noms <return>user</return> par
  défaut, mais vous pouvez changer cela en utilisant l'argument
  <strong>$flags</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le fichier dans lequel nous devons définir l'attribut.
  <info>string</info>  <strong>$name</strong>      Le nom de l'attribut étendu. Cet attribut sera créé s'il n'existe pas encore ou
                     remplacé sinon. Vous pouvez modifier ce comportement en utilisant le paramètre
                     <strong>$flags</strong>.
  <info>string</info>  <strong>$value</strong>     La valeur de l'attribut.
  <info>int</info>     <strong>$flags</strong>     Flags xattr supportés<info>XATTR_CREATE</info>La fonction échouera si l'attribut étendu
                     existe déjà.<info>XATTR_REPLACE</info>La fonction échouera si l'attribut étendu n'existe
                     pas.<info>XATTR_DONTFOLLOW</info>Ne pas suivre les liens symboliques mais opère directement
                     sur le lien lui-même.<info>XATTR_ROOT</info>Définie l'attribut dans l'espace de noms racine.
                     Nécessaire les privilèges d'administrateur.

<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>xattr_get()</strong>
   * <strong>xattr_remove()</strong>


id: xattr_supported
type: function
doc:
<comment>Description:</comment>
  Vérifie si un système de fichiers supporte les attributs étendus
    
  
  <strong>xattr_supported()</strong> vérifie si le système de fichiers contenant le fichier <strong>$path</strong> supporte les
  attributs étendus. Un accès en lecture au fichier <strong>$path</strong> est nécessaire.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le chemin du fichier à tester.
  <info>int</info>     <strong>$flags</strong>     Flags xattr supportés<info>XATTR_DONTFOLLOW</info>Ne pas suivre les liens symboliques mais
                     opère directement sur le lien lui-même.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> si le système de fichiers supporte les attributs étendus, <info>false</info>
        sinon et <info>null</info> si l'on ne peut pas le déterminer (par exemple, mauvais chemin vers le fichier
        ou lorsqu'il manque des permissions sur le fichier).

<comment>See Also:</comment>
   * <strong>xattr_get()</strong>
   * <strong>xattr_list()</strong>


id: xdiff_file_bdiff
type: function
doc:
<comment>Description:</comment>
  Crée un diff binaire de 2 fichiers
  
  Crée un diff binaire de 2 fichiers et enregistre le résultat dans un fichier patch. Cette fonction
  fonctionne avec des fichiers textes mais aussi des fichiers binaires. Le fichier patch résultant
  peut être ensuite appliqué en utilisant les fonctions <strong>xdiff_file_bpatch()</strong> et
  <strong>xdiff_string_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Chemin vers le premier fichier. C'est l'ancien fichier.
  <info>string</info>  <strong>$new_file</strong>  Chemin vers le second fichier. C'est le nouveau fichier.
  <info>string</info>  <strong>$dest</strong>      Chemin vers le fichier patch résultant. Ce patch contient les différences entre
                     l'ancien et le nouveau fichier.Il est au format binaire et est humainement
                     illisible.

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


id: xdiff_file_bdiff_size
type: function
doc:
<comment>Description:</comment>
  Lit la taille d'un fichier créé lors de l'application d'un diff binaire
  
  Retourne la taille d'un fichier résultat créé après l'application d'un patch binaire depuis le
  fichier <strong>$file</strong> sur le fichier original.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>  Le patch du patch binaire créé par la fonction <strong>xdiff_string_bdiff()</strong> ou la fonction
                 <strong>xdiff_string_rabdiff()</strong>.

<comment>Return:</comment>
  <info>int</info>  Retourne la taille du fichier créé.

<comment>See Also:</comment>
   * <strong>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_rabdiff()</strong>
   * <strong>xdiff_file_bpatch()</strong>


id: xdiff_file_bpatch
type: function
doc:
<comment>Description:</comment>
  Patche un fichier avec un diff binaire
  
  Patche le fichier <strong>$file</strong> avec le <strong>$patch</strong> binaire et enregistre le résultat dans le fichier <strong>$dest</strong>.
  Cette fonction accepte les patchs créés via les fonctions <strong>xdiff_file_bdiff()</strong> et
  <strong>xdiff_file_rabdiff()</strong> ou leur équivalent sous forme de chaînes.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   Le fichier original.
  <info>string</info>  <strong>$patch</strong>  Le fichier patch binaire.
  <info>string</info>  <strong>$dest</strong>   Chemin vers le fichier résultat.

<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>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_rabdiff()</strong>


id: xdiff_file_diff
type: function
doc:
<comment>Description:</comment>
  Créé un diff unifié entre deux fichiers
  
  Crée un diff unifié contenant les différences entre le fichier <strong>$old_file</strong> et <strong>$new_file</strong> et les
  enregistre dans le fichier <strong>$dest</strong>. Le fichier résultant est humainement lisible. Le paramètre
  optionnel <strong>$context</strong> spécifie le nombre de lignes du contexte qui doit être ajouté autour de chaque
  modification. Si le paramètre <strong>$minimal</strong> vaut <info>true</info>, alors le fichier de sortie sera le plus petit
  possible (peut prendre beaucoup de temps).

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Chemin vers le premier fichier. Ce fichier représente l'ancien fichier.
  <info>string</info>  <strong>$new_file</strong>  Chemin vers le second fichier. Ce fichier représente le nouveau fichier.
  <info>string</info>  <strong>$dest</strong>      Chemin vers le fichier contenant la différence.
  <info>int</info>     <strong>$context</strong>   Indique le nombre de lignes de contexte que vous voulez inclure dans le
                     résultat de diff.
  <info>bool</info>    <strong>$minimal</strong>   Configurez <strong>$minimal</strong> à <info>true</info> si vous voulez minimaliser la taille du fichier des
                     différences (peut prendre beaucoup de temps).

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


id: xdiff_file_diff_binary
type: function
doc:
<comment>Description:</comment>
  Alias de xdiff_file_bdiff
  
  Créé un diff binaire entre les deux fichiers et stocke le résultat dans <strong>$dest</strong>. Cette fonction
  fonctionne avec les fichiers texte, mais aussi avec les fichiers binaires. Le patch résultant peut
  être appliqué à l'aide de la fonction <strong>xdiff_file_bpatch()</strong>.
  
  Depuis la version 1.5.0, cette fonction est un alias de  <strong>xdiff_file_bdiff()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Chemin jusqu'au premier fichier. Ce fichier est le "vieux" fichier.
  <info>string</info>  <strong>$new_file</strong>  Chemin jusqu'au deuxième fichier. Ce fichier est le "nouveau" fichier.
  <info>string</info>  <strong>$dest</strong>      Chemin vers le fichier résultat. Ce fichier contient les différences entre
                     l'ancien et le nouveau fichier. C'est un format binaire, et il est lisible par
                     un humain.

<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>xdiff_file_bdiff()</strong>
   * <strong>xdiff_file_bpatch()</strong>


id: xdiff_file_merge3
type: function
doc:
<comment>Description:</comment>
  Fusionne trois fichiers en un seul
  
  Fusionne les fichiers <strong>$file1</strong>, <strong>$file2</strong> et <strong>$file3</strong> en un seul et le stocke dans <strong>$dest</strong>. Le fichier
  <strong>$old_file</strong> est la version originale, tandis que les fichiers <strong>$new_file1</strong> et <strong>$new_file2</strong> sont les
  versions modifiées de l'original.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>   Chemin vers le premier fichier. C'est l'ancien fichier.
  <info>string</info>  <strong>$new_file1</strong>  Chemin vers le second fichier. C'est la verion modifiée de <strong>$old_file</strong>.
  <info>string</info>  <strong>$new_file2</strong>  Chemin vers le troisième fichier. C'est la version modifiée de <strong>$old_file</strong>.
  <info>string</info>  <strong>$dest</strong>       Chemin vers le fichier résultant, contenant la fusion des modifications des
                      fichiers <strong>$new_file1</strong> et <strong>$new_file2</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Retourne <info>true</info> si la fusion a réussi, une chaîne avec les parties rejetées s'il y en a, ou
         <info>false</info> si une erreur interne s'est produite.

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


id: xdiff_file_patch
type: function
doc:
<comment>Description:</comment>
  Patche un fichier avec un diff unifié
  
  Patche le fichier <strong>$file</strong> avec le patch fourni par le paramètre <strong>$patch</strong> et enregistre le résultat
  dans un fichier. <strong>$patch</strong> doit être un diff unifié créé par la fonction
  <strong>xdiff_file_diff()</strong>/<strong>xdiff_string_diff()</strong>. Un paramètre optionnel <strong>$flags</strong> spécifie le mode de
  l'opération.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   Le fichier original.
  <info>string</info>  <strong>$patch</strong>  Le fichier contenant le patch unifié. Il doit avoir été créé en utilisant les
                  fonctions <strong>xdiff_string_diff()</strong>, <strong>xdiff_file_diff()</strong> ou par des outils compatibles.
  <info>string</info>  <strong>$dest</strong>   Le chemin vers le fichier résultat.
  <info>int</info>     <strong>$flags</strong>  Peut être soit <info>XDIFF_PATCH_NORMAL</info> (mode par défaut, patch normal) ou
                  <info>XDIFF_PATCH_REVERSE</info> (patch inversé).
                  
                  Depuis la version 1.5.0, vous pouvez également utiliser l'opérateur binaire OR
                  pour activer le drapeau <info>XDIFF_PATCH_IGNORESPACE</info>.

<comment>Return:</comment>
  <info>mixed</info>  Retourne <info>false</info> si une erreur interne s'est produite, une chaîne avec les parties rejetées
         du <strong>$patch</strong> si c'est le cas ou <info>true</info> si le <strong>$patch</strong> a été appliqué avec succès.

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


id: xdiff_file_patch_binary
type: function
doc:
<comment>Description:</comment>
  Alias de xdiff_file_bpatch
  
  Patche le fichier <strong>$file</strong> avec un <strong>$patch</strong> binaire et enregistre le résultat dans le fichier <strong>$dest</strong>.
  Cette fonction accepte les patchs créés avec la fonction <strong>xdiff_file_bdiff()</strong> ou la fonction
  <strong>xdiff_file_rabdiff()</strong> ou leur équivalent sous forme de chaînes.
  
  Depuis la version 1.5.0, cette fonction est un alias de la fonction <strong>xdiff_file_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$file</strong>   Le fichier original.
  <info>string</info>  <strong>$patch</strong>  Le Patch binaire.
  <info>string</info>  <strong>$dest</strong>   Le chemin vers le fichier résultat.

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


id: xdiff_file_rabdiff
type: function
doc:
<comment>Description:</comment>
  Crée un diff binaire de 2 fichiers en utilisant l'algorithme polynomial de Rabin des empreintes
  digitales
  
  Crée un diff binaire de 2 fichiers et enregistre le résultat dans un fichier patch. La différence
  entre cette fonction et la fonction <strong>xdiff_file_bdiff()</strong> se situe au niveau de l'algorithme utilisé.
  Aussi, cette fonction devrait être plus rapide et devrait produire un diff plus petit. Cette
  fonction fonctionne avec des fichiers textes, comme avec des fichiers binaires. Le fichier patch
  résultant pourra ensuite être appliqué avec les fonctions <strong>xdiff_file_bpatch()</strong> et
  <strong>xdiff_string_bpatch()</strong>.
  
  Pour plus de détails concernant les différences d'algorithme, reportez-vous au site web de la
  bibliothèque libxdiff.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_file</strong>  Chemin vers le premier fichier. C'est l'ancien fichier.
  <info>string</info>  <strong>$new_file</strong>  Chemin vers le second fichier. C'est le nouveau fichier.
  <info>string</info>  <strong>$dest</strong>      Chemin vers le fichier résultant. Le fichier résultant contient les différences
                     entre l'ancien et le nouveau fichier. Il est au format binaire, aussi, il ne
                     sera pas humainement lisible.

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


id: xdiff_string_bdiff
type: function
doc:
<comment>Description:</comment>
  Crée un diff binaire de 2 chaînes
  
  Crée un diff binaire de 2 chaînes et retourne le résultat. Cette fonction fonctionne aussi bien
  avec des données textes qu'avec des données binaires. Le patch résultant pourra ensuite être
  appliqué en utilisant les fonctions <strong>xdiff_string_bpatch()</strong> et <strong>xdiff_file_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  Première chaîne contenant des données binaires. Ce sont les anciennes données.
  <info>string</info>  <strong>$new_data</strong>  Seconde chaîne contenant des données binaires. Ce sont les nouvelles données.

<comment>Return:</comment>
  <info>string</info>  Retourne un diff binaire contenant les différences entre les anciennes et les nouvelles
          données, ou <info>false</info> si une erreur interne survient.

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


id: xdiff_string_bdiff_size
type: function
doc:
<comment>Description:</comment>
  Lit la taille d'un fichier créé en appliquant un diff binaire
  
  Retourne la taille d'un fichie résultat créé après l'application d'un <strong>$patch</strong> binaure sur un
  fichier original.

<comment>Param:</comment>
  <info>string</info>  <strong>$patch</strong>  Le patch binaire créé par la fonction <strong>xdiff_string_bdiff()</strong> ou la fonction
                  <strong>xdiff_string_rabdiff()</strong>.

<comment>Return:</comment>
  <info>int</info>  Retourne la taille du fichier créé.

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>
   * <strong>xdiff_string_bpatch()</strong>


id: xdiff_string_bpatch
type: function
doc:
<comment>Description:</comment>
  Patche une chaîne avec un diff binaire
  
  Patche une chaîne <strong>$str</strong> avec un <strong>$patch</strong> binaire. Cette fonction accepte les patchs créés via les
  fonctions <strong>xdiff_string_bdiff()</strong> et <strong>xdiff_string_rabdiff()</strong>, ou leur équivalent sous forme de
  fichier.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    La chaîne binaire originale.
  <info>string</info>  <strong>$patch</strong>  Le patch binaire sous forme d'une chaîne de caractères.

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

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>


id: xdiff_string_diff
type: function
doc:
<comment>Description:</comment>
  Créé un diff unifié entre deux chaînes
  
  Crée un diff unifié contenant les différences entre la chaîne <strong>$old_data</strong> et la chaîne <strong>$new_data</strong> et
  retourne le diff ainsi créé. Le diff résultant est humainement lisible. Le paramètre optionnel
  <strong>$context</strong> spécifie le nombre de lignes de contexte à ajouter autour de chaque modification. Le fait
  de définir le paramètre <strong>$minimal</strong> à <info>true</info> fera que le diff sera le plus petit possible (peut prendre
  du temps).

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  Première chaîne de données. Ce sont les anciennes données.
  <info>string</info>  <strong>$new_data</strong>  Seconde chaîne de données. Ce sont les nouvelles données.
  <info>int</info>     <strong>$context</strong>   Indique le nombre de lignes de contexte que vous voulez inclure dans le diff
                     résultant.
  <info>bool</info>    <strong>$minimal</strong>   Configurez <strong>$minimal</strong> à <info>true</info> si vous voulez minimaliser la taille du diff (peut
                     prendre beaucoup de temps).

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne représentant le diff résultant, ou <info>false</info> si une erreur interne
          survient.

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


id: xdiff_string_diff_binary
type: function
doc:
<comment>Description:</comment>
  Alias de xdiff_string_bdiff
  
  Crée un diff binaire de 2 chaînes et retourne le résultat. Cette fonction fonctionne avec du texte
  mais aussi avec des données binaires. Le patch résultant peut être appliqué ultérieurement en
  utilisant la fonction <strong>xdiff_string_bpatch()</strong>/<strong>xdiff_file_bpatch()</strong>.
  
  Depuis la version 1.5.0, cette fonction est un alias de la fonction <strong>xdiff_string_bdiff()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  Première chaîne avec des données binaires. Ce sont les anciennes données.
  <info>string</info>  <strong>$new_data</strong>  Seconde chaîne avec des données binaires. Ce sont les nouvelles données.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne avec le résultat ou <info>false</info> si une erreur interne est survenue.

<comment>See Also:</comment>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_bpatch()</strong>


id: xdiff_string_merge3
type: function
doc:
<comment>Description:</comment>
  Fusionne trois chaînes en une seule
  
  Fusionne 3 chaînes en une et retourne le résultat. Le paramètre <strong>$old_data</strong> est la version originale
  des données tandis que <strong>$new_data1</strong> et <strong>$new_data2</strong> sont les versions modifiées de l'original. Le
  paramètre optionnel <strong>$error</strong> est utilisé pour stocker toutes les parties rejetées lors de la fusion.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>   Première chaîne de données. Ce sont les anciennes données.
  <info>string</info>  <strong>$new_data1</strong>  Seconde chaîne de données. Ce sont les versions modifiées de <strong>$old_data</strong>.
  <info>string</info>  <strong>$new_data2</strong>  Troisième chaîne de données. Ce sont les versions modifiées de <strong>$old_data</strong>.
  <info>string</info>  <strong>$error</strong>      Si <strong>$error</strong> est fourni, alors les parties rejetées y seront stockées.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la chaîne fusionnée, <info>false</info> si une erreur interne survient ou <info>true</info> si la chaîne
         fusionnée est vide.

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


id: xdiff_string_patch
type: function
doc:
<comment>Description:</comment>
  Patche une chaîne avec un diff unifié
  
  Patche la chaîne <strong>$str</strong> avec un <strong>$patch</strong> unifié et retourne le résultat. <strong>$patch</strong> doit être un patch
  unifié créé par les fonctions <strong>xdiff_file_diff()</strong> et <strong>xdiff_string_diff()</strong>. Un paramètre optionnel
  <strong>$flags</strong> spécifie le mode de l'opération. Toutes les parties rejetées seront stockées dans la
  variable <strong>$error</strong> si elle est fournie.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    La chaîne originale.
  <info>string</info>  <strong>$patch</strong>  Le patch unifié. Il doit avoir été créé en utilisant les fonctions
                  <strong>xdiff_string_diff()</strong>, <strong>xdiff_file_diff()</strong> ou tout autre outil compatible.
  <info>int</info>     <strong>$flags</strong>  <strong>$flags</strong> peut être soit <info>XDIFF_PATCH_NORMAL</info> (mode par défaut, patch normal), soit
                  <info>XDIFF_PATCH_REVERSE</info> (patch inversé).
                  
                  Depuis la version 1.5.0, vous pouvez également utiliser l'opérateur binaire OR
                  pour activer le drapeau <info>XDIFF_PATCH_IGNORESPACE</info>.
  <info>string</info>  <strong>$error</strong>  Si <strong>$error</strong> est fourni, les parties rejetées y seront stockées.

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

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


id: xdiff_string_patch_binary
type: function
doc:
<comment>Description:</comment>
  Alias de xdiff_string_bpatch
  
  Patche une chaîne <strong>$str</strong> avec un <strong>$patch</strong> binaire. Cette fonction accepte les patchs créés avec les
  fonctions <strong>xdiff_string_bdiff()</strong> et <strong>xdiff_string_rabdiff()</strong> ou leur équivalent en fichiers.
  
  Depuis la version 1.5.0, cette fonction est un alias de la fonction <strong>xdiff_string_bpatch()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>    La chaîne binaire originale.
  <info>string</info>  <strong>$patch</strong>  Le patch binaire.

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

<comment>See Also:</comment>
   * <strong>xdiff_string_bpatch()</strong>
   * <strong>xdiff_string_bdiff()</strong>
   * <strong>xdiff_string_rabdiff()</strong>


id: xdiff_string_rabdiff
type: function
doc:
<comment>Description:</comment>
  Crée un diff binaire de 2 chaînes en utilisant l'algorithme polynomial de Rabin des empreintes
  digitales
  
  Crée un diff binaire de 2 chaînes et retourne le résultat. La différence entre cette fonction et
  la fonction <strong>xdiff_string_bdiff()</strong> se situe au niveau de l'algorithme utilisé ; cette fonction
  devrait être plus rapide et produire un diff plus petit. Cette fonction est utilisable aussi bien
  sur des données textes que binaires. Le patch résultant pourra être appliqué par la suite grâce
  aux fonctions <strong>xdiff_string_bpatch()</strong> et <strong>xdiff_file_bpatch()</strong>.
  
  Pour plus de détails concernant la différence d'algorithme, reportez-vous au site web de la
  bibliothèque libxdiff.

<comment>Param:</comment>
  <info>string</info>  <strong>$old_data</strong>  Première chaîne de données binaires. Ce sont les anciennes données.
  <info>string</info>  <strong>$new_data</strong>  Seconde chaîne de données binaires. Ce sont les nouvelles données.

<comment>Return:</comment>
  <info>string</info>  Retourne un diff binaire contenant les différences entre les anciennes et les nouvelles
          données, ou <info>false</info> si une erreur interne survient.

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


id: xhprof_disable
type: function
doc:
<comment>Description:</comment>
  Stoppe le profilage xhprof
  
  Stoppe le profilage, et retourne les données xhprof correspondant à son exécution.

<comment>Return:</comment>
  <info>array</info>  Un tableau de données xhprof, issues de son exécution.


id: xhprof_enable
type: function
doc:
<comment>Description:</comment>
  Démarre le profilage xhprof
  
  Démarre le profilage xhprof.

<comment>Param:</comment>
  <info>int</info>    <strong>$flags</strong>    Drapeaux optionnels pour ajouter des informations supplémentaires au profilage.
                   Voir les constantes XHprof pour plus d'informations sur ces drapeaux, comme
                   <info>XHPROF_FLAGS_MEMORY</info> pour activer le profilage de la mémoire.
  <info>array</info>  <strong>$options</strong>  Un tableau d'options optionnelles, comme par exemple l'option 'ignored_functions'
                   pour spécifier des fonctions à ignorer durant le profilage.

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

<comment>See Also:</comment>
   * <strong>xhprof_disable()</strong>
   * <strong>xhprof_sample_enable()</strong>
   * <strong>memory_get_usage()</strong>
   * <strong>getrusage()</strong>


id: xhprof_sample_disable
type: function
doc:
<comment>Description:</comment>
  Stoppe le profilage xhprof sur échantillon
  
  Stoppe le profilage xhprof sur échantillon.

<comment>Return:</comment>
  <info>array</info>  Un tableau de données de l'échantillon xhprof, issues de son exécution.


id: xhprof_sample_enable
type: function
doc:
<comment>Description:</comment>
  Démarre le profilage en mode échantillonnage
  
  Démarre le profilage en mode échantillonnage, ce qui correspond à une version plus légère de la
  fonction <strong>xhprof_enable()</strong>. L'intervalle d'échantillonnage est de 0.1 seconde, et les échantillons
  enregistrent la pile complète des fonctions appelées. La principale utilité de cette fonction est
  lorsque l'on souhaite diagnostiquer et surveiller les performances sans pour autant consommer trop
  de ressources.

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

<comment>See Also:</comment>
   * <strong>xhprof_sample_disable()</strong>
   * <strong>xhprof_enable()</strong>
   * <strong>memory_get_usage()</strong>
   * <strong>getrusage()</strong>


id: xml_error_string
type: function
doc:
<comment>Description:</comment>
  Lit le message d'erreur de l'analyseur XML
  
  Lit le message d'erreur de l'analyseur XML associé avec le code <strong>$error_code</strong> donné.

<comment>Param:</comment>
  <info>int</info>  <strong>$error_code</strong>  Un code erreur provenant de <strong>xml_get_error_code()</strong>.

<comment>Return:</comment>
  <info>string|null</info>  Retourne une chaîne représentant la description de l'erreur <strong>$error_code</strong>, ou <info>null</info> si
               aucune description n'est trouvée.

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


id: xml_get_current_byte_index
type: function
doc:
<comment>Description:</comment>
  Retourne l'index de l'octet courant d'un analyseur XML
  
  Retourne l'index de l'octet courant de l'analyseur XML donné.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Une référence sur un analyseur XML valide.

<comment>Return:</comment>
  <info>int</info>  <strong>xml_get_current_byte_index()</strong> retourne l'index de l'octet d'analyse courante de l'analyseur
       XML  (débute à 0).

<comment>See Also:</comment>
   * <strong>xml_get_current_column_number()</strong>
   * <strong>xml_get_current_line_number()</strong>


id: xml_get_current_column_number
type: function
doc:
<comment>Description:</comment>
  Retourne le numéro de colonne courant d'un analyseur XML
    
  
  Retourne le numéro de colonne courant de l'analyseur XML donné.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Une référence sur un analyseur XML valide.

<comment>Return:</comment>
  <info>int</info>  <strong>xml_get_current_column_number()</strong> retourne le numéro de colonne courante de la ligne courante
       de l'analyseur,  qui correspond à la position d'analyse courante de l'analyseur XML  (comme
       retourné par <strong>xml_get_current_line_number()</strong>).

<comment>See Also:</comment>
   * <strong>xml_get_current_byte_index()</strong>
   * <strong>xml_get_current_line_number()</strong>


id: xml_get_current_line_number
type: function
doc:
<comment>Description:</comment>
  Retourne le numéro de ligne courant d'un analyseur XML
  
  Retourne le numéro de ligne courant de l'analyseur XML donné.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Une référence sur un analyseur XML valide.

<comment>Return:</comment>
  <info>int</info>  Retourne le numéro de la ligne en cours d'analyse.

<comment>See Also:</comment>
   * <strong>xml_get_current_column_number()</strong>
   * <strong>xml_get_current_byte_index()</strong>


id: xml_get_error_code
type: function
doc:
<comment>Description:</comment>
  Récupère le code erreur de l'analyseur XML
  
  Récupère le code erreur de l'analyseur XML.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Une référence sur un analyseur XML valide.

<comment>Return:</comment>
  <info>int</info>  <strong>xml_get_error_code()</strong> retourne un des codes erreur listés dans la section sur les codes
       erreur.

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


id: xml_parse
type: function
doc:
<comment>Description:</comment>
  Commence l'analyse d'un document XML
  
  <strong>xml_parse()</strong> analyse un document XML. Les gestionnaires pour les événements configurés sont appelés
  autant de fois que nécessaire.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>    Une référence sur l'analyseur XML à utiliser.
  <info>string</info>     <strong>$data</strong>      Une partie des données à analyser. Un document peut être analysé morceau par
                        morceau par appels successifs à  <strong>xml_parse()</strong> avec de nouvelles données,
                        aussi longtemps que le paramètre <strong>$is_final</strong> est défini et <info>true</info> lorsque les
                        dernières données sont analysées.
  <info>bool</info>       <strong>$is_final</strong>  Si défini et vaut <info>true</info>, <strong>$data</strong> sera le dernier morceau de données envoyées à
                        l'analyseur.

<comment>Return:</comment>
  <info>int</info>  Retourne 1 en cas de succès ou 0 en cas d'échec.
       
       Lors d'un échec d'analyse, la cause de l'erreur peut être obtenue grâce  aux fonctions
       <strong>xml_get_error_code()</strong>, <strong>xml_error_string()</strong>, <strong>xml_get_current_line_number()</strong>,
       <strong>xml_get_current_column_number()</strong> et <strong>xml_get_current_byte_index()</strong>.
       
       Quelques erreurs (dont les erreurs d'entités) sont reportées à la fin des données, ceci
       uniquement si <strong>$is_final</strong> vaut <info>true</info>.


id: xml_parse_into_struct
type: function
doc:
<comment>Description:</comment>
  Analyse une structure XML
  
  Cette fonction analyse la chaîne XML <strong>$data</strong> et le place dans deux tableaux : le premier <strong>$index</strong>
  contient des pointeurs sur la position des valeurs correspondantes dans le tableau <strong>$values</strong>. Ces
  deux paramètres sont passés par références.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Une référence à une analyseur XML.
  <info>string</info>     <strong>$data</strong>    Une chaîne de caractères contenant les données XML.
  <info>array</info>      <strong>$values</strong>  Un tableau contenant les valeurs des données XML.
  <info>array</info>      <strong>$index</strong>   Un tableau contenant les pointeurs vers les valeurs appropriées dans le
                      paramètre $values.

<comment>Return:</comment>
  <info>int</info>  <strong>xml_parse_into_struct()</strong> retourne 0 si une erreur survient et 1 en cas de succès. Ce n'est pas
       la même chose que <info>false</info> et <info>true</info>, soyez prudent avec les opérateurs comme ===.


id: xml_parser_create
type: function
doc:
<comment>Description:</comment>
  Création d'un analyseur XML
  
  <strong>xml_parser_create()</strong> crée un analyseur XML et retourne une instance de <class>XMLParser</class> à utiliser avec
  les autres fonctions XML.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>  L'encodage d'entrée est automatiquement détecté, ainsi le paramètre
                          <strong>$encoding</strong> ne spécifie que l'encodage de sortie. Si une chaîne vide est
                          passée, l'analyseur tente d'identifier dans quel encodage le document est
                          encodé en regardant les 3 ou 4 octets du haut. Le jeu de caractères de
                          sortie par défaut est UTF-8. Les encodages supportées sont <return>ISO-8859-1</return>,
                          <return>UTF-8</return>, et <return>US-ASCII</return>.

<comment>Return:</comment>
  <info>XMLParser</info>  Retourne une nouvelle instance de <class>XMLParser</class>.

<comment>See Also:</comment>
   * <strong>xml_parser_create_ns()</strong>
   * <strong>xml_parser_free()</strong>


id: xml_parser_create_ns
type: function
doc:
<comment>Description:</comment>
  Crée un analyseur XML
  
  <strong>xml_parser_create_ns()</strong> crée un nouvel analyseur XML avec le support des espaces de noms, et
  retourne une instance de <class>XMLParser</class> à utiliser avec les autres fonctions XML.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$encoding</strong>   Ce jeu de caractères est automatiquement détecté et, donc, le paramètre
                           <strong>$encoding</strong> ne spécifie plus que la sortie. Le jeu de caractères de sortie
                           par défaut est UTF-8. Les jeux de caractères supportés sont <return>ISO-8859-1</return>,
                           <return>UTF-8</return> et <return>US-ASCII</return>.
  <info>string</info>       <strong>$separator</strong>  Avec un analyseur qui supporte les espaces de noms, les balises qui sont
                           passées aux différentes fonctions de gestion seront constituées du nom de
                           l'espace et du nom de balise, séparé par la chaîne <strong>$seperator</strong>.

<comment>Return:</comment>
  <info>XMLParser</info>  Retourne une nouvelle instance de <class>XMLParser</class>.

<comment>See Also:</comment>
   * <strong>xml_parser_create()</strong>
   * <strong>xml_parser_free()</strong>


id: xml_parser_free
type: function
doc:
<comment>Description:</comment>
  Détruit un analyseur XML
  
  Cette fonction n'a aucun effet. Antérieur à PHP 8.0.0, cette fonction était utilisé pour fermer
  une ressource.
  
  Détruit l'analyseur XML <strong>$parser</strong>.
  
  Antérieur à PHP 8.0.0, en plus d'appeler la fonction <strong>xml_parser_free()</strong> à la fin de l'analyse, il
  était nécessaire de supprimer explicitement la référence au paramètre <strong>$parser</strong> pour éviter les
  fuites mémoires, si la ressource analysé est référencé depuis un objet, et cet objet fait
  référence à la ressource analysé.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Une référence sur un analyseur XML.

<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: xml_parser_get_option
type: function
doc:
<comment>Description:</comment>
  Lit les options d'un analyseur XML
  
  Lit les options d'un analyseur XML.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Une référence sur un analyseur XML valide.
  <info>int</info>        <strong>$option</strong>  L'option demandée. <info>XML_OPTION_CASE_FOLDING</info>, <info>XML_OPTION_SKIP_TAGSTART</info>,
                      <info>XML_OPTION_SKIP_WHITE</info> et <info>XML_OPTION_TARGET_ENCODING</info> sont disponibles.
                      Reportez-vous à <strong>xml_parser_set_option()</strong> pour leurs descriptions.

<comment>Return:</comment>
  <info>string|int|bool</info>  Renvoie la valeur de l'option


id: xml_parser_set_option
type: function
doc:
<comment>Description:</comment>
  Affecte les options d'un analyseur XML
  
  Affecte les options d'un analyseur XML.

<comment>Param:</comment>
  <info>XMLParser</info>        <strong>$parser</strong>  Une référence vers un analyseur XML.
  <info>int</info>              <strong>$option</strong>  L'option à modifier. Voir ci-dessous.
                            
                            Les options suivantes sont disponibles : Options de l'analyseur
                            XMLOptionType de donnéesDescription<info>XML_OPTION_CASE_FOLDING</info>bool Contrôle
                            la gestion de la casse des balises de cet analyseur XML. Par défaut,
                            activé. <info>XML_OPTION_SKIP_TAGSTART</info>bool Spécifie combien de caractères
                            doivent être éludés du début du nom de la balise.
                            <info>XML_OPTION_SKIP_WHITE</info>entier Élude ou non les valeurs contenant des
                            caractères blancs. <info>XML_OPTION_TARGET_ENCODING</info>string Modifie le codage à
                            la cible utilisé par cet analyseur XML. Par défaut, c'est celui qui a
                            été spécifié lors de l'appel de <strong>xml_parser_create()</strong>. Les codages
                            supportés sont <return>ISO-8859-1</return>, <return>US-ASCII</return> et <return>UTF-8</return>.
  <info>string|int|bool</info>  <strong>$value</strong>   La nouvelle valeur de l'option.

<comment>Return:</comment>
  <info>bool</info>  Renvoie <info>true</info> en cas de succès ou <info>false</info> en cas d'échec.


id: xml_set_character_data_handler
type: function
doc:
<comment>Description:</comment>
  Affecte les gestionnaires de texte littéral
  
  Affecte les gestionnaires de début et de fin de l'analyseur XML <strong>$parser</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   Le parseur XML.
  <info>callable</info>   <strong>$handler</strong>  Si <info>null</info> ou une chaîne vide est passée, le gestionnaire est réinitialisé à son
                       état par défaut.
                       
                       Si <strong>$handler</strong> est un <info>callable</info>, l'appelable est défini comme le gestionnaire.
                       
                       Si <strong>$handler</strong> est une <info>string</info>, il peut s'agir du nom d'une méthode d'un objet
                       défini avec <strong>xml_set_object()</strong>.
                       
                       La signature du gestionnaire doit être :
                       <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> Le parseur XML appelant le
                       gestionnaire. <strong>$data</strong> Character data comme chaîne de caractères.
                       
                       Le parseur XML appelant le gestionnaire.
                       
                       Character data comme chaîne de caractères.
                       
                       Le gestionnaire des données est appelé pour chaque pièce du texte d'un
                       document XML. Il peut être appelé plusieurs fois dans chaque fragment (par
                       exemple pour les chaînes non-ASCII).
  <info>XMLParser</info>  <strong>$parser</strong>   Le parseur XML appelant le gestionnaire.
  <info>string</info>     <strong>$data</strong>     Character data comme chaîne de caractères.

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


id: xml_set_default_handler
type: function
doc:
<comment>Description:</comment>
  Affecte le gestionnaire XML par défaut
  
  Affecte le gestionnaire par défaut de l'analyseur XML <strong>$parser</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   Le parseur XML.
  <info>callable</info>   <strong>$handler</strong>  Si <info>null</info> ou une chaîne vide est passée, le gestionnaire est réinitialisé à son
                       état par défaut.
                       
                       Si <strong>$handler</strong> est un <info>callable</info>, l'appelable est défini comme le gestionnaire.
                       
                       Si <strong>$handler</strong> est une <info>string</info>, il peut s'agir du nom d'une méthode d'un objet
                       défini avec <strong>xml_set_object()</strong>.
                       
                       La signature du gestionnaire doit être :
                       <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> Le parseur XML appelant le
                       gestionnaire. <strong>$data</strong><strong>$data</strong> contient les caractères sous la forme d'une chaîne.
                       Cela peut être une déclaration XML, un type de document, une entité ou
                       d'autres données pour lesquelles aucun gestionnaire n'est prévu.
                       
                       Le parseur XML appelant le gestionnaire.
                       
                       <strong>$data</strong> contient les caractères sous la forme d'une chaîne. Cela peut être une
                       déclaration XML, un type de document, une entité ou d'autres données pour
                       lesquelles aucun gestionnaire n'est prévu.
  <info>XMLParser</info>  <strong>$parser</strong>   Le parseur XML appelant le gestionnaire.
  <info>string</info>     <strong>$data</strong>     <strong>$data</strong> contient les caractères sous la forme d'une chaîne. Cela peut être une
                       déclaration XML, un type de document, une entité ou d'autres données pour
                       lesquelles aucun gestionnaire n'est prévu.

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


id: xml_set_element_handler
type: function
doc:
<comment>Description:</comment>
  Affecte les gestionnaires de début et de fin de balise XML
  
  Affecte les gestionnaires de début et de fin de l'analyseur XML <strong>$parser</strong>.
  
  <strong>$start_handler</strong> est appelé quand un nouvel élément XML est ouvert. <strong>$end_handler</strong> est appelé quand un
  élément XML est fermé.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>         Le parseur XML.
  <info>callable</info>   <strong>$start_handler</strong>  Si <info>null</info> ou une chaîne vide est passée, le gestionnaire est réinitialisé
                             à son état par défaut.
                             
                             Si <strong>$handler</strong> est un <info>callable</info>, l'appelable est défini comme le
                             gestionnaire.
                             
                             Si <strong>$handler</strong> est une <info>string</info>, il peut s'agir du nom d'une méthode d'un
                             objet défini avec <strong>xml_set_object()</strong>.
                             
                             La signature du gestionnaire doit être :
                             <info>void</info>start_element_handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$name</strong><info>array</info><strong>$attributes</strong>
                             <strong>$parser</strong> Le parseur XML appelant le gestionnaire. <strong>$name</strong> Contient le nom
                             de l'élément qui a provoqué l'appel du gestionnaire. Si l'analyseur
                             gère la casse, cet élément sera en majuscules. <strong>$attributes</strong> Un tableau
                             associatif avec les attributs de l'élément. Le tableau est vide s'il
                             n'y a pas d'attributs. Les clés de ce tableau seront les noms des
                             attributs, et les valeurs seront les valeurs correspondantes des
                             attributs. Les noms des attributs seront mis en majuscules si
                             l'analyseur gère la casse. Les valeurs des attributs seront inchangées.
                             L'ordre dans lequel <strong>$attributes</strong> est traversé est identique à l'ordre
                             dans lequel les attributs ont été déclaré.
                             
                             Le parseur XML appelant le gestionnaire.
                             
                             Contient le nom de l'élément qui a provoqué l'appel du gestionnaire. Si
                             l'analyseur gère la casse, cet élément sera en majuscules.
                             
                             Un tableau associatif avec les attributs de l'élément. Le tableau est
                             vide s'il n'y a pas d'attributs. Les clés de ce tableau seront les noms
                             des attributs, et les valeurs seront les valeurs correspondantes des
                             attributs. Les noms des attributs seront mis en majuscules si
                             l'analyseur gère la casse. Les valeurs des attributs seront inchangées.
                             
                             L'ordre dans lequel <strong>$attributes</strong> est traversé est identique à l'ordre
                             dans lequel les attributs ont été déclaré.
  <info>XMLParser</info>  <strong>$parser</strong>         Le parseur XML appelant le gestionnaire.
  <info>string</info>     <strong>$name</strong>           Contient le nom de l'élément qui a provoqué l'appel du gestionnaire. Si
                             l'analyseur gère la casse, cet élément sera en majuscules.
  <info>array</info>      <strong>$attributes</strong>     Un tableau associatif avec les attributs de l'élément. Le tableau est
                             vide s'il n'y a pas d'attributs. Les clés de ce tableau seront les noms
                             des attributs, et les valeurs seront les valeurs correspondantes des
                             attributs. Les noms des attributs seront mis en majuscules si
                             l'analyseur gère la casse. Les valeurs des attributs seront inchangées.
                             
                             L'ordre dans lequel <strong>$attributes</strong> est traversé est identique à l'ordre
                             dans lequel les attributs ont été déclaré.
  <info>callable</info>   <strong>$end_handler</strong>    Si <info>null</info> ou une chaîne vide est passée, le gestionnaire est réinitialisé
                             à son état par défaut.
                             
                             Si <strong>$handler</strong> est un <info>callable</info>, l'appelable est défini comme le
                             gestionnaire.
                             
                             Si <strong>$handler</strong> est une <info>string</info>, il peut s'agir du nom d'une méthode d'un
                             objet défini avec <strong>xml_set_object()</strong>.
                             
                             La signature du gestionnaire doit être :
                             <info>void</info>end_element_handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$name</strong> <strong>$parser</strong> Le parseur
                             XML appelant le gestionnaire. <strong>$name</strong> Contient le nom de l'élément qui a
                             provoqué l'appel du gestionnaire. Si l'analyseur gère la casse, cet
                             élément sera en majuscules.
                             
                             Le parseur XML appelant le gestionnaire.
                             
                             Contient le nom de l'élément qui a provoqué l'appel du gestionnaire. Si
                             l'analyseur gère la casse, cet élément sera en majuscules.
  <info>XMLParser</info>  <strong>$parser</strong>         Le parseur XML appelant le gestionnaire.
  <info>string</info>     <strong>$name</strong>           Contient le nom de l'élément qui a provoqué l'appel du gestionnaire. Si
                             l'analyseur gère la casse, cet élément sera en majuscules.

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


id: xml_set_end_namespace_decl_handler
type: function
doc:
<comment>Description:</comment>
  Configure le gestionnaire XML de données
  
  Définit un gestionnaire à appeler lorsque l'on quitte le contexte d'un espace de noms. Il peut
  être appelé, pour chaque déclaration de l'espace de noms, après le gestionnaire de la dernière
  balise de l'élément dont l'espace de noms a été déclaré.
  
  Cet évènement n'est pas supporté sous libXML, aussi, un gestionnaire enregistré ne sera pas
  appelé.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>   Le parseur XML.
  <info>callable</info>      <strong>$handler</strong>  Si <info>null</info> ou une chaîne vide est passée, le gestionnaire est réinitialisé à
                          son état par défaut.
                          
                          Si <strong>$handler</strong> est un <info>callable</info>, l'appelable est défini comme le gestionnaire.
                          
                          Si <strong>$handler</strong> est une <info>string</info>, il peut s'agir du nom d'une méthode d'un objet
                          défini avec <strong>xml_set_object()</strong>.
                          
                          La signature du gestionnaire doit être :
                          handler<info>XMLParser</info><strong>$parser</strong><info>string</info><info>false</info></info><strong>$prefix</strong> <strong>$parser</strong> Le parseur XML appelant
                          le gestionnaire. <strong>$prefix</strong> Le préfixe est une chaîne de caractères utilisée
                          pour référencer l'espace de noms dans un objet. <info>false</info> si aucun préfixe
                          existe.
                          
                          Le parseur XML appelant le gestionnaire.
                          
                          Le préfixe est une chaîne de caractères utilisée pour référencer l'espace
                          de noms dans un objet. <info>false</info> si aucun préfixe existe.
  <info>XMLParser</info>     <strong>$parser</strong>   Le parseur XML appelant le gestionnaire.
  <info>string|false</info>  <strong>$prefix</strong>   Le préfixe est une chaîne de caractères utilisée pour référencer l'espace
                          de noms dans un objet. <info>false</info> si aucun préfixe existe.

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

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


id: xml_set_external_entity_ref_handler
type: function
doc:
<comment>Description:</comment>
  Configure le gestionnaire XML de références externes
  
  Affecte le gestionnaire d'entité externe de l'analyseur XML <strong>$parser</strong>.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>             Le parseur XML.
  <info>callable</info>      <strong>$handler</strong>            Si <info>null</info> ou une chaîne vide est passée, le gestionnaire est
                                    réinitialisé à son état par défaut.
                                    
                                    Si <strong>$handler</strong> est un <info>callable</info>, l'appelable est défini comme le
                                    gestionnaire.
                                    
                                    Si <strong>$handler</strong> est une <info>string</info>, il peut s'agir du nom d'une méthode
                                    d'un objet défini avec <strong>xml_set_object()</strong>.
                                    
                                    La signature du gestionnaire doit être :
                                    <info>bool</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$open_entity_names</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong>
                                    <strong>$parser</strong> Le parseur XML appelant le gestionnaire.
                                    <strong>$open_entity_names</strong> La liste de noms d'entités, séparés par des
                                    espaces. Ces entités sont accessibles à l'analyse par cette
                                    entité (y compris le nom de l'entité référencée). <strong>$base</strong> La
                                    racine pour la résolution de l'identifiant système (<strong>$system_id</strong>)
                                    de l'entité externe. <strong>$system_id</strong> L'identifiant système tel que
                                    spécifié dans la déclaration d'entité <strong>$public_id</strong> L'identifiant
                                    public tel que spécifié dans la déclaration d'entité, ou une
                                    chaîne vide, si aucune déclaration n'a été spécifiée. L'espace
                                    dans l'identifiant public sera normalisé comme spécifié dans les
                                    spécifications XML.
                                    
                                    Le parseur XML appelant le gestionnaire.
                                    
                                    La liste de noms d'entités, séparés par des espaces. Ces entités
                                    sont accessibles à l'analyse par cette entité (y compris le nom
                                    de l'entité référencée).
                                    
                                    La racine pour la résolution de l'identifiant système
                                    (<strong>$system_id</strong>) de l'entité externe.
                                    
                                    L'identifiant système tel que spécifié dans la déclaration
                                    d'entité
                                    
                                    L'identifiant public tel que spécifié dans la déclaration
                                    d'entité, ou une chaîne vide, si aucune déclaration n'a été
                                    spécifiée. L'espace dans l'identifiant public sera normalisé
                                    comme spécifié dans les spécifications XML.
                                    
                                    Le gestionnaire devrait retourner <info>true</info> si l'entité a été géré,
                                    sinon <info>false</info>. Quand <info>false</info> est retourné l'analyseur XML arrêtera
                                    l'analyse et <strong>xml_get_error_code()</strong> retournera
                                    <info>XML_ERROR_EXTERNAL_ENTITY_HANDLING</info>.
  <info>XMLParser</info>     <strong>$parser</strong>             Le parseur XML appelant le gestionnaire.
  <info>string</info>        <strong>$open_entity_names</strong>  La liste de noms d'entités, séparés par des espaces. Ces entités
                                    sont accessibles à l'analyse par cette entité (y compris le nom
                                    de l'entité référencée).
  <info>string|false</info>  <strong>$base</strong>               La racine pour la résolution de l'identifiant système
                                    (<strong>$system_id</strong>) de l'entité externe.
  <info>string</info>        <strong>$system_id</strong>          L'identifiant système tel que spécifié dans la déclaration
                                    d'entité
  <info>string|false</info>  <strong>$public_id</strong>          L'identifiant public tel que spécifié dans la déclaration
                                    d'entité, ou une chaîne vide, si aucune déclaration n'a été
                                    spécifiée. L'espace dans l'identifiant public sera normalisé
                                    comme spécifié dans les spécifications XML.

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


id: xml_set_notation_decl_handler
type: function
doc:
<comment>Description:</comment>
  Configure le gestionnaire XML de notations
  
  Affecte les gestionnaires de début et de fin de l'analyseur XML <strong>$parser</strong>.
  
  Une notation est une partie du DTD du document, qui a le format suivant : $name</strong>
  { <strong>$systemId</strong> | <strong>$publicId</strong>?>
  ]]> Reportez-vous à la section des spécifications XML 1.0 pour connaître les notations des entités
  externes.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>         Le parseur XML.
  <info>callable</info>      <strong>$handler</strong>        Si <info>null</info> ou une chaîne vide est passée, le gestionnaire est
                                réinitialisé à son état par défaut.
                                
                                Si <strong>$handler</strong> est un <info>callable</info>, l'appelable est défini comme le
                                gestionnaire.
                                
                                Si <strong>$handler</strong> est une <info>string</info>, il peut s'agir du nom d'une méthode d'un
                                objet défini avec <strong>xml_set_object()</strong>.
                                
                                La signature du gestionnaire doit être :
                                <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$notation_name</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong>
                                <strong>$parser</strong> Le parseur XML appelant le gestionnaire. <strong>$notation_name</strong> Le
                                nom de la notation, comme précisé dans le format de notation
                                ci-dessus. <strong>$base</strong> La racine pour la résolution de l'identifiant
                                système (<return>system_id</return>) de l'entité externe. <strong>$system_id</strong> Identifiant
                                système pour cette entité externe. <strong>$public_id</strong> Identifiant public
                                pour cette entité externe.
                                
                                Le parseur XML appelant le gestionnaire.
                                
                                Le nom de la notation, comme précisé dans le format de notation
                                ci-dessus.
                                
                                La racine pour la résolution de l'identifiant système (<return>system_id</return>) de
                                l'entité externe.
                                
                                Identifiant système pour cette entité externe.
                                
                                Identifiant public pour cette entité externe.
  <info>XMLParser</info>     <strong>$parser</strong>         Le parseur XML appelant le gestionnaire.
  <info>string</info>        <strong>$notation_name</strong>  Le nom de la notation, comme précisé dans le format de notation
                                ci-dessus.
  <info>string|false</info>  <strong>$base</strong>           La racine pour la résolution de l'identifiant système (<return>system_id</return>) de
                                l'entité externe.
  <info>string</info>        <strong>$system_id</strong>      Identifiant système pour cette entité externe.
  <info>string|false</info>  <strong>$public_id</strong>      Identifiant public pour cette entité externe.

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


id: xml_set_object
type: function
doc:
<comment>Description:</comment>
  Configure un objet comme analyseur XML
  
  Rend l'analyseur <strong>$parser</strong> utilisable depuis un objet. Toutes les méthodes de rappel, affectées par
  <strong>xml_set_element_handler()</strong>, seront les méthodes de cet objet.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>  Une référence d'analyseur XML à utiliser dans l'objet.
  <info>object</info>     <strong>$object</strong>  L'objet dans lequel nous devons utiliser l'analyseur XML.

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


id: xml_set_processing_instruction_handler
type: function
doc:
<comment>Description:</comment>
  Affecte les gestionnaires d'instructions de traitement
  
  Affecte le gestionnaire d'instructions exécutables de l'analyseur XML <strong>$parser</strong>.
  
  Une instruction de traitement a la forme suivante : 
  ]]>
  
  Le code PHP code est délimité par l'instruction de traitement <return>\<?php</return>. Ainsi, il est possible d'avoir du code PHP dans un document XML. Cependant, la balise de fin de l'instruction de traitement (<return>?&gt;</return>) ne doit pas faire partie des données. Si une balise de fin de l'instruction de traitement existe dans le code PHP imbriqué, le reste du code PHP et la "vrai" balise de fin de l'instruction de traitement, seront traité comme des données de texte.

<comment>Param:</comment>
  <info>XMLParser</info>  <strong>$parser</strong>   Le parseur XML.
  <info>callable</info>   <strong>$handler</strong>  Si <info>null</info> ou une chaîne vide est passée, le gestionnaire est réinitialisé à son
                       état par défaut.
                       
                       Si <strong>$handler</strong> est un <info>callable</info>, l'appelable est défini comme le gestionnaire.
                       
                       Si <strong>$handler</strong> est une <info>string</info>, il peut s'agir du nom d'une méthode d'un objet
                       défini avec <strong>xml_set_object()</strong>.
                       
                       La signature du gestionnaire doit être :
                       <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$target</strong><info>string</info><strong>$data</strong> <strong>$parser</strong> Le parseur XML
                       appelant le gestionnaire. <strong>$target</strong> La cible de l'instruction de traitement.
                       <strong>$data</strong> Les données de l'instruction de traitement.
                       
                       Le parseur XML appelant le gestionnaire.
                       
                       La cible de l'instruction de traitement.
                       
                       Les données de l'instruction de traitement.
  <info>XMLParser</info>  <strong>$parser</strong>   Le parseur XML appelant le gestionnaire.
  <info>string</info>     <strong>$target</strong>   La cible de l'instruction de traitement.
  <info>string</info>     <strong>$data</strong>     Les données de l'instruction de traitement.

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


id: xml_set_start_namespace_decl_handler
type: function
doc:
<comment>Description:</comment>
  Configure le gestionnaire de caractères
  
  Définit le gestionnaire à appeler lorsque l'espace de noms est déclaré. Les déclarations d'espace
  de noms surviennent dans les balises de départ. Mais le gestionnaire de départ, appelé lors de la
  déclaration de l'espace de noms, est appelé avant le gestionnaire de la balise de départ pour
  chaque espace de noms déclaré dans cette balise.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>   Le parseur XML.
  <info>callable</info>      <strong>$handler</strong>  Si <info>null</info> ou une chaîne vide est passée, le gestionnaire est réinitialisé à
                          son état par défaut.
                          
                          Si <strong>$handler</strong> est un <info>callable</info>, l'appelable est défini comme le gestionnaire.
                          
                          Si <strong>$handler</strong> est une <info>string</info>, il peut s'agir du nom d'une méthode d'un objet
                          défini avec <strong>xml_set_object()</strong>.
                          
                          La signature du gestionnaire doit être :
                          <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><info>false</info></info><strong>$prefix</strong><info>string</info><strong>$uri</strong> <strong>$parser</strong> Le parseur
                          XML appelant le gestionnaire. <strong>$prefix</strong> Le préfixe est une chaîne de
                          caractères utilisée pour référencer l'espace de noms d'un objet XML. <info>false</info>
                          si aucun préfixe n'existe. <strong>$uri</strong> Identifiant de ressource uniforme (URI)
                          d'un espace de noms.
                          
                          Le parseur XML appelant le gestionnaire.
                          
                          Le préfixe est une chaîne de caractères utilisée pour référencer l'espace
                          de noms d'un objet XML. <info>false</info> si aucun préfixe n'existe.
                          
                          Identifiant de ressource uniforme (URI) d'un espace de noms.
  <info>XMLParser</info>     <strong>$parser</strong>   Le parseur XML appelant le gestionnaire.
  <info>string|false</info>  <strong>$prefix</strong>   Le préfixe est une chaîne de caractères utilisée pour référencer l'espace
                          de noms d'un objet XML. <info>false</info> si aucun préfixe n'existe.
  <info>string</info>        <strong>$uri</strong>      Identifiant de ressource uniforme (URI) d'un espace de noms.

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

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


id: xml_set_unparsed_entity_decl_handler
type: function
doc:
<comment>Description:</comment>
  Affecte les gestionnaires d'entités non déclarées
  
  Affecte les gestionnaires d'entités non déclarées de l'analyseur XML <strong>$parser</strong>.
  
  Le gestionnaire <strong>$parser</strong> sera appelé si l'analyseur XML rencontre une déclaration d'entité externe
  avec une déclaration de NDATA, comme suit : $name</strong> {<strong>$publicId</strong> | <strong>$systemId</strong>} NDATA <strong>$notationName</strong>
  ]]>
  
  Reportez-vous à la section des spécifications XML 1.0 pour connaître les notations des entités
  externes.

<comment>Param:</comment>
  <info>XMLParser</info>     <strong>$parser</strong>         Le parseur XML.
  <info>callable</info>      <strong>$handler</strong>        Si <info>null</info> ou une chaîne vide est passée, le gestionnaire est
                                réinitialisé à son état par défaut.
                                
                                Si <strong>$handler</strong> est un <info>callable</info>, l'appelable est défini comme le
                                gestionnaire.
                                
                                Si <strong>$handler</strong> est une <info>string</info>, il peut s'agir du nom d'une méthode d'un
                                objet défini avec <strong>xml_set_object()</strong>.
                                
                                La signature du gestionnaire doit être :
                                <info>void</info>handler<info>XMLParser</info><strong>$parser</strong><info>string</info><strong>$entity_name</strong><info>string</info><info>false</info></info><strong>$base</strong><info>string</info><strong>$system_id</strong><info>string</info><info>false</info></info><strong>$public_id</strong><info>string</info><info>false</info></info><strong>$notation_name</strong>
                                <strong>$parser</strong> Le parseur XML appelant le gestionnaire. <strong>$entity_name</strong> Le nom
                                de l'entité qui va être définie. <strong>$base</strong> La racine pour la résolution
                                de l'identifiant système (<strong>$system_id</strong>) de l'entité externe.
                                <strong>$system_id</strong> Identifiant système pour cette entité externe. <strong>$public_id</strong>
                                Identifiant public pour cette entité externe. <strong>$notation_name</strong> Nom de
                                la notation de cette entité. (Voir <strong>xml_set_notation_decl_handler()</strong>).
                                
                                Le parseur XML appelant le gestionnaire.
                                
                                Le nom de l'entité qui va être définie.
                                
                                La racine pour la résolution de l'identifiant système (<strong>$system_id</strong>)
                                de l'entité externe.
                                
                                Identifiant système pour cette entité externe.
                                
                                Identifiant public pour cette entité externe.
                                
                                Nom de la notation de cette entité. (Voir
                                <strong>xml_set_notation_decl_handler()</strong>).
  <info>XMLParser</info>     <strong>$parser</strong>         Le parseur XML appelant le gestionnaire.
  <info>string</info>        <strong>$entity_name</strong>    Le nom de l'entité qui va être définie.
  <info>string|false</info>  <strong>$base</strong>           La racine pour la résolution de l'identifiant système (<strong>$system_id</strong>)
                                de l'entité externe.
  <info>string</info>        <strong>$system_id</strong>      Identifiant système pour cette entité externe.
  <info>string|false</info>  <strong>$public_id</strong>      Identifiant public pour cette entité externe.
  <info>string|false</info>  <strong>$notation_name</strong>  Nom de la notation de cette entité. (Voir
                                <strong>xml_set_notation_decl_handler()</strong>).

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


id: xmlrpc_decode
type: function
doc:
<comment>Description:</comment>
  Décode le XML en types PHP natifs
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.

<comment>Param:</comment>
  <info>string</info>  <strong>$xml</strong>       Réponse XML retournée par la méthode XMLRPC.
  <info>string</info>  <strong>$encoding</strong>  Encodage d'entrée, supporté par iconv.

<comment>Return:</comment>
  <info>mixed</info>  Retourne soit un tableau, soit un entier, soit une chaîne, soit un booléen, en fonction de
         la réponse retournée par la méthode XMLRPC.

<comment>See Also:</comment>
   * <strong>xmlrpc_encode_request()</strong>
   * <strong>xmlrpc_is_fault()</strong>


id: xmlrpc_decode_request
type: function
doc:
<comment>Description:</comment>
  Décode le code XML en variables PHP natives
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>mixed</info>  


id: xmlrpc_encode
type: function
doc:
<comment>Description:</comment>
  Génère le code XML pour une valeur PHP
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: xmlrpc_encode_request
type: function
doc:
<comment>Description:</comment>
  Génère le XML pour une méthode
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>          Nom de la méthode à appeler.
  <info>mixed</info>   <strong>$params</strong>          Paramètres de la méthode, compatibles avec la signature de la méthode.
  <info>array</info>   <strong>$output_options</strong>  Tableau spécifiant les options de sortie pouvant contenir (les valeurs
                           par défaut sont en gras) : output_type: php, xmlverbosity:
                           no_white_space, newlines_only, prettyescaping: cdata, non-ascii,
                           non-print, markup (peut être une chaîne avec une valeur ou un tableau
                           avec plusieurs valeurs)version: simple, xmlrpc, soap 1.1, autoencoding:
                           iso-8859-1, autres jeux de caractères supportés par iconv
                           
                           output_type: php, xml
                           
                           verbosity: no_white_space, newlines_only, pretty
                           
                           escaping: cdata, non-ascii, non-print, markup (peut être une chaîne avec
                           une valeur ou un tableau avec plusieurs valeurs)
                           
                           version: simple, xmlrpc, soap 1.1, auto
                           
                           encoding: iso-8859-1, autres jeux de caractères supportés par iconv

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne contenant la représentation XML de la demande.

<comment>See Also:</comment>
   * <strong>stream_context_create()</strong>
   * <strong>file_get_contents()</strong>
   * <strong>xmlrpc_decode()</strong>


id: xmlrpc_get_type
type: function
doc:
<comment>Description:</comment>
  Retourne le type XMLRPC d'une valeur PHP
  
  Particulièrement pratique pour les types chaînes de type  <return>base64</return> et <return>datetime</return>.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Valeur PHP

<comment>Return:</comment>
  <info>string</info>  Retourne le type XML-RPC.

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


id: xmlrpc_is_fault
type: function
doc:
<comment>Description:</comment>
  Détermine si un tableau de valeurs représente un XMLRPC
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.

<comment>Param:</comment>
  <info>array</info>  <strong>$arg</strong>  Tableau retourné par la fonction <strong>xmlrpc_decode()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si l'argument signifie <return>fault</return>,  <info>false</info> sinon. La description de <return>fault</return> est
        disponible dans la variable <return>$arg["faultString"]</return>, le code de <return>fault</return> est disponible dans la
        variable  <return>$arg["faultCode"]</return>.

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


id: xmlrpc_parse_method_descriptions
type: function
doc:
<comment>Description:</comment>
  Décode le code XML en une liste de descriptions de méthodes
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>array</info>  


id: xmlrpc_server_add_introspection_data
type: function
doc:
<comment>Description:</comment>
  Ajoute des données d'introspection
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: xmlrpc_server_call_method
type: function
doc:
<comment>Description:</comment>
  Analyse une requête XML et appelle les méthodes associées
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: xmlrpc_server_create
type: function
doc:
<comment>Description:</comment>
  Crée un serveur XMLRPC
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: xmlrpc_server_destroy
type: function
doc:
<comment>Description:</comment>
  Détruit un serveur XMLRPC
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: xmlrpc_server_register_introspection_callback
type: function
doc:
<comment>Description:</comment>
  Enregistre une fonction PHP pour générer la documentation
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: xmlrpc_server_register_method
type: function
doc:
<comment>Description:</comment>
  Enregistre une fonction PHP avec une méthode
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: xmlrpc_set_type
type: function
doc:
<comment>Description:</comment>
  Définit le type xmlrpc, base64 ou datetime, d'une valeur PHP
  
  <strong>xmlrpc_set_type()</strong> définit le type XMLRPC,  <return>base64</return> ou <return>datetime</return>, pour une chaîne PHP.
  
  Cette fonction est EXPERIMENTALE. Le comportement de cette fonction, son nom, et toute la
  documentation autour de cette fonction peut changer sans préavis dans une prochaine version de
  PHP. Cette fonction doit être utilisée à vos risques et périls.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Valeur dont on veut modifier le type
  <info>string</info>  <strong>$type</strong>   <return>base64</return> ou <return>datetime</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. En cas de
        réussite, <strong>$value</strong> sera converti en objet.


id: yaml_emit
type: function
doc:
<comment>Description:</comment>
  Retourne une chaîne représentant une valeur YAML
  
  Génère une représentation YAML de la donnée <strong>$data</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$data</strong>       Les données à encoder. Peut être de tout type sauf <info>resource</info>.
  <info>int</info>    <strong>$encoding</strong>   Encodage des caractères en sortie choisi parmi <info>YAML_ANY_ENCODING</info>,
                     <info>YAML_UTF8_ENCODING</info>, <info>YAML_UTF16LE_ENCODING</info>, <info>YAML_UTF16BE_ENCODING</info>.
  <info>int</info>    <strong>$linebreak</strong>  Caractère de fin de ligne choisi parmi <info>YAML_ANY_BREAK</info>, <info>YAML_CR_BREAK</info>,
                     <info>YAML_LN_BREAK</info>, <info>YAML_CRLN_BREAK</info>.
  <info>array</info>  <strong>$callbacks</strong>  Gestionnaires de contenu pour l'émission de nœud YAML. Doit être un tableau
                     associatif de paires "nom de classe" =&gt; <info>callable</info>. Voir l'émission de
                     fonctions de rappel pour plus de détails.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne YAML en cas de succès.

<comment>See Also:</comment>
   * <strong>yaml_emit_file()</strong>
   * <strong>yaml_parse()</strong>


id: yaml_emit_file
type: function
doc:
<comment>Description:</comment>
  Envoie une représentation YAML vers un fichier
  
  Génère une représentation YAML de la donnée <strong>$data</strong> dans le fichier <strong>$filename</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>   Chemin vers un fichier.
  <info>mixed</info>   <strong>$data</strong>       Donnée à encoder. Peut être de tout type sauf <info>resource</info>.
  <info>int</info>     <strong>$encoding</strong>   Encodage des caractères en sortie choisi parmi <info>YAML_ANY_ENCODING</info>,
                      <info>YAML_UTF8_ENCODING</info>, <info>YAML_UTF16LE_ENCODING</info>, <info>YAML_UTF16BE_ENCODING</info>.
  <info>int</info>     <strong>$linebreak</strong>  Caractère de fin de ligne choisi parmi <info>YAML_ANY_BREAK</info>, <info>YAML_CR_BREAK</info>,
                      <info>YAML_LN_BREAK</info>, <info>YAML_CRLN_BREAK</info>.
  <info>array</info>   <strong>$callbacks</strong>  Gestionnaires de contenu pour l'émission de nœud YAML. Doit être un tableau
                      associatif de paires "nom de classe" =&gt; <info>callable</info>. Voir l'émission de
                      fonctions de rappel pour plus de détails.

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

<comment>See Also:</comment>
   * <strong>yaml_emit()</strong>
   * <strong>yaml_parse()</strong>


id: yaml_parse
type: function
doc:
<comment>Description:</comment>
  Analyse un flux YAML
  
  Convertit tout ou partie d'un document YAML provenant d'une chaîne vers une variable PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$input</strong>      La chaîne à analyser comme document YAML.
  <info>int</info>     <strong>$pos</strong>        Le document à extraire du flux (<return>-1</return> pour tous les documents, <return>0</return> pour le premier,
                      ...).
  <info>int</info>     <strong>$ndocs</strong>      Si le paramètre <strong>$ndocs</strong> est fourni, alors il est rempli avec le nombre de
                      documents trouvés dans le flux.
  <info>array</info>   <strong>$callbacks</strong>  Analyseurs de contenu pour les nœuds YAML. Tableau associatif tag YAML =&gt;
                      <info>callable</info>. Voir l'analyse des fonctions de rappel pour plus d'informations.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur encodée de <strong>$input</strong> dans le type PHP approprié ou <info>false</info> si une erreur
         survient. Si <strong>$pos</strong> vaut <return>-1</return>, un tableau sera retourné avec pour chaque valeur un document
         trouvé dans le flux.

<comment>See Also:</comment>
   * <strong>yaml_parse_file()</strong>
   * <strong>yaml_parse_url()</strong>
   * <strong>yaml_emit()</strong>


id: yaml_parse_file
type: function
doc:
<comment>Description:</comment>
  Analyse un flux YAML depuis un fichier
  
  Convertit tout ou partie d'un document YAML provenant d'un fichier vers une variable PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>   Chemin vers le fichier.
  <info>int</info>     <strong>$pos</strong>        Le document à extraire du flux (<return>-1</return> pour tous les documents, <return>0</return> pour le premier,
                      ...).
  <info>int</info>     <strong>$ndocs</strong>      Si <strong>$ndocs</strong> est fourni, alors il est rempli avec le nombre de documents trouvés
                      dans le flux.
  <info>array</info>   <strong>$callbacks</strong>  Analyseurs de contenu pour les nœuds YAML. Tableau associatif tag YAML =&gt;
                      <info>callable</info>. Voir l'analyse des fonctions de rappel pour plus de détails.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur encodée de <strong>$filename</strong> dans le type PHP approprié ou <info>false</info> si une erreur
         survient. Si <strong>$pos</strong> vaut <return>-1</return> un tableau sera retourné avec pour chaque valeur, un document
         trouvé dans le flux.

<comment>See Also:</comment>
   * <strong>yaml_parse()</strong>
   * <strong>yaml_parse_url()</strong>
   * <strong>yaml_emit()</strong>


id: yaml_parse_url
type: function
doc:
<comment>Description:</comment>
  Analyse un flux YAML depuis une URL
  
  Convertit tout ou partie d'un document YAML provenant d'une URL vers une variable PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>        <strong>$url</strong> doit être de la forme "scheme://...". PHP cherchera le protocole pour
                      cette URL. Si aucun protocole n'a été enregistré pour ce flux, PHP émettra une
                      notice pour vous aider à trouver le problème et continuera.
  <info>int</info>     <strong>$pos</strong>        Le document à extraire du flux (<return>-1</return> pour tous les documents, <return>0</return> pour le premier,
                      ...).
  <info>int</info>     <strong>$ndocs</strong>      Si <strong>$ndocs</strong> est fourni, alors il est rempli avec le nombre de documents trouvés
                      dans le flux.
  <info>array</info>   <strong>$callbacks</strong>  Analyseurs de contenu pour les nœuds YAML. Tableau associatif tag YAML =&gt;
                      <info>callable</info>. Voir l'analyse des fonctions de rappel pour plus d'informations.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur encodée de <strong>$url</strong> dans le type PHP approprié ou <info>false</info> si une erreur
         survient. Si <strong>$pos</strong> vaut <return>-1</return>, un tableau sera retourné avec pour chaque valeur, un document
         trouvé dans le flux.

<comment>See Also:</comment>
   * <strong>yaml_parse()</strong>
   * <strong>yaml_parse_file()</strong>
   * <strong>yaml_emit()</strong>


id: yaz_addinfo
type: function
doc:
<comment>Description:</comment>
  Retourne plus de détails après une erreur
  
  Retourne plus de détails après une erreur pour la dernière requête sur le serveur.
  
  Avec certains serveurs, cette fonction peut retourner la même chaîne de caractères que la fonction
  <strong>yaz_error()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  La ressource de connexion retournée par <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  Une chaîne de caractères contenant des informations additionnelles ou une chaîne de
          caractères vide si la dernière opération était réussie ou si aucune information
          additionnelle n'était fournie par le serveur.

<comment>See Also:</comment>
   * <strong>yaz_error()</strong>
   * <strong>yaz_errno()</strong>


id: yaz_ccl_conf
type: function
doc:
<comment>Description:</comment>
  Configure l'analyseur CCL
  
  Cette fonction configure l'analyseur CCL de requête pour un serveur avec les définitions de points
  d'accès (CCL qualifiers) et leur équivalent en RPN.
  
  Pour faire correspondre une requête CCL spécifique à RPN, utilisez la fonction <strong>yaz_ccl_parse()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$config</strong>  Un tableau de configuration. Chaque clé du tableau est le nom du champ CCL et
                     la valeur correspondante contient une chaîne de caractères qui spécifie la
                     correspondance au RPN.
                     
                     La correspondance est une séquence de paires d'attributs type et d'attributs
                     valeur. L'attribut type et l'attribut valeur sont séparés par un signe égal
                     (<return>=</return>). Chaque paire est séparée par un espace.
                     
                     Des informations supplémentaires peuvent être trouvées sur la page CCL.

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

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


id: yaz_ccl_parse
type: function
doc:
<comment>Description:</comment>
  Appelle l'analyseur CCL
  
  Cette fonction appelle l'analyseur CCL. Il convertit une requête CCL FIND en une requête RPN qui
  peut être passée à <strong>yaz_search()</strong> pour effectuer une recherche.
  
  Pour définir un champ CCL valide, utilisez la fonction <strong>yaz_ccl_conf()</strong> avant d'utiliser cette
  fonction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$query</strong>   La requête CCL FIND.
  <info>array</info>     <strong>$result</strong>  Si la fonction a été exécutée correctement, cet argument sera un tableau
                     contenant la requête RPN valide sous la clé <return>rpn</return>.
                     
                     Lors d'un échec, trois index sont écrits dans ce tableau pour indiquer la cause
                     de l'échec : <return>errorcode</return> - le code d'erreur CCL (entier) <return>errorstring</return> - l'erreur
                     CCL en chaîne de caractères <return>errorpos</return> - position approximée dans la requête qui
                     est en échec (entier qui est la position d'un caractère)
                     
                     <return>errorcode</return> - le code d'erreur CCL (entier)
                     
                     <return>errorstring</return> - l'erreur CCL en chaîne de caractères
                     
                     <return>errorpos</return> - position approximée dans la requête qui est en échec (entier qui est
                     la position d'un caractère)

<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: yaz_close
type: function
doc:
<comment>Description:</comment>
  Ferme une connexion YAZ
  
  Ferme la connexion donnée par le paramètre <strong>$id</strong>.
  
  Cette fonction fermera seulement une connexion non persistante ouverte en mettant l'option
  <return>persistent</return> à <info>false</info> avec <strong>yaz_connect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  La ressource de connexion retournée par <strong>yaz_connect()</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>yaz_connect()</strong>


id: yaz_connect
type: function
doc:
<comment>Description:</comment>
  Prépare une connexion à un serveur Z39.50
  
  Cette fonction retourne une ressource de connexion en cas de succès et <return>0</return> en cas d'échec.
  
  <strong>yaz_connect()</strong> prépare une connexion à un serveur Z39.50. Cette fonction n'est pas bloquante, et ne
  tente pas d'établir une connexion. En fait, elle ne fait que préparer la connexion pour exécution
  ultérieure par <strong>yaz_wait()</strong>.
  
  Le proxy YAZ est un proxy Z39.50 librement disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$zurl</strong>     Une chaîne de caractères qui prend la forme <return>host[:port][/database]</return>. Si le port
                    est omis, le port 210 est utilisé. Si la base de données est omise, <return>Default</return> est
                    utilisée.
  <info>mixed</info>   <strong>$options</strong>  Si donné comme une chaîne de caractères, cela sera traité comme la chaîne
                    d'authentification Z39.50 V2 (OpenAuth).
                    
                    Si donné comme un tableau, le contenu du tableau sert en tant qu'options. user
                    Utilisateur pour authentification. group Groupe pour authentification. password
                    Mot de passe pour authentification. cookie Cookie pour session (proxy YAZ).
                    proxy Proxy pour connexion (proxy YAZ). persistent Un booléen. Si <info>true</info> la
                    connexion est persistante; Si <info>false</info> la connexion n'est pas persistante. Par
                    défaut les connexions sont persistantes.  Si vous ouvrez une connexion
                    persistante, vous ne serez pas capable de la fermer plus tard avec <strong>yaz_close()</strong>.
                    piggyback Un booléen. Si <info>true</info> piggyback est activé pour les recherches. Si <info>false</info>
                    piggyback est désactivé. Par défaut piggyback est activé.  L'activation de
                    piggyback est plus efficace : il sauvegarde habituellement les allers-retours du
                    réseau pour les premières lectures de résultats. Cependant, quelque serveurs
                    Z39.50 ne supportent pas piggyback ou ils ignorent ce jeu de noms. Pour ceux-ci,
                    piggyback devrait être désactivé. charset Une chaîne de caractères qui spécifie
                    le jeu de caractères qui sera utilisé dans le langage Z39.50 et le jeu de
                    caractères pour les négociations. Utilisez une chaîne de caractères comme :
                    <return>ISO-8859-1</return>, <return>UTF-8</return>, <return>UTF-16</return>.  La plupart des serveurs Z39.50 ne supportent pas
                    cette option (et, pour ceux-ci, cet argument est ignoré). Plusieurs serveurs
                    utilisent l'encodage ISO-8859-1 pour les requêtes et les messages. Les
                    enregistrements MARC21/USMARC ne sont pas affectés par cette configuration.
                    preferredMessageSize Un entier qui spécifie la taille maximale en octets pour
                    toutes les entrées qui seront retournées par la cible durant la récupération.
                    Voyez le standard Z39.50 pour plus d'informations.  Cette option est supportée
                    dans PECL YAZ 1.0.5 ou supérieure. maximumRecordSize Un entier qui spécifie la
                    taille maximale en octets pour une seule entrée qui sera retournée par la cible
                    durant la récupération. Cette entité est référée à Exceptional-record-size dans
                    le standard Z39.50.  Cette option est supportée dans PECL YAZ 1.0.5 ou
                    supérieure.
                    
                    Utilisateur pour authentification.
                    
                    Groupe pour authentification.
                    
                    Mot de passe pour authentification.
                    
                    Cookie pour session (proxy YAZ).
                    
                    Proxy pour connexion (proxy YAZ).
                    
                    Un booléen. Si <info>true</info> la connexion est persistante; Si <info>false</info> la connexion n'est
                    pas persistante. Par défaut les connexions sont persistantes.
                    
                    Si vous ouvrez une connexion persistante, vous ne serez pas capable de la fermer
                    plus tard avec <strong>yaz_close()</strong>.
                    
                    Un booléen. Si <info>true</info> piggyback est activé pour les recherches. Si <info>false</info> piggyback
                    est désactivé. Par défaut piggyback est activé.
                    
                    L'activation de piggyback est plus efficace : il sauvegarde habituellement les
                    allers-retours du réseau pour les premières lectures de résultats. Cependant,
                    quelque serveurs Z39.50 ne supportent pas piggyback ou ils ignorent ce jeu de
                    noms. Pour ceux-ci, piggyback devrait être désactivé.
                    
                    Une chaîne de caractères qui spécifie le jeu de caractères qui sera utilisé dans
                    le langage Z39.50 et le jeu de caractères pour les négociations. Utilisez une
                    chaîne de caractères comme : <return>ISO-8859-1</return>, <return>UTF-8</return>, <return>UTF-16</return>.
                    
                    La plupart des serveurs Z39.50 ne supportent pas cette option (et, pour ceux-ci,
                    cet argument est ignoré). Plusieurs serveurs utilisent l'encodage ISO-8859-1
                    pour les requêtes et les messages. Les enregistrements MARC21/USMARC ne sont pas
                    affectés par cette configuration.
                    
                    Un entier qui spécifie la taille maximale en octets pour toutes les entrées qui
                    seront retournées par la cible durant la récupération. Voyez le standard Z39.50
                    pour plus d'informations.
                    
                    Cette option est supportée dans PECL YAZ 1.0.5 ou supérieure.
                    
                    Un entier qui spécifie la taille maximale en octets pour une seule entrée qui
                    sera retournée par la cible durant la récupération. Cette entité est référée à
                    Exceptional-record-size dans le standard Z39.50.
                    
                    Cette option est supportée dans PECL YAZ 1.0.5 ou supérieure.

<comment>Return:</comment>
  <info>mixed</info>  Une ressource de connexion en cas de réussite, <info>false</info> en cas d'erreur.

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


id: yaz_database
type: function
doc:
<comment>Description:</comment>
  Spécifie la base d'une session YAZ
    
  
  Cette fonction vous permet de changer de base de données à l'intérieur de la session en spécifiant
  une ou plusieurs bases de données à utiliser dans la recherche, récupération de données, etc.
  Écrase les bases de données spécifiées dans l'appel de <strong>yaz_connect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>         La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$databases</strong>  Une chaîne de caractères contenant une ou plusieurs bases de données.
                        Plusieurs bases de données sont séparées par un signe plus <return>+</return>.

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


id: yaz_element
type: function
doc:
<comment>Description:</comment>
  Spécifie le type d'éléments YAZ à lire
    
  
  Cette fonction spécifie le type d'éléments à lire.
  
  Appelez cette fonction avant <strong>yaz_search()</strong> ou <strong>yaz_present()</strong> pour spécifier un type d'élément pour
  les enregistrements à récupérer.
  
  Si cette fonction semble sans effet, voyez la description de l'option <return>piggybacking</return> dans
  <strong>yaz_connect()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>          La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$elementset</strong>  La plupart des serveurs supportent <return>F</return> (pour les enregistrements complets) et
                         <return>B</return> (pour les enregistrements brefs).

<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: yaz_errno
type: function
doc:
<comment>Description:</comment>
  Retourne le numéro d'erreur
  
  Retourne un numéro d'erreur pour le serveur (dernière requête) identifié par <strong>$id</strong>.
  
  <strong>yaz_errno()</strong> devrait être appelée après chaque requête pour chaque serveur - (après le retour de
  <strong>yaz_wait()</strong>) pour déterminer le succès ou l'échec de la dernière opération (c'est-à-dire la
  recherche).

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  La ressource de connexion retournée par <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>int</info>  Retourne un code d'erreur. Le code d'erreur est soit un code diagnostique Z39.50
       (habituellement un diagnostique Bib-1), soit un code d'erreur côté client qui est généré par
       PHP/YAZ lui-même, par exemple  <return>"Connection failed"</return>, <return>"Init Rejected"</return>, etc.

<comment>See Also:</comment>
   * <strong>yaz_error()</strong>
   * <strong>yaz_addinfo()</strong>


id: yaz_error
type: function
doc:
<comment>Description:</comment>
  Retourne une description de l'erreur
  
  <strong>yaz_error()</strong> retourne un message d'erreur en anglais correspondant au dernier numéro d'erreur
  retourné par <strong>yaz_errno()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  La ressource de connexion retournée par <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retourne un message d'erreur pour le serveur (dernière requête), identifié par le
          paramètre <strong>$id</strong>. Une chaîne de caractères vide est retournée si la dernière opération était
          réussie.

<comment>See Also:</comment>
   * <strong>yaz_errno()</strong>
   * <strong>yaz_addinfo()</strong>


id: yaz_es
type: function
doc:
<comment>Description:</comment>
  Prépare pour une Requête de Service Étendu
  
  Cette fonction prépare pour une Requête de Service Étendu. Les Services Étendus sont de la famille
  des nombreux Z39.50,  comme <return>"Record Update"</return>, <return>"Item Order"</return>, <return>"Database administration"</return>, etc.
  
  Il existe des serveurs Z39.50 qui ne supportent pas les Services Étendus.
  
  La fonction <strong>yaz_es()</strong> crée des paquets d'une Requête de Service Étendu et les place dans une file
  d'attente d'opérations. Utilisez <strong>yaz_wait()</strong> pour envoyer la/les requête(s) au serveur. À la fin de
  <strong>yaz_wait()</strong>, le résultat de l'opération de Service Étendu devrait être obtenu avec un appel à
  <strong>yaz_es_result()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>  Une chaîne de caractères représentant le type de Service Étendu : <return>itemorder</return> (Item
                   Order), <return>create</return> (Create Database), <return>drop</return> (Drop Database), <return>commit</return> (Commit
                   Operation), <return>update</return> (Update Record), <return>xmlupdate</return> (XML Update). Chaque type est
                   spécifié dans la section suivante.
  <info>array</info>     <strong>$args</strong>  Un tableau avec les options de service étendu et les options spécifiques du
                   paquet. Les options sont identiques à celles offertes par l'API C de ZOOM C.
                   Reportez-vous à ZOOM Services Étendus.

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

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


id: yaz_es_result
type: function
doc:
<comment>Description:</comment>
  Inspecte le résultat d'un service étendu
    
  
  Cette fonction inspecte le dernier résultat d'un service étendu depuis un serveur. Un service
  étendu est initié par la fonction <strong>yaz_item_order()</strong> ou la fonction <strong>yaz_es()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  La ressource de connexion retournée par <strong>yaz_connect()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau avec l'élément <return>targetReference</return> pour la référence pour l'opération de
         service étendu (généré et retourné depuis le serveur).

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


id: yaz_get_option
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur d'une option de connexion YAZ
  
  Retourne la valeur de l'option spécifiée par <strong>$name</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$name</strong>  Le nom de l'option.

<comment>Return:</comment>
  <info>string</info>  Retourne la valeur de l'option spécifiée ou une chaîne de caractères vide si l'option
          n'était pas définie.

<comment>See Also:</comment>
   * 
     La description de <strong>yaz_set_option()</strong> pour les options
     disponibles
    


id: yaz_hits
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de résultats de la dernière recherche
    
  
  <strong>yaz_hits()</strong> retourne le nombre de résultats de la dernière recherche.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>            La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$searchresult</strong>  Tableau de résultats pour des informations de résultats de recherche
                           détaillés.

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de résultats pour la dernière recherche ou 0 si aucune recherche n'a été
       effectuée.
       
       Le tableau de résultats de recherche (s'il est fourni) contient des informations qui sont
       retournées par un serveur Z39.50 dans le format SearchResult-1 d'une réponse de recherche. Le
       format SearchResult-1 peut être utilisé pour obtenir des informations à propos du nombre de
       résultats pour des parties de requête (sous-requête). En particulier, il est possible
       d'obtenir le nombre de résultats pour les termes de recherche individuels dans une requête.
       L'information pour la première sous-requête est dans $array[0], la seconde sous-requête dans
       $array[1] et ainsi de suite.
       
       Le service de SearchResult requiert PECL YAZ 1.0.5 ou supérieur et YAZ 2.1.9 ou supérieur.
       
       Très peu d'implémentations de Z39.50 supportent le service de SearchResult.


id: yaz_itemorder
type: function
doc:
<comment>Description:</comment>
  Prépare une requête Z39.50 Item Order avec le paquet ILL-Request
    
  
  Cette fonction prépare une requête de type "Extended Services" en utilisant le <return>"Profile"</return> avec <return>
  "Use of Z39.50 Item Order Extended Service to Transport ILL (Profile/1)"</return>.  Reportez-vous ici ou
  aux spécifications.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>    La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$args</strong>  Doit être un tableau associatif avec les informations à propos de l'ordre des
                   items des requêtes qui seront envoyées. La clé du tableau est le nom du chemin
                   tag ASN.1 correspondant. Par exemple, le ISBN sous le Item-ID a la clé
                   item-id,ISBN.
                   
                   Les paramètres de requête IIL sont :
                   
                   Il y a aussi quelques paramètres du paquet Extended Services Request et ItemOrder
                   :

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


id: yaz_present
type: function
doc:
<comment>Description:</comment>
  Prépare à la lecture (Z39.50 present)
  
  Cette fonction prépare PHP à la lecture des résultats, après une recherche.
  
  La fonction <strong>yaz_range()</strong> doit être appelée avant celle-ci pour spécifier la plage de résultats à
  lire.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>  La ressource de connexion retournée par <strong>yaz_connect()</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: yaz_range
type: function
doc:
<comment>Description:</comment>
  Spécifie le nombre maximal de résultats à lire
    
  
  Spécifie le nombre maximal de résultat à lire.
  
  Cette fonction doit être appelée avant la fonction <strong>yaz_search()</strong> ou <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>int</info>       <strong>$start</strong>   Spécifie la position du premier enregistrement à récupérer. Les numéros des
                     requêtes vont de 1 à <strong>yaz_hits()</strong>.
  <info>int</info>       <strong>$number</strong>  Spécifie le nombre d'enregistrements qui doivent être récupérés.

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


id: yaz_record
type: function
doc:
<comment>Description:</comment>
  Retourne un résultat
  
  La fonction <strong>yaz_record()</strong> retourne un enregistrement dans le jeu de résultats courant à la position
  spécifiée par le paramètre <strong>$pos</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>int</info>       <strong>$pos</strong>     La position de l'enregistrement. Les positions des enregistrements dans un jeu
                     de résultats sont numérotés de 1 jusqu'au  nombre retourné par <strong>yaz_hits()</strong>.
  <info>string</info>    <strong>$type</strong>    Le <strong>$type</strong> spécifie la forme du résultat retourné.
                     
                     C'est l'application qui est responsable pour s'assurer que les résultats
                     retournés à partir du serveur Z39.50/SRW sont dans un format correct. Le type
                     donné spécifie seulement une conversion qui doit avoir lieu sur le côté client
                     (dans PHP/YAZ).
                     
                     Sans compter la conversion du transfert de résultats de chaîne de caractères en
                     tableau, PHP/YAZ est aussi possible d'effectuer une conversion de jeu de
                     caractères du résultat. En particulier pour USMARC/MARC21 qui est recommandé
                     puisque ces résultats sont normalement retournés dans le jeu de caractères
                     MARC-8 qui n'est pas supporté par les navigateurs, etc. Pour spécifier une
                     conversion, ajoutez <return>; charset=</return>from<return>,</return> to ou from est le jeu de caractères orignal
                     du résultat et to est le jeu de résultats à obtenir (comme vu par PHP).
                     
                     L'enregistrement est retourné comme une chaîne de caractères pour affichage
                     simple. Dans ce mode, tous les enregistrements MARC sont convertis dans un
                     format ligne par ligne puisque ISO2709 est difficile à lire. Les
                     enregistrements XML et SUTRS sont retournés dans leur format original. GRS-1
                     est retourné dans un format ligne par ligne (<return>laid</return>).
                     
                     Ce format est approprié si les enregistrements seront affichés rapidement (pour
                     déboguage) ou parce que ce n'est pas faisable d'effectuer un affichage
                     approprié.
                     
                     L'enregistrement est retourné comme une chaîne de caractères XML si possible.
                     Dans ce mode, tous les enregistrements MARC sont convertis en MARCXML. Les
                     enregistrements XML et SUTRS sont retournés dans leur format original. GRS-1
                     n'est pas supporté.
                     
                     Ce format est similaire à <strong>$string</strong> à l'exception que les enregistrements MARC
                     sont convertis en MARCXML
                     
                     Ce format est approprié si les enregistrements sont analysés par la suite par
                     un analyseur XML ou un processeur XSLT.
                     
                     L'enregistrement est retourné comme une chaîne de caractères dans sa forme
                     originale. Ce type est approprié pour MARC, XML et SUTRS. Il ne fonctionne pas
                     pour GRS-1.
                     
                     Les enregistrements MARC sont retournés comme une chaîne de caractères ISO2709.
                     XML et SUTRS sont retournés comme des chaînes de caractères.
                     
                     La syntaxe de l'enregistrement est retournée comme une chaîne de caractères,
                     par exemple <return>USmarc</return>, <return>GRS-1</return>, <return>XML</return>, etc.
                     
                     Le nom de la base de données associée aux résultats à la position est retourné
                     comme une chaîne de caractères.
                     
                     L'enregistrement est retourné comme un tableau qui réfléchit la structure
                     GRS-1. Ce type est approprié pour MARC et GRS-1. XML, SUTRS ne sont pas
                     supportés et, si l'enregistrement actuel est XML ou SUTRS, une chaîne de
                     caractères vide sera retournée.
                     
                     Le tableau retourné consiste en une liste correspondant à chaque feuille/nœud
                     interne de GRS-1. Chaque item de la liste consiste à une sous-liste avec le
                     premier élément path et data (si les données sont disponibles).
                     
                     Le chemin, qui est une chaîne de caractères, contient une liste de chaque
                     composant de l'arbre (de la structure des enregistrements GRS-1) depuis la
                     racine vers l'extrémité. Chaque composant est une paire de type de
                     balise/valeur sous la forme <return>(</return>type<return>,</return> value
                     
                     Les balises de chaîne de caractères ont normalement une correspondance avec le
                     type tag 3. MARC peut aussi être retourné comme un tableau (ils sont convertis
                     en GRS-1 de manière interne).
  <info></info>          <strong>$string</strong>  L'enregistrement est retourné comme une chaîne de caractères XML si possible.
                     Dans ce mode, tous les enregistrements MARC sont convertis en MARCXML. Les
                     enregistrements XML et SUTRS sont retournés dans leur format original. GRS-1
                     n'est pas supporté.
                     
                     Ce format est similaire à <strong>$string</strong> à l'exception que les enregistrements MARC
                     sont convertis en MARCXML
                     
                     Ce format est approprié si les enregistrements sont analysés par la suite par
                     un analyseur XML ou un processeur XSLT.

<comment>Return:</comment>
  <info>string</info>  Retourne l'enregistrement à la position <strong>$pos</strong> ou une chaîne vide si aucun enregistrement
          n'existe à la position donnée.
          
          Si aucun enregistrement de base de données n'existe à la position donnée une chaîne vide
          est retournée.


id: yaz_scan
type: function
doc:
<comment>Description:</comment>
  Prépare un scan YAZ
  
  <strong>yaz_scan()</strong> prépare une requête  <return>"Z39.50 Scan Request"</return> sur la connexion YAZ spécifiée.
  
  Pour réellement transférer la requête <return>"Scan Request"</return> au serveur et recevoir le <return>"Scan Response"</return>,
  la fonction <strong>yaz_wait()</strong> doit être appelée.  Après la fin de <strong>yaz_wait()</strong>, appelez <strong>yaz_error()</strong> et
  <strong>yaz_scan_result()</strong> pour connaître la réponse.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>         La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>       Actuellement seulement le type <return>rpn</return> est supporté.
  <info>string</info>    <strong>$startterm</strong>  Point de départ du scan.
                        
                        La forme dans laquelle le terme de départ est spécifié est donnée par le
                        paramètre <strong>$type</strong>.
                        
                        La syntaxe de ce paramètre est similaire à la requête RPN comme décrite dans
                        <strong>yaz_search()</strong>. Cela consiste à aucune ou plusieurs spécifications d'opérateur
                        <return>@attr</return>, ensuite suivies par exactement une seule marque.
  <info>array</info>     <strong>$flags</strong>      Ce paramètre optionnel spécifie des informations supplémentaires pour
                        contrôler le comportement de la requête de scan. Trois index sont
                        actuellement lus à partir du tableau d'options : <return>number</return> (nombre de termes
                        demandés), <return>position</return> (position préférée du terme) et <return>stepSize</return> (grandeur de
                        pas préférée).

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


id: yaz_scan_result
type: function
doc:
<comment>Description:</comment>
  Retourne le résultat d'un scan
  
  <strong>yaz_scan_result()</strong> retourne un tableau contenant les termes reçus de l'hôte, lors de la dernière
  requête de scan.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>array</info>     <strong>$result</strong>  Si donné, ce tableau sera modifié pour contenir des informations additionnelles
                     prises à partir de la réponse Scan : <return>number</return> - Nombre d'entrées retournées
                     <return>stepsize</return> - Grandeur de pas <return>position</return> - Position du terme <return>status</return> - Statut du scan
                     
                     <return>number</return> - Nombre d'entrées retournées
                     
                     <return>stepsize</return> - Grandeur de pas
                     
                     <return>position</return> - Position du terme
                     
                     <return>status</return> - Statut du scan

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau (0..n-1) où n est le nombre de termes retournés. Chaque valeur est une
         paire où le premier item est un terme et le second item est un le nombre de résultats.


id: yaz_schema
type: function
doc:
<comment>Description:</comment>
  Spécifie le schéma de lecture
  
  <strong>yaz_schema()</strong> spécifie le schéma de lecture.
  
  cette fonction devrait être appelée avant <strong>yaz_search()</strong> ou <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$schema</strong>  Doit être spécifié comme un OID (Object Identifier) dans une notation par point
                     brut (comme <return>1.2.840.10003.13.4</return>) ou comme un des schémas connus enregistrés :
                     <return>GILS-schema</return>, <return>Holdings</return>, <return>Zthes</return>, ...

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


id: yaz_search
type: function
doc:
<comment>Description:</comment>
  Prépare une recherche
  
  <strong>yaz_search()</strong> prépare une recherche sur la connexion donnée
  
  Comme pour <strong>yaz_connect()</strong>, cette fonction n'est pas bloquante et ne fait que préparer la recherche
  pour exécution ultérieure lorsque <strong>yaz_wait()</strong> est appelée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>     La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$type</strong>   Ce paramètre représente le type de requête - seul <return>"rpn"</return> est supporté
                    actuellement et, dans ce cas, le troisième argument est un préfixe de notation
                    de requête utilisé par YAZ.
  <info>string</info>    <strong>$query</strong>  Les requêtes RPN sont des représentations textuelles des requêtes de type
                    Type-1, comme défini dans le standard Z39.50. Cependant, dans la représentation
                    textuelle utilisée par YAZ, une notation à préfixe est utilisée, c'est-à-dire
                    que l'opérateur précède l'opérande. La chaîne de requête est une séquence de
                    mots réservés, où les espaces sont ignorés, à moins qu'ils n'aient été mis entre
                    guillemets doubles. Les mots réservés qui commencent par un arobase (<return>@</return>) sont
                    considérés comme des opérateurs et traités comme tels.
                    
                    Vous pouvez trouver des informations sur les attributs sur le site Z39.50
                    Maintenance Agency.
                    
                    Dans le cas où vous voudriez utiliser une notation plus facile, utilisez
                    l'analyseur CCL - fonctions <strong>yaz_ccl_conf()</strong> et <strong>yaz_ccl_parse()</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: yaz_set_option
type: function
doc:
<comment>Description:</comment>
  Modifie une ou plusieurs options de connexion YAZ
  
  Modifie une ou plusieurs options sur la connexion donnée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>     La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$name</strong>   Peut être soit une chaîne de caractères ou un tableau.
                    
                    Si donné comme chaîne de caractères, cela sera le nom de l'option à spécifier.
                    Vous devrez donner sa valeur <strong>$value</strong>.
                    
                    Si donné comme tableau, cela sera un tableau associatif (nom de l'option =&gt;
                    valeur de l'option).
  <info>string</info>    <strong>$value</strong>  La nouvelle valeur de l'option. Utilisez cet argument seulement si l'argument
                    précédent est une chaîne de caractères.

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


id: yaz_sort
type: function
doc:
<comment>Description:</comment>
  Configure les critères de tri
  
  Cette fonction configure les critères de tri et active le tri Z39.50.
  
  Appelez cette fonction avant <strong>yaz_search()</strong>. Si elle est utilisée conjointement avec <strong>yaz_search()</strong>,
  une commande Z39.50 Sort sera envoyée après chaque retour de recherche et avant que les résultats
  ne soient lus avec Z39.50 Present (<strong>yaz_present()</strong>).

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>        La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$criteria</strong>  Une chaîne de caractères qui prend la forme de field1 flags1 field2 flags2 où
                       field1 spécifie les attributs primaires pour le tri, field2 le second, etc.
                       
                       Le champ spécifie soit un attribut numérique, combinaison consistant de
                       paires type=value séparées par des virgules (c'est-à-dire <return>1=4,2=1</return>), soit il
                       peut être spécifié en une chaîne de caractères (c'est-à-dire <return>titre</return>). Le flags
                       est une séquence des caractères suivants qui ne peuvent être séparés par
                       aucun espace.
                       
                       Options de tri<return>a</return> Tri ascendant <return>d</return> Tri descendant <return>i</return> Tri insensible à la casse <return>s</return>
                       Tri sensible à la casse
                       
                       Tri ascendant
                       
                       Tri descendant
                       
                       Tri insensible à la casse
                       
                       Tri sensible à la casse

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


id: yaz_syntax
type: function
doc:
<comment>Description:</comment>
  Spécifie la syntaxe de lecture des lignes
  
  <strong>yaz_syntax()</strong> spécifie la syntaxe de lecture des lignes.
  
  Cette fonction devrait être appelée avant <strong>yaz_search()</strong> ou <strong>yaz_present()</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$id</strong>      La ressource de connexion retournée par <strong>yaz_connect()</strong>.
  <info>string</info>    <strong>$syntax</strong>  Doit être spécifié comme un OID (Object Identifier) dans une notation par point
                     brut (comme <return>1.2.840.10003.5.10</return>) ou comme une des syntaxes d'enregistrement
                     connues et enregistrées (sutrs, usmarc, grs1, xml, etc.).

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


id: yaz_wait
type: function
doc:
<comment>Description:</comment>
  Attend l'exécution d'une requête
  
  Cette fonction exécute une activité réseau (bloquée) pour les demandes en attente qui ont été
  préparées par les fonctions <strong>yaz_connect()</strong> <strong>yaz_search()</strong>, <strong>yaz_present()</strong>, <strong>yaz_scan()</strong> et
  <strong>yaz_itemorder()</strong>
  
  <strong>yaz_wait()</strong> se termine lorsque tous les hôtes ont terminé leurs requêtes (éventuellement en cas
  d'erreur).

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  Un tableau associatif des options : <return>timeout</return> Spécifie un délai d'attente en
                   secondes. Si un serveur n'a pas répondu dans les délais, il est considéré comme
                   mort et <strong>yaz_wait()</strong> se termine. La valeur par défaut pour le délai est de 15
                   secondes. <return>event</return> Un booléen.
                   
                   Spécifie un délai d'attente en secondes. Si un serveur n'a pas répondu dans les
                   délais, il est considéré comme mort et <strong>yaz_wait()</strong> se termine. La valeur par
                   défaut pour le délai est de 15 secondes.
                   
                   Un booléen.

<comment>Return:</comment>
  <info>mixed</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient. En mode
         événement, la fonction retourne une ressource ou <info>false</info> si une erreur survient.


id: zend_thread_id
type: function
doc:
<comment>Description:</comment>
  Retourne un identifiant unique du thread courant
  
  Cette fonction retourne un identifiant unique pour le thread courant.

<comment>Return:</comment>
  <info>int</info>  Retourne l'identifiant du thread, sous la forme d'un entier.


id: zend_version
type: function
doc:
<comment>Description:</comment>
  Lit la version courante du moteur Zend
  
  Retourne une chaîne contenant le numéro de version du moteur d'analyse Zend actuellement en cours
  d'utilisation.

<comment>Return:</comment>
  <info>string</info>  Retourne le numéro de la version du moteur Zend, sous la forme d'une chaîne de caractères.

<comment>See Also:</comment>
   * <strong>phpinfo()</strong>
   * <strong>phpcredits()</strong>
   * <strong>phpversion()</strong>


id: zip_close
type: function
doc:
<comment>Description:</comment>
  Ferme une archive Zip
  
  <strong>zip_close()</strong> ferme l'archive ZIP donnée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip</strong>  Un fichier ZIP précédemment ouvert avec la fonction <strong>zip_open()</strong>.

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

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_close
type: function
doc:
<comment>Description:</comment>
  Ferme un dossier d'archive
  
  <strong>zip_entry_close()</strong> ferme un dossier d'archive donné.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Un dossier d'archive précédemment ouvert avec la fonction <strong>zip_entry_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.

<comment>See Also:</comment>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_read()</strong>


id: zip_entry_compressedsize
type: function
doc:
<comment>Description:</comment>
  Lit la taille compressée d'un dossier d'archives
  
  <strong>zip_entry_compressedsize()</strong> retourne la taille compressée d'un dossier d'archives donné.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Un dossier d'archives retourné par la fonction <strong>zip_read()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  La taille compressée,  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_compressionmethod
type: function
doc:
<comment>Description:</comment>
  Lit la méthode de compression utilisée sur un dossier d'archives
  
  <strong>zip_entry_compressionmethod()</strong> retourne la méthode de compression utilisée sur le dossier
  d'archives spécifié par <strong>$zip_entry</strong>.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Un dossier d'archives retourné par la fonction <strong>zip_read()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  La méthode de compression,  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_filesize
type: function
doc:
<comment>Description:</comment>
  Lit la taille décompressée d'un dossier d'archives
  
  <strong>zip_entry_filesize()</strong> retourne la taille décompressée d'un dossier d'archives donné.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Un dossier d'archives retourné par la fonction <strong>zip_read()</strong>.

<comment>Return:</comment>
  <info>int|false</info>  La taille décompressée du dossier d'archives,  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_name
type: function
doc:
<comment>Description:</comment>
  Lit le nom d'un dossier d'archives
  
  <strong>zip_entry_name()</strong> retourne le nom d'un dossier d'archives donné.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Un dossier d'archives retourné par la fonction <strong>zip_read()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  Le nom du dossier d'archives,  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_read()</strong>


id: zip_entry_open
type: function
doc:
<comment>Description:</comment>
  Ouvre un dossier d'archives en lecture
  
  <strong>zip_entry_open()</strong> ouvre un dossier dans un fichier ZIP pour lecture.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_dp</strong>     Une ressource valide retournée par la fonction <strong>zip_open()</strong>.
  <info>resource</info>  <strong>$zip_entry</strong>  Un dossier d'archives retourné par la fonction <strong>zip_read()</strong>.
  <info>string</info>    <strong>$mode</strong>       Toutes les méthodes spécifiées dans la documentation de la fonction <strong>fopen()</strong>.
                        
                        Actuellement, <strong>$mode</strong> est ignoré et vaut toujours <return>"rb"</return>. Cela est dû au fait
                        que le support ZIP de PHP est uniquement en lecture seule.

<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.
        
        Contrairement à <strong>fopen()</strong> et les autres fonctions de fichiers, la valeur retournée par
        <strong>zip_entry_open()</strong> indique uniquement le résultat de l'opération, et n'est pas nécessaire pour
        la lecture ou la fermeture du fichier de dossier d'archives.

<comment>See Also:</comment>
   * <strong>zip_entry_close()</strong>
   * <strong>zip_entry_read()</strong>


id: zip_entry_read
type: function
doc:
<comment>Description:</comment>
  Lit le contenu d'un fichier dans un dossier
  
  <strong>zip_entry_read()</strong> lit dans un dossier d'archives ouvert.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip_entry</strong>  Un dossier d'archives retourné par la fonction <strong>zip_read()</strong>.
  <info>int</info>       <strong>$len</strong>        Le nombre d'octets à retourner.
                        
                        Ceci doit être la taille non-compressée que vous voulez lire.

<comment>Return:</comment>
  <info>string|false</info>  Retourne les données lues, une chaîne vide si l'on est à la fin du fichier, ou <info>false</info>
                si une erreur survient.

<comment>See Also:</comment>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_close()</strong>
   * <strong>zip_entry_filesize()</strong>


id: zip_open
type: function
doc:
<comment>Description:</comment>
  Ouvre une archive ZIP
  
  <strong>zip_open()</strong> ouvre une nouvelle archive ZIP pour lecture.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le nom du fichier de l'archive ZIP à ouvrir.

<comment>Return:</comment>
  <info>resource|int|false</info>  Retourne une ressource à utiliser plus tard avec les fonctions <strong>zip_read()</strong> et
                      <strong>zip_close()</strong>, ou bien retourne soit <info>false</info>, soit le numéro de l'erreur si le
                      paramètre <strong>$filename</strong> n'existe pas ou dans le cas d'une autre erreur.

<comment>See Also:</comment>
   * <strong>zip_read()</strong>
   * <strong>zip_close()</strong>


id: zip_read
type: function
doc:
<comment>Description:</comment>
  Lit la prochaine entrée dans une archive ZIP
  
  <strong>zip_read()</strong> lit la prochaine entrée dans une archive ZIP.

<comment>Param:</comment>
  <info>resource</info>  <strong>$zip</strong>  Un fichier ZIP précédemment ouvert avec la fonction <strong>zip_open()</strong>.

<comment>Return:</comment>
  <info>resource|false</info>  Retourne une ressource de dossier d'archive, à utiliser plus tard avec les autres
                  fonctions de la bibliothèque, <info>false</info> s'il n'y a plus d'entrées à lire dans
                  l'archive ZIP ou le numéro de l'erreur si une erreur survient.

<comment>See Also:</comment>
   * <strong>zip_open()</strong>
   * <strong>zip_close()</strong>
   * <strong>zip_entry_open()</strong>
   * <strong>zip_entry_read()</strong>


id: zlib_decode
type: function
doc:
<comment>Description:</comment>
  Décompresse des données encodées raw/gzip/zlib
  
  Décompresse des données encodées raw/gzip/zlib.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>        
  <info>int</info>     <strong>$max_length</strong>  

<comment>Return:</comment>
  <info>string|false</info>  Retourne les données compressées,  ou <info>false</info> si une erreur survient.

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


id: zlib_encode
type: function
doc:
<comment>Description:</comment>
  Compresse des données avec l'encodage spécifié
  
  Compresse des données avec l'encodage spécifié.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      Les données à compresser.
  <info>int</info>     <strong>$encoding</strong>  L'algorithme de compression. Soit <info>ZLIB_ENCODING_RAW</info>, <info>ZLIB_ENCODING_DEFLATE</info> ou
                     <info>ZLIB_ENCODING_GZIP</info>.
  <info>int</info>     <strong>$level</strong>     

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

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


id: zlib_get_coding_type
type: function
doc:
<comment>Description:</comment>
  Retourne la méthode de compression utilisée avec Gzip
  
  <strong>zlib_get_coding_type()</strong> retourne la méthode de compression utilisée avec Gzip.

<comment>Return:</comment>
  <info>string|false</info>  Les valeurs possibles de retour sont <return>gzip</return>, <return>deflate</return> ou <info>false</info>.

<comment>See Also:</comment>
   * 
     La directive zlib.output_compression
     directive
    


id: zookeeper_dispatch
type: function
doc:
<comment>Description:</comment>
  Calls callbacks for pending operations
  
  The <strong>zookeeper_dispatch()</strong> function calls the callbacks passed by operations like Zookeeper::get or
  Zookeeper::exists.
  
  Since version 0.4.0, this function must be called manually to achieve asynchronous operations. If
  you want that to be done automatically, you also can declare ticks at the beginning of your
  program.
  
  After PHP 7.1, you can ignore this function. This extension uses EG(vm_interrupt) to implement
  async dispatch.

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

<comment>See Also:</comment>
   * Zookeeper::addAuth
   * Zookeeper::connect
   * Zookeeper::__construct
   * Zookeeper::exists
   * Zookeeper::get
   * Zookeeper::getChildren
   * Zookeeper::setWatcher


