# php_manual

id: SolrQuery::setTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Spécifie le terme de départ
  
  Spécifie le terme de départ.

<comment>Param:</comment>
  <info>string</info>  <strong>$lowerBound</strong>  Le terme

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée.


id: SolrQuery::setTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Définit la fréquence maximale du document
  
  Définit la fréquence maximale du document.

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  La fréquence maximale du document.

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée.


id: SolrQuery::setTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Définit la fréquence minimale d'un document
  
  Définit la fréquence minimale d'un document.

<comment>Param:</comment>
  <info>int</info>  <strong>$frequency</strong>  La fréquence minimale.

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée.


id: SolrQuery::setTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Restreint les termes correspondants qui commencent avec un préfixe donné
  
  Restreint les termes correspondants qui commencent avec un préfixe donné.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  Le préfixe.

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée.


id: SolrQuery::setTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Retourne les caractères brutes d'un terme indexé
  
  Si vaut <info>true</info>, retourne les caractères brutes d'un terme indexé, suivant s'ils sont humainement
  lisibles.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> ou <info>false</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée.


id: SolrQuery::setTermsSort
type: function
doc:
<comment>Description:</comment>
  Spécifie la façon dont seront triés les termes retournés
  
  Si SolrQuery::TERMS_SORT_COUNT, les termes seront triés par leur fréquence (ceux dont la fréquence
  est la plus élevée en premier). Si SolrQuery::TERMS_SORT_INDEX, retourne les termes suivants leurs
  index.

<comment>Param:</comment>
  <info>int</info>  <strong>$sortType</strong>  SolrQuery::TERMS_SORT_INDEX ou SolrQuery::TERMS_SORT_COUNT

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée.


id: SolrQuery::setTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Définit le terme à partir duquel on doit stopper
  
  Définit le terme à partir duquel on doit stopper.

<comment>Param:</comment>
  <info>string</info>  <strong>$upperBound</strong>  Le terme.

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée.


id: SolrQuery::setTimeAllowed
type: function
doc:
<comment>Description:</comment>
  Le temps allouée pour faire une recherche
  
  Le temps allouée pour faire une recherche. Cette valeur ne s'applique qu'aux recherches et non aux
  requêtes en général. Le temps est en millisecondes. Les valeurs inférieures ou égales à zéro
  impliquent aucune restriction de temps. Les résultats partiels peuvent être retournés, s'il y en
  a.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeAllowed</strong>  Le temps allouée pour faire une recherche.

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant, si la valeur retournée est utilisée.


id: SolrResponse::getDigestedResponse
type: function
doc:
<comment>Description:</comment>
  Récupère la réponse XML sous la forme de données PHP sérialisées
  
  Récupère la réponse XML sous la forme de données PHP sérialisées.

<comment>Return:</comment>
  <info>string</info>  Retourne la réponse XML sous la forme de données PHP sérialisées.


id: SolrResponse::getHttpStatus
type: function
doc:
<comment>Description:</comment>
  Récupère le statut HTTP de la réponse
  
  Récupère le statut HTTP de la réponse.

<comment>Return:</comment>
  <info>int</info>  Retourne le statut HTTP de la réponse.


id: SolrResponse::getHttpStatusMessage
type: function
doc:
<comment>Description:</comment>
  Récupère plus de détails sur le statut HTTP
  
  Récupère plus de détails sur le statut HTTP.

<comment>Return:</comment>
  <info>string</info>  Retourne plus de détails sur le statut HTTP.


id: SolrResponse::getRawRequest
type: function
doc:
<comment>Description:</comment>
  Récupère la requête brute envpyée au serveur Solr
  
  Récupère la requête brute envpyée au serveur Solr.

<comment>Return:</comment>
  <info>string</info>  Retourne la requête brute envpyée au serveur Solr.


id: SolrResponse::getRawRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Récupère les en-têtes brutes de la requête envoyée au serveur Solr
  
  Récupère les en-têtes brutes de la requête envoyée au serveur Solr.

<comment>Return:</comment>
  <info>string</info>  Retourne les en-têtes brutes de la requête envoyée au serveur Solr.


id: SolrResponse::getRawResponse
type: function
doc:
<comment>Description:</comment>
  Récupère la réponse brute du serveur
  
  Récupère la réponse brute du serveur.

<comment>Return:</comment>
  <info>string</info>  Retourne la réponse brute du serveur.


id: SolrResponse::getRawResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Récupère les en-têtes brutes de la réponse du serveur
  
  Récupère les en-têtes brutes de la réponse du serveur.

<comment>Return:</comment>
  <info>string</info>  Retourne les en-têtes brutes de la réponse du serveur.


id: SolrResponse::getRequestUrl
type: function
doc:
<comment>Description:</comment>
  Récupère l'URL complète de la requête émise au serveur
  
  Récupère l'URL complète de la requête émise au serveur.

<comment>Return:</comment>
  <info>string</info>  Retourne l'URL complète de la requête émise au serveur.


id: SolrResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Récupère l'objet SolrObject représentant la réponse XML du serveur
  
  Récupère l'objet SolrObject représentant la réponse XML du serveur.

<comment>Return:</comment>
  <info>SolrObject</info>  Retourne l'objet SolrObject représentant la réponse XML du serveur.


id: SolrResponse::setParseMode
type: function
doc:
<comment>Description:</comment>
  Définit le mode d'analyse
  
  Définit le mode d'analyse.

<comment>Param:</comment>
  <info>int</info>  <strong>$parser_mode</strong>  SolrResponse::PARSE_SOLR_DOC analyse les documents avec SolrDocument.
                     SolrResponse::PARSE_SOLR_OBJ analyse les documents avec SolrObjects.

<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: SolrResponse::success
type: function
doc:
<comment>Description:</comment>
  Vérifie si la requête au serveur a réussi
  
  Vérifie si la requête au serveur a réussi.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la requête a réussi, <info>false</info> sinon.


id: SolrServerException
type: class
doc:
<comment>Description:</comment>
  Une exception est émise lorsque ce produit une erreur dans le serveur Solr.


id: SolrServerException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Retourne des informations internes sur le lieu où l'exception a été émise
  
  Retourne des informations internes sur le lieu où l'exception a été émise.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant des informations internes sur le lieu où l'exception a été
         émise. Utilisé uniquement par les développeurs de l'extension dans un but de débogage.


id: SolrUtils
type: class
doc:
<comment>Description:</comment>
  Contient des méthodes utiles pour récupérer la version de l'extension courante et préparer les
  requêtes.
  
  Contient également des méthodes pour échapper les chaînes utilisées dans les requêtes et analyser
  les réponses XML.


id: SolrUtils::digestXmlResponse
type: function
doc:
<comment>Description:</comment>
  Analyse une réponse XML dans un SolrObject
  
  Cette méthode analyse une réponse XML depuis un serveur Apache Solr dans un SolrObject. Lance une
  exception SolrException si une erreur survient.

<comment>Param:</comment>
  <info>string</info>  <strong>$xmlresponse</strong>  La réponse XML depuis le serveur Solr.
  <info>int</info>     <strong>$parse_mode</strong>   Utilisez SolrResponse::PARSE_SOLR_OBJ ou SolrResponse::PARSE_SOLR_DOC

<comment>Return:</comment>
  <info>SolrObject</info>  Retourne l'objet SolrObject représentant la réponse XML.
              
              Si le paramètre parse_mode vaut SolrResponse::PARSE_SOLR_OBJ, les documents Solr
              seront analysés comme des instances SolrObject.
              
              S'il vaut SolrResponse::PARSE_SOLR_DOC, ils seront analysés comme des instances
              SolrDocument.


id: SolrUtils::escapeQueryChars
type: function
doc:
<comment>Description:</comment>
  Protège une requête
  
  Le support Lucene protège les caractères spéciaux faisant partis de la syntaxe de la requête.
  
  La liste actuelle des caractères spéciaux est :
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  Chaîne à protéger.

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


id: SolrUtils::getSolrVersion
type: function
doc:
<comment>Description:</comment>
  Récupère la version courant de l'extension Solr
  
  Récupère la version courante Solr.

<comment>Return:</comment>
  <info>string</info>  La version courante de l'extension Apache Solr.


id: SolrUtils::queryPhrase
type: function
doc:
<comment>Description:</comment>
  Prépare une phrase depuis une chaîne non protégée par Lucene
  
  Prépare une phrase depuis une chaîne non protégée par Lucene.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>  La phrase Lucene.

<comment>Return:</comment>
  <info>string</info>  Retourne la partie de la phrase contenue entre guillemets.


id: SplDoublyLinkedList
type: class
doc:
<comment>Description:</comment>
  La classe SplDoublyLinkedList fournit l'interface principale pour  les listes doublement chaînées.


id: SplDoublyLinkedList::IT_MODE_FIFO
type: constant
doc:
<comment>Description:</comment>
  La liste sera itérée dans un ordre premier entré, premier sorti, comme une file.


id: SplDoublyLinkedList::IT_MODE_LIFO
type: constant
doc:
<comment>Description:</comment>
  La liste sera itérée dans un ordre dernier entré, premier sorti, comme une pile.


id: SplDoublyLinkedList::add
type: function
doc:
<comment>Description:</comment>
  Ajoute/insert une nouvelle valeur à l'index spécifié
  
  Insert la valeur <strong>$value</strong> à l'index <strong>$index</strong> spécifié, en faisant passer la valeur précédente à cet
  index (ainsi que toutes les valeurs en dessous).

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  L'index où la nouvelle valeur doit être insérée.
  <info>mixed</info>  <strong>$value</strong>  La nouvelle valeur pour l'index <strong>$index</strong>.

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


id: SplDoublyLinkedList::bottom
type: function
doc:
<comment>Description:</comment>
  Le nœud parent à partir duquel la liste découle

<comment>Return:</comment>
  <info>mixed</info>  La valeur du premier nœud.


id: SplDoublyLinkedList::count
type: function
doc:
<comment>Description:</comment>
  Compte le nombre d'éléments de la liste

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre d'éléments de la liste.


id: SplDoublyLinkedList::current
type: function
doc:
<comment>Description:</comment>
  Retourne l'entrée courante du tableau
  
  Retourne l'entrée courante du tableau.

<comment>Return:</comment>
  <info>mixed</info>  La valeur du nœud courant.


id: SplDoublyLinkedList::getIteratorMode
type: function
doc:
<comment>Description:</comment>
  Retourne le mode de l'itérateur

<comment>Return:</comment>
  <info>int</info>  Retourne le mode et les drapeaux qui affectent l'itérateur.


id: SplDoublyLinkedList::isEmpty
type: function
doc:
<comment>Description:</comment>
  Vérifie si la liste est vide

<comment>Return:</comment>
  <info>bool</info>  Retourne si la liste est vide, ou non.


id: SplDoublyLinkedList::key
type: function
doc:
<comment>Description:</comment>
  Retourne l'index du nœud courant
  
  Retourne l'index du nœud courant.

<comment>Return:</comment>
  <info>int</info>  L'index du nœud courant.


id: SplDoublyLinkedList::next
type: function
doc:
<comment>Description:</comment>
  Se déplace à l'entrée suivante
  
  Se déplace à l'entrée suivante.

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


id: SplDoublyLinkedList::offsetExists
type: function
doc:
<comment>Description:</comment>
  Vérifie si un index existe

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  L'index à vérifier.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si l'<strong>$index</strong> existe, <info>false</info> sinon.


id: SplDoublyLinkedList::offsetGet
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur d'un index

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  L'index désiré.

<comment>Return:</comment>
  <info>mixed</info>  La valeur de l'<strong>$index</strong>.


id: SplDoublyLinkedList::offsetSet
type: function
doc:
<comment>Description:</comment>
  Spécifie la nouvelle valeur de l'index
  
  Définit la valeur de l'<strong>$index</strong> à la  valeur <strong>$value</strong>.

<comment>Param:</comment>
  <info>int|null</info>  <strong>$index</strong>  L'index à définir. Si <info>null</info> la prochaine valeur sera ajouté après la dernière
                    valeur.
  <info>mixed</info>     <strong>$value</strong>  La nouvelle valeur pour l'<strong>$index</strong>.

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


id: SplDoublyLinkedList::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Efface la valeur d'un index
  
  Efface la valeur d'un index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  L'index à effacer.

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


id: SplDoublyLinkedList::pop
type: function
doc:
<comment>Description:</comment>
  Dépile et retourne le dernier élément de la liste

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur du dernier élément de la liste.


id: SplDoublyLinkedList::prev
type: function
doc:
<comment>Description:</comment>
  Recule d'un élément
  
  Déplace l'itérateur à l'élément précédent.

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


id: SplDoublyLinkedList::push
type: function
doc:
<comment>Description:</comment>
  Ajoute un élément à la fin de la liste
  
  Ajoute un élément à la fin de la liste.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  La valeur à ajouter.

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


id: SplDoublyLinkedList::rewind
type: function
doc:
<comment>Description:</comment>
  Replace l'itérateur au début
  
  Replace l'itérateur au début.

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


id: SplDoublyLinkedList::serialize
type: function
doc:
<comment>Description:</comment>
  Sérialise la liste
  
  Sérialise la liste.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>string</info>  La chaine sérialisée.

<comment>See Also:</comment>
   * SplDoublyLinkedList::unserialize


id: SplDoublyLinkedList::setIteratorMode
type: function
doc:
<comment>Description:</comment>
  Définit le mode d'itération

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Il y a 2 jeux de modes que l'on peut définir :
              
              La direction de l'itérateur :
              
              <info>SplDoublyLinkedList::IT_MODE_LIFO</info> (pile)
              
              <info>SplDoublyLinkedList::IT_MODE_FIFO</info> (file d'attente)
              
              Le comportement de l'itérateur :
              
              <info>SplDoublyLinkedList::IT_MODE_DELETE</info> (les éléments sont effacés par l'itérateur)
              
              <info>SplDoublyLinkedList::IT_MODE_KEEP</info> (les éléments sont traversés par l'itérateur)
              
              Le mode par défaut est : <info>SplDoublyLinkedList::IT_MODE_FIFO</info> |
              <info>SplDoublyLnkedList::IT_MODE_KEEP</info>
              
              La direction d'itération ne peut pas être modifiée pour les classes <class>SplStack</class> et
              <class>SplQueue</class>, elle est toujours <info>SplDoublyLinkedList::IT_MODE_FIFO</info>. Tenter de la modifier
              entraînera le lancement d'une <class>RuntimeException</class>.

<comment>Return:</comment>
  <info>int</info>  Retourne les différents modes et indicateurs qui affectent l'itération.


id: SplDoublyLinkedList::shift
type: function
doc:
<comment>Description:</comment>
  Déplace un nœud de la liste

<comment>Return:</comment>
  <info>mixed</info>  La valeur du nœud déplacé.


id: SplDoublyLinkedList::top
type: function
doc:
<comment>Description:</comment>
  Récupère le dernier nœud de la liste

<comment>Return:</comment>
  <info>mixed</info>  La valeur du dernier nœud.


id: SplDoublyLinkedList::unserialize
type: function
doc:
<comment>Description:</comment>
  Désérialise la liste
  
  Désérialise la liste, depuis SplDoublyLinkedList::serialize.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  La chaine sérialisée.

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

<comment>See Also:</comment>
   * SplDoublyLinkedList::serialize


id: SplDoublyLinkedList::unshift
type: function
doc:
<comment>Description:</comment>
  Ajoute un élément à la liste
  
  Ajoute un élément ayant pour valeur <strong>$value</strong> au début de la liste.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  La valeur.

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


id: SplDoublyLinkedList::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si la liste contient encore des nœuds
  
  Vérifie si la liste contient encore des nœuds.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la liste contient encore des nœuds, <info>false</info> sinon.


id: SplFileInfo
type: class
doc:
<comment>Description:</comment>
  La classe <class>SplFileInfo</class> fournit une interface de haut niveau avec les informations de fichiers.


id: SplFileInfo::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet SplFileInfo
  
  Crée un nouvel objet <class>SplFileInfo</class> pour le  nom de fichier indiqué. Le fichier n'a pas besoin d'être
  lisible ou même d'exister.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le chemin jusqu'au fichier.


id: SplFileInfo::__toString
type: function
doc:
<comment>Description:</comment>
  Retourne le chemin d'un fichier sous forme de chaîne
  
  Retourne le chemin d'un fichier sous forme de chaîne.

<comment>Return:</comment>
  <info>string</info>  Le chemin, sous forme de chaîne.


id: SplFileInfo::getATime
type: function
doc:
<comment>Description:</comment>
  Lit la date de dernier accès au fichier
  
  Lit la date de dernier accès au fichier.

<comment>Return:</comment>
  <info>int|false</info>  Retourne la date de dernier accès au fichier en cas de succès ou <info>false</info> si une erreur
             survient.

<comment>See Also:</comment>
   * <strong>fileatime()</strong>
   * SplFileInfo::getCTime
   * SplFileInfo::getMTime


id: SplFileInfo::getBasename
type: function
doc:
<comment>Description:</comment>
  Lit le nom de base du fichier
  
  Cette méthode retourne le nom du fichier, dossier ou lien sans le chemin.
  
  <strong>SplFileInfo::getBasename()</strong> a conscience de la locale, donc pour voir la bonne basename avec un
  chemin qui contient des caractères multioctets, la locale correspondante doit être définie en
  utilisant la fonction <strong>setlocale()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  Un suffixe optionnel à omettre dans le nom de fichier retourné.

<comment>Return:</comment>
  <info>string</info>  Retourne le nom du fichier, sans les informations de chemin.

<comment>See Also:</comment>
   * SplFileInfo::getFilename


id: SplFileInfo::getCTime
type: function
doc:
<comment>Description:</comment>
  Lit la date de modification du fichier
  
  Retourne la date de modification du fichier. La date est au format timestamp Unix.

<comment>Return:</comment>
  <info>int|false</info>  La date de dernier changement, sous forme de timestamp Unix en cas de succès ou <info>false</info>
             si une erreur survient.

<comment>See Also:</comment>
   * <strong>filectime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getMTime


id: SplFileInfo::getExtension
type: function
doc:
<comment>Description:</comment>
  Récupère l'extension d'un fichier
  
  Récupère l'extension d'un fichier.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères contenant l'extension du fichier, ou une chaîne vide si
          le fichier n'a pas d'extension.

<comment>See Also:</comment>
   * SplFileInfo::getFilename
   * SplFileInfo::getBasename
   * <strong>pathinfo()</strong>


id: SplFileInfo::getFileInfo
type: function
doc:
<comment>Description:</comment>
  Obtient un objet SplFileInfo pour un fichier
  
  Cette méthode obtient un objet <class>SplFileInfo</class> pour un fichier.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  Le nom de la classe <class>SplFileInfo</class> dérivée à utiliser.

<comment>Return:</comment>
  <info>SplFileInfo</info>  Un objet <class>SplFileInfo</class> créé pour le fichier.

<comment>See Also:</comment>
   * SplFileInfo::setInfoClass


id: SplFileInfo::getFilename
type: function
doc:
<comment>Description:</comment>
  Lit le nom du fichier
  
  Lit le nom du fichier, sans chemin.

<comment>Return:</comment>
  <info>string</info>  Le nom du fichier.

<comment>See Also:</comment>
   * SplFileInfo::getBasename


id: SplFileInfo::getGroup
type: function
doc:
<comment>Description:</comment>
  Lit le groupe d'appartenance du fichier
  
  Lit le groupe d'appartenance du fichier. L'identifiant du groupe est un entier.

<comment>Return:</comment>
  <info>int|false</info>  L'identifiant du groupe est un entier en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>filegroup()</strong>
   * <strong>posix_getgrgid()</strong>


id: SplFileInfo::getInode
type: function
doc:
<comment>Description:</comment>
  Lit le inode du fichier
  
  Lit le numéro de inode du fichier.

<comment>Return:</comment>
  <info>int|false</info>  Retourne le numéro de inode du fichier en cas de succès ou <info>false</info> si une erreur
             survient.

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


id: SplFileInfo::getLinkTarget
type: function
doc:
<comment>Description:</comment>
  Lit la cible d'un lien symbolique
  
  Lit la cible d'un lien symbolique.
  
  Le chemin indiqué n'est pas toujours le chemin réel sur le système de fichiers. Utilisez
  SplFileInfo::getRealPath pour déterminer le véritable chemin.

<comment>Return:</comment>
  <info>string|false</info>  Retourne la cible du lien symbolique en cas de succès ou <info>false</info> si une erreur
                survient.

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * SplFileInfo::getRealPath


id: SplFileInfo::getMTime
type: function
doc:
<comment>Description:</comment>
  Lit la date de dernière modification
  
  Lit la date de dernière modification du contenu du fichier. La date retournée est au format
  timestamp Unix en cas de succès ou <info>false</info> si une erreur survient.

<comment>Return:</comment>
  <info>int|false</info>  Retourne l'heure de la dernière modification du fichier, sous la forme d'un timestamp
             Unix en cas de succès, ou <info>false</info> en cas d'échec.

<comment>See Also:</comment>
   * <strong>filemtime()</strong>
   * SplFileInfo::getATime
   * SplFileInfo::getCTime


id: SplFileInfo::getOwner
type: function
doc:
<comment>Description:</comment>
  Lit le propriétaire du fichier
  
  Lit le propriétaire du fichier. Le propriétaire est un entier.

<comment>Return:</comment>
  <info>int|false</info>  Le propriétaire du fichier, au format entier en cas de succès ou <info>false</info> si une erreur
             survient.

<comment>See Also:</comment>
   * <strong>posix_getpwuid()</strong>
   * SplFileInfo::getGroup


id: SplFileInfo::getPath
type: function
doc:
<comment>Description:</comment>
  Le chemin sans le nom de fichier
  
  Retourne le nom du chemin sans le nom de fichier, ou un slash final.

<comment>Return:</comment>
  <info>string</info>  Retourne le chemin du fichier.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath
   * SplFileInfo::getFilename
   * SplFileInfo::getPathInfo


id: SplFileInfo::getPathInfo
type: function
doc:
<comment>Description:</comment>
  Crée un objet SplFileInfo pour un chemin
  
  Crée un objet <class>SplFileInfo</class> pour le dossier qui contient le fichier courant.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$class</strong>  Le nom d'une classe qui dérive de <class>SplFileInfo</class>, ou elle même si <info>null</info>.

<comment>Return:</comment>
  <info>SplFileInfo|null</info>  Retourne un objet <class>SplFileInfo</class> pour le dossier qui contient le fichier courant en
                    cas de succès, ou <info>null</info> en cas d'échec.

<comment>See Also:</comment>
   * SplFileInfo::setInfoClass


id: SplFileInfo::getPathname
type: function
doc:
<comment>Description:</comment>
  Lit le chemin d'un fichier
  
  Retourne le chemin d'un fichier.

<comment>Return:</comment>
  <info>string</info>  Le chemin d'un fichier.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath


id: SplFileInfo::getPerms
type: function
doc:
<comment>Description:</comment>
  Lit les droits d'un fichier
  
  Lit les droits d'un fichier.

<comment>Return:</comment>
  <info>int|false</info>  Retourne les droits d'un fichier, sous forme d'entier en cas de succès ou <info>false</info> si une
             erreur survient.


id: SplFileInfo::getRealPath
type: function
doc:
<comment>Description:</comment>
  Lit le chemin absolu d'un fichier
  
  Cette méthode résout tous les liens symboliques, les chemins relatifs et  retourne le véritable
  chemin qui mène à un fichier.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le chemin du fichier ou <info>false</info> si le fichier n'existe pas.

<comment>See Also:</comment>
   * SplFileInfo::isLink
   * realpath


id: SplFileInfo::getSize
type: function
doc:
<comment>Description:</comment>
  Lit la taille d'un fichier
  
  Retourne la taille d'un fichier, en octets.

<comment>Return:</comment>
  <info>int|false</info>  La taille du fichier, en octets en cas de succès ou <info>false</info> si une erreur survient.

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


id: SplFileInfo::getType
type: function
doc:
<comment>Description:</comment>
  Lit le type de fichier
  
  Retourne le type de fichier.

<comment>Return:</comment>
  <info>string|false</info>  Une <info>string</info> représentant le type de fichier. Cela peut être <return>file</return>, <return>link</return>, <return>dir</return>, <return>block</return>,
                <return>fifo</return>, <return>char</return>, <return>socket</return>, ou <return>unknown</return>, ou <info>false</info> si une erreur survient.


id: SplFileInfo::isDir
type: function
doc:
<comment>Description:</comment>
  Indique si le fichier est un dossier
  
  Indique si le fichier est un dossier.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le fichier est un dossier, et <info>false</info> sinon.


id: SplFileInfo::isExecutable
type: function
doc:
<comment>Description:</comment>
  Indique si un fichier est exécutable
  
  <strong>SplFileInfo::isExecutable()</strong> indique si un fichier est exécutable.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le fichier est exécutable, <info>false</info> sinon.


id: SplFileInfo::isFile
type: function
doc:
<comment>Description:</comment>
  Indique si un fichier est un véritable fichier
  
  Indique si un fichier existe et est un véritable fichier.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le fichier existe et qu'il est un véritable fichier (et non pas un lien) et
        <info>false</info> sinon.


id: SplFileInfo::isLink
type: function
doc:
<comment>Description:</comment>
  Indique si un fichier est un lien
  
  Cette méthode indique si un fichier référencé par <class>SplFileInfo</class> est un lien.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le fichier est un lien, et <info>false</info> sinon.

<comment>See Also:</comment>
   * SplFileInfo::getRealPath


id: SplFileInfo::isReadable
type: function
doc:
<comment>Description:</comment>
  Indique si le fichier est lisible
  
  Indique si le fichier est lisible.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le fichier est lisible, et <info>false</info> sinon.


id: SplFileInfo::isWritable
type: function
doc:
<comment>Description:</comment>
  Indique si on peut écrire dans un fichier
  
  Vérifie si le fichier a les autorisations en écriture.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le fichier peut être écrit, et <info>false</info> sinon;


id: SplFileInfo::openFile
type: function
doc:
<comment>Description:</comment>
  Crée un objet SplFileObject pour le fichier
  
  Crée un objet <class>SplFileObject</class> pour le fichier. Cette fonction est utile car <class>SplFileObject</class> contient
  des méthodes supplémentaires pour manipuler des fichiers alors que <class>SplFileInfo</class> n'est utile que
  pour  lire des informations, comme les attributs d'un fichier.

<comment>Param:</comment>
  <info>string</info>         <strong>$mode</strong>            Le mode d'ouverture du fichier. Voyez la fonction  <strong>fopen()</strong> pour
                                  connaître les différents modes. La valeur par défaut est lecture
                                  seule.
  <info>bool</info>           <strong>$useIncludePath</strong>  Lorsque définit à <info>true</info>, le nom du fichier est
                                  également recherché dans include_path
  <info>resource|null</info>  <strong>$context</strong>         Reportez-vous à la section contexte
                                  de ce manuel pour une description des <return>contextes</return>.

<comment>Return:</comment>
  <info>SplFileObject</info>  Le fichier ouvert, sous forme d'objet  <class>SplFileObject</class>.

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


id: SplFileInfo::setFileClass
type: function
doc:
<comment>Description:</comment>
  Configure la classe utilisée avec SplFileInfo::openFile
  
  Utilisez cette méthode pour définir une classe personnalisée qui sera  utilisée lorsque
  SplFileInfo::openFile est appelé.  Le nom de la classe passé à cette méthode doit être
  <class>SplFileObject</class>  ou une classe dérivé de  <class>SplFileObject</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  Le nom de la classe utilisée par  SplFileInfo::openFile.

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

<comment>See Also:</comment>
   * SplFileInfo::openFile


id: SplFileInfo::setInfoClass
type: function
doc:
<comment>Description:</comment>
  Configure la classe utilisée par SplFileInfo::getFileInfo et SplFileInfo::getPathInfo
  
  Utilisez cette méthode pour configurer une classe personnalisée à utiliser avec les méthodes
  getFileInfo et getPathInfo. La classe utilisée doit hériter de <class>SplFileInfo</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  Le nom de la classe à utiliser.

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

<comment>See Also:</comment>
   * SplFileInfo::getFileInfo


id: SplFileObject
type: class
doc:
<comment>Description:</comment>
  La classe SplFileObject offre une interface orientée objet pour un fichier.


id: SplFileObject::SKIP_EMPTY
type: constant
doc:
<comment>Description:</comment>
  Ignore les lignes vierges du fichier. Ceci nécessite l'activation du drapeau <info>READ_AHEAD</info> afin de
  fonctionner comme attendu.


id: SplFileObject::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet fichier
  
  Construit un nouvel objet fichier.

<comment>Param:</comment>
  <info>string</info>         <strong>$filename</strong>        Le fichier à lire.
                                  
                                  Vous pouvez utiliser une URL comme nom de fichier avec cette
                                  fonction, si le gestionnaire fopen a été activé. Voyez <strong>fopen()</strong>
                                  pour plus de détails sur la façon de spécifier le nom du fichier.
                                  Reportez-vous aux  pour plus d'informations sur les capacités des
                                  différents gestionnaires, les notes sur leur utilisation, ainsi
                                  que les informations sur les variables prédéfinies qu'elles
                                  fournissent.
  <info>string</info>         <strong>$mode</strong>            Le mode utilisé pour ouvrir le fichier. Voir la fonction <strong>fopen()</strong>
                                  pour une liste de tous les modes disponibles.
  <info>bool</info>           <strong>$useIncludePath</strong>  Si l'on doit chercher dans l'include_path le fichier <strong>$filename</strong>.
  <info>resource|null</info>  <strong>$context</strong>         Une ressource de contexte valide créée avec la fonction
                                  <strong>stream_context_create()</strong>.

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


id: SplFileObject::__toString
type: function
doc:
<comment>Description:</comment>
  Retourne la ligne courante sous forme de chaîne de caractères
  
  Cette méthode la ligne courante sous forme de chaîne de caractères.

<comment>Return:</comment>
  <info>string</info>  Retourne la ligne courante sous forme de chaîne de caractères.


id: SplFileObject::current
type: function
doc:
<comment>Description:</comment>
  Récupère la ligne courante d'un fichier
  
  Récupère la ligne courante d'un fichier.

<comment>Return:</comment>
  <info>string|array|false</info>  Récupère la ligne courante d'un fichier. Si le drapeau <info>SplFileObject::READ_CSV</info>
                      est défini, cette méthode retournera un tableau contenant la ligne courante
                      analysée comme étant une donnée CSV. Si la fin du fichier est atteinte, <info>false</info>
                      est retourné.

<comment>See Also:</comment>
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::eof
type: function
doc:
<comment>Description:</comment>
  Vérifie si la fin du fichier est atteinte
  
  Vérifie si la fin du fichier est atteinte.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la fin du fichier a été atteinte, <info>false</info> sinon.

<comment>See Also:</comment>
   * SplFileObject::valid
   * <strong>feof()</strong>


id: SplFileObject::fflush
type: function
doc:
<comment>Description:</comment>
  Écrit l'affichage dans le fichier
  
  Force l'écriture de tous les buffers d'affichage dans le fichier.

<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>
   * SplFileObject::fwrite


id: SplFileObject::fgetc
type: function
doc:
<comment>Description:</comment>
  Récupère un caractère depuis le fichier
  
  Récupère un caractère depuis le fichier.

<comment>Return:</comment>
  <info>string|false</info>  Retourne une chaîne de caractères contenant un seul caractère lu depuis le fichier,
                ou <info>false</info> si la fin du fichier a été atteinte.
                
                Cette fonction peut retourner <info>false</info>, mais elle peut aussi retourner une valeur
                équivalent à <info>false</info>. Veuillez lire la section sur les booléens pour plus
                d'informations. Utilisez l'opérateur === pour tester la valeur de retour exacte de
                cette fonction.

<comment>See Also:</comment>
   * SplFileObject::fgets


id: SplFileObject::fgetcsv
type: function
doc:
<comment>Description:</comment>
  Récupère une ligne depuis le fichier et l'analyse comme étant des données CSV
  
  Récupère une ligne depuis le fichier et l'analyse comme étant des données CSV et retourne un
  tableau contenant tous les champs lus.
  
  La définition des locales entre en jeu avec cette fonction. Si <return>LC_CTYPE</return> vaut, par exemple
  <return>en_US.UTF-8</return>, les fichiers encodés avec un encodage d'un octet peuvent être mal lus par cette
  fonction.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  Le délimiteur de champs (un caractère d'un seul octet). Par défaut, ce sera
                      une virgule ou la valeur définie en utilisant la méthode
                      SplFileObject::setCsvControl.
  <info>string</info>  <strong>$enclosure</strong>  Le caractère utilisé pour entourer la valeur d'un champ (un caractère d'un
                      seul octet). Par défaut, ce sera un guillemet double ou bien la valeur définie
                      en utilisant la méthode SplFileObject::setCsvControl.
  <info>string</info>  <strong>$escape</strong>     Le caractère d'échappement (au plus un caractère d'un seul octet). Par défaut,
                      ce sera un antislash (<return>\</return>) ou bien la valeur définie en utilisant la méthode
                      SplFileObject::setCsvControl. Une chaîne de caractères vide (<return>""</return>) désactive le
                      mécanisme d'échappement propriétaire.
                      
                      Habituellement, un <strong>$enclosure</strong> caractère est échappé à  l'intérieur d'un champ
                      en le doublant; Toutefois, le caractère  <strong>$escape</strong> peut être utilisé comme une
                      alternative.  Ainsi, pour les valeurs de paramètre par défaut <return>""</return> et  <return>\"</return> ont la
                      même signification. Autre que de permettre  d'échapper le caractère <strong>$enclosure</strong>
                      le caractère  <strong>$escape</strong> n'a pas de sens particulier; il n'est même  pas destiné
                      à s'échapper.

<comment>Return:</comment>
  <info>array|false</info>  Retourne un tableau indexé contenant tous les champs lus, ou <info>false</info> si une erreur
               survient.
               
               Une ligne vide d'un fichier CSV sera retourné sous la forme d'un tableau contenu un
               seul champ <info>null</info> sauf si vous utilisez <info>SplFileObject::SKIP_EMPTY |
               SplFileObject::DROP_NEW_LINE</info>, auquel cas, les lignes vides seront ignorées.

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::setFlags
   * SplFileObject::READ_CSV
   * SplFileObject::current


id: SplFileObject::fgets
type: function
doc:
<comment>Description:</comment>
  Récupère une ligne d'un fichier
  
  Récupère une ligne d'un fichier.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères contenant la prochaine ligne d'un fichier.

<comment>See Also:</comment>
   * <strong>fgets()</strong>
   * SplFileObject::fgetss
   * SplFileObject::fgetc
   * SplFileObject::current


id: SplFileObject::fgetss
type: function
doc:
<comment>Description:</comment>
  Récupère une ligne d'un fichier et supprime les balises HTML
  
  Identique à la méthode SplFileObject::fgets, sauf que la méthode SplFileObject::fgetss tente de
  supprimer toutes les balises HTML et PHP du texte lu. La fonction conserve l'état de l'analyse
  d'appel en appel, et ainsi n'est pas équivalent à l'appel de <strong>strip_tags()</strong> sur la valeur de retour
  de SplFileObject::fgets.

<comment>Param:</comment>
  <info>string</info>  <strong>$allowable_tags</strong>  Paramètre optionnel pour spécifier les balises qui ne doivent pas être
                           supprimées.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères contenant la prochaine ligne du fichier dont les balises
          HTML et PHP ont été supprimées, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>fgetss()</strong>
   * SplFileObject::fgets
   * SplFileObject::fgetc
   * SplFileObject::current
   * Le filtre string.strip_tags


id: SplFileObject::flock
type: function
doc:
<comment>Description:</comment>
  Verrouille ou déverrouille un fichier
  
  Verrouille ou déverrouille un fichier, de la même façon que la fonction <strong>flock()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$operation</strong>   Le paramètre <strong>$operation</strong> peut prendre une des constantes suivantes : <info>LOCK_SH</info> pour
                    acquérir un verrou partagé (lecture). <info>LOCK_EX</info> pour acquérir un verrou exclusif
                    (écriture). <info>LOCK_UN</info> pour déverrouiller le fichier (partagé ou exclusif).
                    
                    <info>LOCK_SH</info> pour acquérir un verrou partagé (lecture).
                    
                    <info>LOCK_EX</info> pour acquérir un verrou exclusif (écriture).
                    
                    <info>LOCK_UN</info> pour déverrouiller le fichier (partagé ou exclusif).
                    
                    Il est aussi possible d'ajouter <info>LOCK_NB</info> en tant qu'un masque binaire à l'une des
                    opérations ci-dessus, si <strong>flock()</strong> ne devrait pas bloquer lors de la tentative de
                    vérrouillage.
  <info>int</info>  <strong>$wouldBlock</strong>  Définit à <info>true</info> si le verrou doit être bloquant (condition pour l'errno
                    EWOULDBLOCK).

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


id: SplFileObject::fpassthru
type: function
doc:
<comment>Description:</comment>
  Affiche toutes les données en attente sur un pointeur de fichier
  
  Lit la fin d'un pointeur de fichier depuis la position courante et écrit le résultat dans le
  buffer d'affichage.
  
  Vous devez appeler la méthode SplFileObject::rewind pour réinitialiser le pointeur de fichier si
  vous avez déjà écrit des données dans le fichier.

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de caractères lus et passés au buffer d'affichage.

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


id: SplFileObject::fputcsv
type: function
doc:
<comment>Description:</comment>
  Écrit un tableau sous la forme d'une ligne CSV
  
  Écrit un tableau <strong>$fields</strong> sous la forme d'une ligne CSV.

<comment>Param:</comment>
  <info>array</info>   <strong>$fields</strong>     Un tableau de valeurs.
  <info>string</info>  <strong>$separator</strong>  Le paramètre optionnel <strong>$delimiter</strong> définit le délimiteur de champs (un
                      caractère d'un seul octet).
  <info>string</info>  <strong>$enclosure</strong>  Le paramètre optionnel <strong>$enclosure</strong> définit le caractère entourant le champ (un
                      caractère d'un seul octet).
  <info>string</info>  <strong>$escape</strong>     Le paramètre optionnel <strong>$escape</strong> définit le caractère d'échappement (au plus un
                      caractère d'un seul octet). Une chaîne de caractères vide (<return>""</return>) désactive le
                      mécanisme d'échappement propriétaire.
  <info>string</info>  <strong>$eol</strong>        Le paramètre optionnel <strong>$eol</strong> définit une séquence de fin de ligne (End of Line)
                      personnalisé.

<comment>Return:</comment>
  <info>int|false</info>  Retourne la longueur de la chaîne écrite ou <info>false</info> si une erreur survient.
             
             Retourne <info>false</info>, et n'écrit pas la ligne CSV dans le fichier si le paramètre <strong>$delimiter</strong>
             ou le paramètre <strong>$enclosure</strong> n'est pas un caractère unique.

<comment>See Also:</comment>
   * <strong>fputcsv()</strong>
   * SplFileObject::fgetcsv


id: SplFileObject::fread
type: function
doc:
<comment>Description:</comment>
  Lit depuis un fichier
  
  Lit un nombre donnée d'octets depuis le fichier.

<comment>Param:</comment>
  <info>int</info>  <strong>$length</strong>  Le nombre d'octets à lire.

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

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


id: SplFileObject::fscanf
type: function
doc:
<comment>Description:</comment>
  Analyse une entrée d'un fichier suivant un format donné
  
  Lit une ligne depuis un fichier et l'analyse suivant le format <strong>$format</strong> spécifié.
  
  Les espaces blancs dans la chaîne <strong>$format</strong> correspondent aux espaces blancs dans la ligne du
  fichier. Ceci signifie que une tabulation (<return>\t</return>) dans le format va correspondre à un seul caractère
  blanc dans le flux d'entrée.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  Le format interprété pour <strong>$string</strong> décrit dans la documentation de la <strong>sprintf()</strong>
                   avec les différences suivantes :  La fonction ne tient pas compte du contexte
                   local. <return>F</return>, <return>g</return>, <return>G</return> et <return>b</return> ne sont pas supportés. <return>D</return> représente un nombre décimal. <return>i</return>
                   représente un nombre entier avec détection de base. <return>n</return> représente le nombre de
                   caractères traités à ce stade. <return>s</return> arrête la lecture à chaque caractère
                   d'espacement. <return>*</return> au lieu de <return>argnum$</return> supprime l'affectation de cette spécification
                   de conversion.
  <info>mixed</info>   <strong>$vars</strong>    Les valeurs optionnelles assignées.

<comment>Return:</comment>
  <info>array|int|null</info>  Si seul 1 paramètre est passé à cette méthode, la valeur analysée sera retournée
                  sous la forme d'un tableau. Sinon, si les paramètres optionnelles sont passés, la
                  fonction retournera le nombre de valeurs assignées. Les paramètres optionnels
                  doivent être passés par référence.

<comment>See Also:</comment>
   * <strong>fscanf()</strong>
   * <strong>sscanf()</strong>
   * <strong>printf()</strong>
   * <strong>sprintf()</strong>


id: SplFileObject::fseek
type: function
doc:
<comment>Description:</comment>
  Se déplace à une position donnée
  
  Se déplace à une position donnée d'un fichier, mesurée en octets depuis le début du fichier,
  obtenue en ajoutant <strong>$offset</strong> à la position spécifiée par le paramètre <strong>$whence</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  La position. Une valeur négative peut être utilisée pour se déplacer en arrière dans
                le fichier, ce qui peut être utile lorsque SEEK_END est utilisé comme valeur du
                paramètre <strong>$whence</strong>.
  <info>int</info>  <strong>$whence</strong>  Les valeurs pour le paramètre <strong>$whence</strong> sont : <info>SEEK_SET</info> - La position sera égale à
                <strong>$offset</strong> octets.<info>SEEK_CUR</info> - La position sera égale à la position courante, plus
                <strong>$offset</strong>.<info>SEEK_END</info> - La position sera égale à la fin du fichier, plus <strong>$offset</strong>.
                
                Si <strong>$whence</strong> n'est pas spécifié, il prendra la valeur <info>SEEK_SET</info>.

<comment>Return:</comment>
  <info>int</info>  Retourne 0 si le déplacement s'est effectué avec succès, -1 sinon. Notez que la tentative de
       déplacement après la fin du fichier n'est pas considérée comme une erreur.

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


id: SplFileObject::fstat
type: function
doc:
<comment>Description:</comment>
  Récupère les informations d'un fichier
  
  Récupère les informations d'un fichier. Comportement identique à la fonction <strong>fstat()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant toutes les statistiques d'un fichier ; le format de ce
         tableau est décrit en détail dans la page du manuel sur la fonction <strong>stat()</strong>.

<comment>See Also:</comment>
   * <strong>fstat()</strong>
   * <strong>stat()</strong>


id: SplFileObject::ftell
type: function
doc:
<comment>Description:</comment>
  Retourne la position courant dans le fichier
  
  Retourne la position du pointeur de fichier, qui représentant la position courant dans le flux du
  fichier.

<comment>Return:</comment>
  <info>int|false</info>  Retourne la position du pointeur de fichier, sous la forme d'un entier ou <info>false</info> si une
             erreur survient.

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


id: SplFileObject::ftruncate
type: function
doc:
<comment>Description:</comment>
  Coupe le fichier à une longueur donnée
  
  Coupe le fichier à une longueur de <strong>$size</strong> octets.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  La taille à couper.
              
              Si <strong>$size</strong> est plus grand que le fichier, la portion récupérée sera complétée par des
              octets vides.
              
              Si <strong>$size</strong> est plus petit que le fichier, le reste du fichier sera perdu.

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


id: SplFileObject::fwrite
type: function
doc:
<comment>Description:</comment>
  Écrit dans le fichier
  
  Écrit le contenu du paramètre <strong>$str</strong> dans le fichier.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    La chaîne de caractères à écrire dans le fichier.
  <info>int</info>     <strong>$length</strong>  Si l'argument <strong>$length</strong> est fourni, l'écriture s'arrêtera après l'écriture de
                   <strong>$length</strong> octets ou bien lorsque la fin de la chaîne de caractères sera atteinte ;
                   suivant ce qui survient en premier.

<comment>Return:</comment>
  <info>int|false</info>  Retourne le nombre d'octets écrits, ou <info>false</info> si une erreur survient.

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


id: SplFileObject::getChildren
type: function
doc:
<comment>Description:</comment>
  Récupère le fils
  
  Un objet <class>SplFileObject</class> ne peut pas avoir de fils, aussi, cette méthode retournera toujours <info>null</info>.

<comment>Return:</comment>
  <info>null</info>  Retourne <info>null</info>.

<comment>See Also:</comment>
   * RecursiveIterator::getChildren


id: SplFileObject::getCsvControl
type: function
doc:
<comment>Description:</comment>
  Récupère les options pour CSV
  
  Récupère le séparateur, caractère d'échappement ainsi que le caractère utilisé pour entourer les
  champs lors d'une analyse CSV des données.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau indexé contenant le caractère utilisé pour délimiter les champs ainsi
         que celui utilisé pour les entourer et le caractère d'échappement.

<comment>See Also:</comment>
   * SplFileObject::setCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::getCurrentLine
type: function
doc:
<comment>Description:</comment>
  Alias de SplFileObject::fgets
  
  Cette méthode est un alias de:  SplFileObject::fgets.


id: SplFileObject::getFlags
type: function
doc:
<comment>Description:</comment>
  Récupère les drapeaux pour l'objet SplFileObject
  
  Récupère les drapeaux définis pour l'instance de l'objet SplFileObject, sous la forme d'un entier.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier représentant les drapeaux.

<comment>See Also:</comment>
   * SplFileObject::setFlags


id: SplFileObject::getMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Récupère la longueur maximale d'une ligne
  
  Récupère la longueur maximale d'une ligne, telle que définie par la méthode
  SplFileObject::setMaxLineLen.

<comment>Return:</comment>
  <info>int</info>  Retourne la longueur maximale d'une ligne si elle a été définie avec la méthode
       SplFileObject::setMaxLineLen ; par défaut, <return>0</return>.

<comment>See Also:</comment>
   * SplFileObject::setMaxLineLen


id: SplFileObject::hasChildren
type: function
doc:
<comment>Description:</comment>
  Vérifie si SplFileObject a un fils
  
  Un objet <class>SplFileObject</class> ne peut pas avoir de fils, aussi, cette méthode retournera toujours <info>false</info>.

<comment>Return:</comment>
  <info>false</info>  Retourne toujours <info>false</info>

<comment>See Also:</comment>
   * RecursiveIterator::hasChildren


id: SplFileObject::key
type: function
doc:
<comment>Description:</comment>
  Récupère le numéro de la ligne courant
  
  Récupère le numéro de la ligne courant.
  
  Ce nombre peut ne pas être exact si la méthode SplFileObject::setMaxLineLen est utilisée pour lire
  une longueur fixe du fichier.

<comment>Return:</comment>
  <info>int</info>  Retourne le numéro de la ligne courante.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::next
type: function
doc:
<comment>Description:</comment>
  Se déplace sur la prochaine ligne
  
  Se déplace sur la prochaine ligne du fichier.

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::rewind
type: function
doc:
<comment>Description:</comment>
  Réinitialise le fichier à la première ligne
  
  Réinitialise le fichier à la première ligne.

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::valid


id: SplFileObject::seek
type: function
doc:
<comment>Description:</comment>
  Se déplace sur une ligne spécifique
  
  Se déplace sur une ligne spécifique du fichier.

<comment>Param:</comment>
  <info>int</info>  <strong>$line</strong>  Le numéro de la ligne (en commençant par 0) sur laquelle on se déplace.

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

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::next
   * SplFileObject::rewind
   * SplFileObject::valid


id: SplFileObject::setCsvControl
type: function
doc:
<comment>Description:</comment>
  Définit les options CSV
  
  Définit le délimiteur, le caratère d'échappement ainsi que le caractère utilisé pour entourer les
  champs CSV analysés.

<comment>Param:</comment>
  <info>string</info>  <strong>$separator</strong>  Le délimiteur de champs (un caractère d'un seul octet).
  <info>string</info>  <strong>$enclosure</strong>  Le caractère utilisé pour entourer le champ (un caractère d'un seul octet).
  <info>string</info>  <strong>$escape</strong>     Le caractère utilisé pour échapper les données (au plus un caractère d'un seul
                      octet). Une chaîne de caractères vide (<return>""</return>) désactive le mécanisme
                      d'échappement propriétaire.

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

<comment>See Also:</comment>
   * SplFileObject::getCsvControl
   * SplFileObject::fgetcsv


id: SplFileObject::setFlags
type: function
doc:
<comment>Description:</comment>
  Définit les drapeaux pour l'objet SplFileObject
  
  Définit les drapeaux à utiliser par l'objet <class>SplFileObject</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Un masque de drapeaux à définir. Voir les constantes SplFileObject pour une liste
               complète.

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

<comment>See Also:</comment>
   * SplFileObject::getFlags


id: SplFileObject::setMaxLineLen
type: function
doc:
<comment>Description:</comment>
  Définit la longueur maximale d'une ligne
  
  Définit la longueur maximale d'une ligne.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxLength</strong>  La longueur maximale d'une ligne.

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

<comment>See Also:</comment>
   * SplFileObject::getMaxLineLen


id: SplFileObject::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si la fin du fichier a été atteinte
  
  Vérifie si la fin du fichier a été atteinte.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la fin n'est pas atteinte, <info>false</info> sinon.

<comment>See Also:</comment>
   * SplFileObject::current
   * SplFileObject::key
   * SplFileObject::seek
   * SplFileObject::next
   * SplFileObject::rewind


id: SplFixedArray
type: class
doc:
<comment>Description:</comment>
  La classe <class>SplFixedArray</class> fournit les fonctionnalités principales d'un tableau. La différence
  majeure entre un objet  <class>SplFixedArray</class> et un tableau standard de PHP est que <class>SplFixedArray</class> doit
  être redimensionné manuellement, et n'utilise que des entier dans cette plage pour les index.
  L'avantage est qu'il utilise moins de mémoire qu'un tableau standard.


id: SplFixedArray::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouveau SplFixedArray
  
  Initialise un tableau fixe avec un nombre de valeurs <info>null</info> égales au paramètre <strong>$size</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  La taille du tableau à taille fixe. Attends un nombre compris entre <return>0</return> et <info>PHP_INT_MAX</info>.


id: SplFixedArray::__serialize
type: function
doc:
<comment>Description:</comment>
  Serializes the SplFixedArray object
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: SplFixedArray::__unserialize
type: function
doc:
<comment>Description:</comment>
  Deserializes the data parameter into an SplFixedArray object
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  The value being deserialized.

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


id: SplFixedArray::__wakeup
type: function
doc:
<comment>Description:</comment>
  Ré-initialise le tableau après sa désérialisation
  
  Ré-initialise le tableau après sa désérialisation.

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


id: SplFixedArray::count
type: function
doc:
<comment>Description:</comment>
  Retourne la taille du tableau à taille fixe
  
  Retourne la taille du tableau à taille fixe.

<comment>Return:</comment>
  <info>int</info>  Retourne la taille du tableau à taille fixe.

<comment>See Also:</comment>
   * SplFixedArray::getSize


id: SplFixedArray::current
type: function
doc:
<comment>Description:</comment>
  Lit l'élément courant du tableau à taille fixe
  
  Lit l'élément courant du tableau à taille fixe.

<comment>Return:</comment>
  <info>mixed</info>  La valeur de l'élément courant.


id: SplFixedArray::fromArray
type: function
doc:
<comment>Description:</comment>
  Importe un tableau PHP dans un tableau à taille fixe
  
  Importe le tableau PHP <strong>$array</strong>  dans un tableau à taille fixe.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>         La tableau à importer.
  <info>bool</info>   <strong>$preserveKeys</strong>  Tente de préserver les index numérique du tableau original.

<comment>Return:</comment>
  <info>SplFixedArray</info>  Retourne un objet <class>SplFixedArray</class> avec le même contenu que le tableau passé en
                 argument.


id: SplFixedArray::getIterator
type: function
doc:
<comment>Description:</comment>
  Retrieve the iterator to go through the array
  
  Returns the iterator to go through the array.

<comment>Return:</comment>
  <info>Iterator</info>  An instance of an object implementing <class>Iterator</class> to go through the array.


id: SplFixedArray::getSize
type: function
doc:
<comment>Description:</comment>
  Lit la taille du tableau à taille fixe
  
  Lit la taille du tableau à taille fixe.

<comment>Return:</comment>
  <info>int</info>  Retourne la taille du tableau, en tant que entier.

<comment>See Also:</comment>
   * SplFixedArray::count


id: SplFixedArray::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON
  
  Serializes the array to a value that can be serialized natively by <strong>json_encode()</strong>.

<comment>Return:</comment>
  <info>mixed</info>  Returns array data which can be serialized by <strong>json_encode()</strong>, which is a value of any type
         other than a ressource.


id: SplFixedArray::key
type: function
doc:
<comment>Description:</comment>
  Retourne l'index de la position courante
  
  Retourne l'index de la position courante.

<comment>Return:</comment>
  <info>int</info>  L'index de la position courante.


id: SplFixedArray::next
type: function
doc:
<comment>Description:</comment>
  Déplace l'itérateur à l'élément suivant
  
  Déplace l'itérateur à l'élément suivant.

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


id: SplFixedArray::offsetExists
type: function
doc:
<comment>Description:</comment>
  Vérifie si l'index demandé existe
  
  Vérifie si l'index <strong>$index</strong> existe.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  L'index à vérifier.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si l'index <strong>$index</strong> existe, sinon <info>false</info>


id: SplFixedArray::offsetGet
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur à l'index donné
  
  Retourne la valeur à l'index <strong>$index</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  L'index de la valeur demandée.

<comment>Return:</comment>
  <info>mixed</info>  La valeur spécifiée à l'index <strong>$index</strong>.


id: SplFixedArray::offsetSet
type: function
doc:
<comment>Description:</comment>
  Affecte une valeur à un index donné
  
  Affecte la valeur <strong>$value</strong> à l'index  <strong>$index</strong>.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  L'index à affecter.
  <info>mixed</info>  <strong>$value</strong>  La valeur à assigner à l'index <strong>$index</strong>.

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


id: SplFixedArray::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Détruit l'élément à un index donné
  
  Détruit l'élément à l'index <strong>$index</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  L'index de l'élément à détruire.

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


id: SplFixedArray::rewind
type: function
doc:
<comment>Description:</comment>
  Remet l'itérateur au début du tableau à taille fixe
  
  Remet l'itérateur au début du tableau à taille fixe.

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


id: SplFixedArray::setSize
type: function
doc:
<comment>Description:</comment>
  Change la taille d'un tableau à taille fixe
  
  Change la taille d'un tableau à la taille fixe <strong>$size</strong>. Si <strong>$size</strong> est inférieur à la taille courante
  du tableau, toutes les valeurs après la nouvelle taille seront ignorées. Si <strong>$size</strong> est plus grand
  que la taille courante du tableau, le tableau sera complété par des valeurs de type <info>null</info>.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  La nouvelle taille du tableau. Doit être une valeur entre <return>0</return> et <info>PHP_INT_MAX</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.


id: SplFixedArray::toArray
type: function
doc:
<comment>Description:</comment>
  Retourne un tableau PHP à partir d'un tableau à taille fixe
  
  Retourne un tableau PHP à partir d'un tableau à taille fixe.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau PHP à partir d'un tableau à taille fixe.


id: SplFixedArray::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si le tableau contient encore un élément
  
  Vérifie si le tableau contient encore un élément.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le tableau contient encore un élément, <info>false</info> sinon.


id: SplHeap::compare
type: function
doc:
<comment>Description:</comment>
  Compare deux éléments
  
  Compare la valeur <strong>$value1</strong> et la valeur <strong>$value2</strong>.
  
  L'envoi d'exception dans SplHeap::compare peut le corrompre et le placer dans un statut bloqué.
  Vous pouvez le débloquer en appelant la méthode SplHeap::recoverFromCorruption. Cependant, des
  éléments peuvent ne pas avoir été placés correctement.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  La valeur du premier nœud à comparer.
  <info>mixed</info>  <strong>$value2</strong>  La valeur du second nœud à comparer.

<comment>Return:</comment>
  <info>int</info>  Le résultat de la comparaison ; un entier positif si <strong>$value1</strong> est plus grand que <strong>$value2</strong>, 0
       s'ils sont égaux, ou un entier négatif sinon.
       
       Avoir plusieurs éléments avec la même valeur dans un tas n'est pas recommandé. Cela peut
       conduire en une position arbitraire.


id: SplHeap::count
type: function
doc:
<comment>Description:</comment>
  Compte le nombre d'éléments dans le tas

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre d'éléments dans le tas.


id: SplHeap::current
type: function
doc:
<comment>Description:</comment>
  Retourne le nœud courant, pointé par l'itérateur
  
  Récupère la structure des données du nœud courant.

<comment>Return:</comment>
  <info>mixed</info>  La valeur du nœud courant.


id: SplHeap::extract
type: function
doc:
<comment>Description:</comment>
  Extrait un nœud du haut du tas

<comment>Return:</comment>
  <info>mixed</info>  La valeur du nœud extrait.


id: SplHeap::insert
type: function
doc:
<comment>Description:</comment>
  Insère un élément dans le tas
  
  Insère la valeur <strong>$value</strong> dans le tas.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  La valeur à insérer.

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


id: SplHeap::isCorrupted
type: function
doc:
<comment>Description:</comment>
  Informe si le tas est dans un état corrompu

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la tas est corrompu, <info>false</info> sinon.


id: SplHeap::isEmpty
type: function
doc:
<comment>Description:</comment>
  Vérifie si le tas est vide

<comment>Return:</comment>
  <info>bool</info>  Retourne si le tas est vide, ou non.


id: SplHeap::next
type: function
doc:
<comment>Description:</comment>
  Se déplace au nœud suivant
  
  Se déplace au nœud suivant. Ceci va supprimer le plus haut nœud de la pile.

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


id: SplHeap::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  Répare un tas

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


id: SplHeap::rewind
type: function
doc:
<comment>Description:</comment>
  Revient au début de l'itérateur
  
  Revient au début de l'itérateur.

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


id: SplHeap::top
type: function
doc:
<comment>Description:</comment>
  Récupère le premier nœud du tas

<comment>Return:</comment>
  <info>mixed</info>  La valeur du premier nœud.


id: SplHeap::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si le tas contient des nœuds
  
  Vérifie si le tas contient encore des nœuds.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le tas contient encore des nœuds, <info>false</info> sinon.


id: SplMaxHeap
type: class
doc:
<comment>Description:</comment>
  La classe SplMaxHeap fournit l'interface pour un tas, et conserve le maximum sur le haut.


id: SplMaxHeap::compare
type: function
doc:
<comment>Description:</comment>
  Compare deux éléments
  
  Compare la valeur <strong>$value1</strong> avec la valeur <strong>$value2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  La valeur du premier nœud à comparer.
  <info>mixed</info>  <strong>$value2</strong>  La valeur du second nœud à comparer.

<comment>Return:</comment>
  <info>int</info>  Le résultat de la comparaison ; un entier positif si la valeur <strong>$value1</strong> est plus grande que la
       valeur <strong>$value2</strong>, 0 si les valeurs sont égales, et un entier négatif sinon.
       
       Avoir plusieurs éléments avec la même valeur dans un tas n'est pas recommandé. Cela peut
       conduire en des positions arbitraires.


id: SplMinHeap
type: class
doc:
<comment>Description:</comment>
  La classe SplMinHeap fournit une interface pour un tas, qui conserve le minimum sur le haut.


id: SplMinHeap::compare
type: function
doc:
<comment>Description:</comment>
  Compare deux éléments
  
  Compare la valeur <strong>$value1</strong> avec la valeur <strong>$value2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value1</strong>  La valeur du premier nœud à comparer.
  <info>mixed</info>  <strong>$value2</strong>  La valeur du second nœud à comparer.

<comment>Return:</comment>
  <info>int</info>  Le résultat de la comparaison ; un entier positif si la valeur <strong>$value1</strong> est plus petite que la
       valeur <strong>$value2</strong>, 0 si les valeurs sont égales, et un entier négatif sinon.
       
       Avoir plusieurs éléments avec la même valeur dans un tas n'est pas recommandé. Cela peut
       conduire en des positions arbitraires.


id: SplObjectStorage
type: class
doc:
<comment>Description:</comment>
  La classe <class>SplObjectStorage</class> fournit une carte d'objets ou de données, ou encore, en ignorant les
  index, un ensemble d'objets. Ce double objectif est utile dans de nombreuses situations, où il
  faut identifier de manière unique des objets.


id: SplObjectStorage::addAll
type: function
doc:
<comment>Description:</comment>
  Ajoute tous les objets d'un autre stockage
  
  Ajoute tous les objets de l'ensemble <strong>$storage</strong>.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  Le stockage à importer.

<comment>Return:</comment>
  <info>int</info>  Le nombre d'objets dans le stockage.

<comment>See Also:</comment>
   * SplObjectStorage::removeAll


id: SplObjectStorage::attach
type: function
doc:
<comment>Description:</comment>
  Ajoute un objet dans le stockage
  
  Ajoute un objet dans le stockage, et lui associe  éventuellement des données.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet à ajouter.
  <info>mixed</info>   <strong>$info</strong>    Les données à associer avec l'objet.

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

<comment>See Also:</comment>
   * SplObjectStorage::detach
   * SplObjectStorage::offsetSet


id: SplObjectStorage::contains
type: function
doc:
<comment>Description:</comment>
  Vérifie si un stockage contient un objet
  
  Vérifie si le stockage contient l'objet <strong>$object</strong>.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet à rechercher.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si l'objet est dans le stockage, et <info>false</info> sinon.

<comment>See Also:</comment>
   * SplObjectStorage::offsetExists


id: SplObjectStorage::count
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre d'objets dans le stockage
  
  Compte le nombre d'objets dans le stockage.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Si le paramètre optionnel <strong>$mode</strong> est réglé à <info>COUNT_RECURSIVE</info> (ou 1),
              <strong>SplObjectStorage::count()</strong> comptera récursivement le nombre d'objets dans le stockage.

<comment>Return:</comment>
  <info>int</info>  Le nombre d'objets dans le stockage.

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::detach


id: SplObjectStorage::current
type: function
doc:
<comment>Description:</comment>
  Retourne l'objet courant
  
  Retourne l'objet courant.

<comment>Return:</comment>
  <info>object</info>  L'objet à la position courante de l'itérateur.

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


id: SplObjectStorage::detach
type: function
doc:
<comment>Description:</comment>
  Retire un objet du stockage
  
  Retire un objet du stockage.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet à retirer.

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

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::removeAll


id: SplObjectStorage::getHash
type: function
doc:
<comment>Description:</comment>
  Calcule un identifiant unique pour les objets contenus
  
  Cette méthode calcule un identifiant pour les objets ajoutés dans l'objet <class>SplObjectStorage</class>.
  
  L'implémentation dans <class>SplObjectStorage</class> retourne la même valeur que <strong>spl_object_hash()</strong>.
  
  Cet objet de stockage ne doit pas contenir plus d'un objet avec le même identifiant. Aussi, il
  peut être utilisé pour implémenter un jeu (une collection de valeurs uniques) où la qualité d'un
  objet unique est déterminé par la valeur retournée par cette fonction.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet dont nous devons calculer l'identifiant.

<comment>Return:</comment>
  <info>string</info>  Une chaîne de caractères représentant l'identifiant calculé.

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


id: SplObjectStorage::getInfo
type: function
doc:
<comment>Description:</comment>
  Retourne les données associés à l'élément en cours
  
  Retourne les données, ou informations, associées avec l'objet actuellement pointé dans l'itérateur
  courant.

<comment>Return:</comment>
  <info>mixed</info>  Les données associées avec la position courante.

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::setInfo


id: SplObjectStorage::key
type: function
doc:
<comment>Description:</comment>
  Retourne l'index de l'objet courant
  
  Retourne l'index de l'objet courant.

<comment>Return:</comment>
  <info>int</info>  L'index de la position courante dans l'itérateur.

<comment>See Also:</comment>
   * SplObjectStorage::rewind
   * SplObjectStorage::current
   * SplObjectStorage::next
   * SplObjectStorage::valid


id: SplObjectStorage::next
type: function
doc:
<comment>Description:</comment>
  Passe au prochain élément
  
  Avance l'itérateur d'un élément dans le stockage.

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

<comment>See Also:</comment>
   * SPLObjectStorage::rewind


id: SplObjectStorage::offsetExists
type: function
doc:
<comment>Description:</comment>
  Vérifie si un objet existe dans le stockage
  
  Vérifie si un objet existe dans un stockage.
  
  SplObjectStorage::offsetExists est un alias de la méthode SplObjectStorage::contains.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet à rechercher.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si l'objet existe, et <info>false</info> sinon.

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetGet
type: function
doc:
<comment>Description:</comment>
  Retourne les données associées à un objet
  
  Retourne les données associées à un objet dans le stockage.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet à rechercher.

<comment>Return:</comment>
  <info>mixed</info>  Les données précédemment associées avec l'objet.

<comment>See Also:</comment>
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetSet
type: function
doc:
<comment>Description:</comment>
  Associe des données à un stockage
  
  Associe des données à un objet du stockage.
  
  SplObjectStorage::offsetSet est un alias de  SplObjectStorage::attach.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet à qui il faut associer les données.
  <info>mixed</info>   <strong>$info</strong>    Les données à associer avec l'objet.

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

<comment>See Also:</comment>
   * SplObjectStorage::attach
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetExists
   * SplObjectStorage::offsetUnset


id: SplObjectStorage::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Retire un objet du stockage
  
  Retire un objet du stockage.
  
  SplObjectStorage::offsetUnset est un alias de SplObjectStorage::detach.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet à retirer.

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

<comment>See Also:</comment>
   * SplObjectStorage::offsetGet
   * SplObjectStorage::offsetSet
   * SplObjectStorage::offsetExists


id: SplObjectStorage::removeAll
type: function
doc:
<comment>Description:</comment>
  Retire les objets d'un stockage qui appartienne à un autre stockage
  
  Retire les objets d'un stockage qui appartienne à un autre stockage.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  Le stockage contenant les éléments à retirer.

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre d'objets restants.

<comment>See Also:</comment>
   * SplObjectStorage::addAll


id: SplObjectStorage::removeAllExcept
type: function
doc:
<comment>Description:</comment>
  Supprime tous les objets du stockage courant sauf ceux contenus dans d'autres stockages
  
  Supprime tous les objets du stockage courant sauf ceux contenus dans d'autres stockages.

<comment>Param:</comment>
  <info>SplObjectStorage</info>  <strong>$storage</strong>  Le stockage contenant les éléments à ne pas supprimer du stockage
                              courant.

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre d'objets restants.


id: SplObjectStorage::rewind
type: function
doc:
<comment>Description:</comment>
  Remet l'itérateur au début
  
  Remet l'itérateur au début.

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

<comment>See Also:</comment>
   * SplObjectStorage::next


id: SplObjectStorage::serialize
type: function
doc:
<comment>Description:</comment>
  Sérialise un stockage
  
  Retourne une chaîne représentant un stockage.

<comment>Return:</comment>
  <info>string</info>  Une chaîne de caractères représentant le stockage.

<comment>See Also:</comment>
   * SplObjectStorage::unserialize


id: SplObjectStorage::setInfo
type: function
doc:
<comment>Description:</comment>
  Modifie les données associée à l'élément courant
  
  Associe des données, ou informations, à l'objet courant de l'itérateur.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$info</strong>  Les données à associer avec la position courante de l'itérateur.

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

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::rewind
   * SplObjectStorage::key
   * SplObjectStorage::next
   * SplObjectStorage::valid
   * SplObjectStorage::getInfo


id: SplObjectStorage::unserialize
type: function
doc:
<comment>Description:</comment>
  Désérialise un stockage à partir de sa forme en chaîne
  
  Désérialise un stockage à partir de sa forme en chaîne.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  La représentation sérialisée d'un stockage.

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

<comment>See Also:</comment>
   * SplObjectStorage::serialize


id: SplObjectStorage::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si l'élément courant est valide
  
  Vérifie si l'élément courant est valide.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si l'élément courant est valide, et <info>false</info> sinon.

<comment>See Also:</comment>
   * SplObjectStorage::current
   * SplObjectStorage::getInfo


id: SplObserver
type: class
doc:
<comment>Description:</comment>
  L'interface <class>SplObserver</class> est utilisée conjointement avec la classe <class>SplSubject</class> pour l'implémentation
  du patron de conception Observateur.


id: SplObserver::update
type: function
doc:
<comment>Description:</comment>
  Réception d'une mise à jour depuis un sujet
  
  Cette méthode est appelée lorsqu'un des objets <class>SplSubject</class> depuis lequel l'observateur est attaché,
  appelle la méthode SplSubject::notify.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>SplSubject</info>  <strong>$subject</strong>  L'objet <class>SplSubject</class> notifiant l'observateur d'une mise à jour.

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


id: SplPriorityQueue
type: class
doc:
<comment>Description:</comment>
  La classe <class>SplPriorityQueue</class> fournit les  fonctionnalités principales d'une queue à priorités,
  implémentées avec une pile maximale.
  
  L'ordre des éléments qui ont une priorité identique est undefined. Il peut être différent que
  l'ordre dans lequel ils ont été inséré.


id: SplPriorityQueue::compare
type: function
doc:
<comment>Description:</comment>
  Compare deux priorités
  
  Compare la valeur <strong>$priority1</strong> avec la valeur <strong>$priority2</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$priority1</strong>  La priorité du premier nœud à comparer.
  <info>mixed</info>  <strong>$priority2</strong>  La priorité du second nœud à comparer.

<comment>Return:</comment>
  <info>int</info>  Le résultat de la comparaison ; un entier positif si la valeur <strong>$priority1</strong> est plus grande que
       la valeur <strong>$priority2</strong>, 0 si les valeurs sont égales, et un entier négatif sinon.
       
       Avoir plusieurs éléments avec la même priorité fera qu'ils n'auront pas d'ordre particulier.


id: SplPriorityQueue::count
type: function
doc:
<comment>Description:</comment>
  Compte le nombre d'éléments dans la file d'attente

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre d'éléments dans la file d'attente.


id: SplPriorityQueue::current
type: function
doc:
<comment>Description:</comment>
  Retourne le nœud courant, pointé par l'itérateur
  
  Récupère le nœud courant.

<comment>Return:</comment>
  <info>mixed</info>  La valeur ou la priorité (ou les deux) du nœud courant, suivant le drapeau d'extraction.


id: SplPriorityQueue::extract
type: function
doc:
<comment>Description:</comment>
  Extrait un nœud depuis le haut du tas

<comment>Return:</comment>
  <info>mixed</info>  La valeur ou la priorité (ou les deux) du nœud extrait, suivant le drapeau d'extraction.


id: SplPriorityQueue::getExtractFlags
type: function
doc:
<comment>Description:</comment>
  Récupère les drapeaux d'extraction
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int</info>  Retourne les drapeaux d'extraction.


id: SplPriorityQueue::insert
type: function
doc:
<comment>Description:</comment>
  Insère un élément dans la file d'attente
  
  Insère la valeur <strong>$value</strong> avec la priorité <strong>$priority</strong> dans la file d'attente.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>     La valeur à insérer.
  <info>mixed</info>  <strong>$priority</strong>  La priorité associée.

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


id: SplPriorityQueue::isCorrupted
type: function
doc:
<comment>Description:</comment>
  Informe si la file prioritaire est dans un état corrompue

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la file prioritaire est corrompue, <info>false</info> sinon.


id: SplPriorityQueue::isEmpty
type: function
doc:
<comment>Description:</comment>
  Vérifie si la file est vide

<comment>Return:</comment>
  <info>bool</info>  Retourne si la file d'attente est vide, ou non.


id: SplPriorityQueue::next
type: function
doc:
<comment>Description:</comment>
  Se déplace sur le prochain nœud
  
  Se déplace sur le prochain nœud.

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


id: SplPriorityQueue::recoverFromCorruption
type: function
doc:
<comment>Description:</comment>
  Répare une file d'attente

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


id: SplPriorityQueue::rewind
type: function
doc:
<comment>Description:</comment>
  Revient au début de l'itérateur
  
  Replace l'itérateur au début.

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


id: SplPriorityQueue::setExtractFlags
type: function
doc:
<comment>Description:</comment>
  Définit le mode d'extraction

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Définit ce qui sera extrait par la fonction SplPriorityQueue::current,
               SplPriorityQueue::top et SplPriorityQueue::extract.
               
               <info>SplPriorityQueue::EXTR_DATA</info> (0x00000001): Extrait les données
               
               <info>SplPriorityQueue::EXTR_PRIORITY</info> (0x00000002): Extrait la priorité
               
               <info>SplPriorityQueue::EXTR_BOTH</info> (0x00000003): Extrait un tableau contenant les deux
               
               Le mode par défaut vaut : <info>SplPriorityQueue::EXTR_DATA</info>.

<comment>Return:</comment>
  <info>int</info>  Retourne les drapeaux d'extraction.


id: SplPriorityQueue::top
type: function
doc:
<comment>Description:</comment>
  Récupère le nœud du haut de la file d'attente

<comment>Return:</comment>
  <info>mixed</info>  La valeur ou la priorité (ou les deux) du premier nœud, suivant le drapeau d'extraction.


id: SplPriorityQueue::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si la file d'attente contient encore des nœuds
  
  Vérifie si la file d'attente contient encore des nœuds.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la file d'attente contient encore des nœuds, <info>false</info> sinon.


id: SplQueue
type: class
doc:
<comment>Description:</comment>
  La classe SplQueue fournit l'interface d'implémentation d'une queue, basée sur une liste
  doublement chaînée en définissant le mode de l'itérateur à <info>SplDoublyLinkedList::IT_MODE_FIFO</info>.


id: SplQueue::dequeue
type: function
doc:
<comment>Description:</comment>
  Supprime un nœud de la file d'attente
  
  Supprime la valeur <strong>$value</strong> du haut de la file d'attente.
  
  SplQueue::dequeue est un alias de SplDoublyLinkedList::shift.

<comment>Return:</comment>
  <info>mixed</info>  La valeur du nœud supprimé.


id: SplQueue::enqueue
type: function
doc:
<comment>Description:</comment>
  Ajoute un élément à la file d'attente
  
  Ajoute la valeur <strong>$value</strong> à la fin de la file d'attente.
  
  SplQueue::enqueue est un alias de SplDoublyLinkedList::push.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  La valeur à ajouter à la file d'attente.

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


id: SplStack
type: class
doc:
<comment>Description:</comment>
  La classe SplStack fournit l'interface de base pour implémenter une pile, basée sur une liste
  doublement chaînée en définissant le mode de l'itérateur à <info>SplDoublyLinkedList::IT_MODE_LIFO</info>.


id: SplSubject
type: class
doc:
<comment>Description:</comment>
  L'interface <class>SplSubject</class> est utilisée conjointement avec la classe <class>SplObserver</class> pour l'implémentation
  du patron de conception Observateur.


id: SplSubject::attach
type: function
doc:
<comment>Description:</comment>
  Attache un SplObserver
  
  Attache un <class>SplObserver</class>. Il sera ainsi notifier des mises à jour.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  L'observateur <class>SplObserver</class> à attacher.

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


id: SplSubject::detach
type: function
doc:
<comment>Description:</comment>
  Détache un observateur
  
  Détache un observateur d'un sujet. Il ne sera ainsi plus notifié des mises à jour.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>SplObserver</info>  <strong>$observer</strong>  L'observateur <class>SplObserver</class> à détacher.

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


id: SplSubject::notify
type: function
doc:
<comment>Description:</comment>
  Notifie un observateur
  
  Notifie tous les observateurs attachés.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: SplTempFileObject
type: class
doc:
<comment>Description:</comment>
  La classe SplTempFileObject offre une interface orientée objet pour un fichier temporaire.


id: SplTempFileObject::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet représentant un fichier temporaire
  
  Construit un nouvel objet représentant un fichier temporaire.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxMemory</strong>  La mémoire maximale (en octets, par défaut, 2 Mo) à utiliser pour le fichier
                   temporaire. Si un fichier temporaire dépasse cette taille, il sera déplacé sur le
                   système de fichiers, dans le dossier des fichiers temporaires.
                   
                   Si <strong>$maxMemory</strong> est négatif, seule la mémoire sera utilisée. Si <strong>$maxMemory</strong> vaut
                   zéro, la mémoire ne sera pas utilisée.

<comment>See Also:</comment>
   * <class>SplFileObject</class>
   * Flux PHP input/output 
     (pour <return>php://temp</return> et <return>php://memory</return>)
    


id: Spoofchecker
type: class
doc:
<comment>Description:</comment>
  Cette classe est fournie car Unicode contient un grand nombre de caractères et incorpore les
  systèmes d'écriture variés du monde et leur utilisation incorrecte peut exposer des programmes ou
  des systèmes à d'éventuelles attaques de sécurité en utilisant la similarité des caractères.
  
  Les méthodes fournies permettent de vérifier si une chaîne individuelle est susceptible d'être une
  tentative à tromper le lecteur (<return>détection de tromperie</return>), tel que dans "pаypаl" orthographié avec
  un caractère 'а' cyrillique.


id: Spoofchecker::areConfusable
type: function
doc:
<comment>Description:</comment>
  Vérifie si les chaînes données peuvent être confondues
  
  Vérifie si deux chaînes données peuvent facilement être confondues.

<comment>Param:</comment>
  <info>string</info>  <strong>$string1</strong>    Première chaîne à vérifier.
  <info>string</info>  <strong>$string2</strong>    Deuxième chaîne à vérifier.
  <info>int</info>     <strong>$errorCode</strong>  Cette variable est définie par référence à un entier contenant une erreur,
                      s'il y en avait.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si les deux chaînes données peuvent être confondues, et <info>false</info> sinon.


id: Spoofchecker::isSuspicious
type: function
doc:
<comment>Description:</comment>
  Vérifie si un texte contient des caractères suspects
  
  Vérifie si la chaîne donnée contient des caractères suspects comme des  lettres qui sont presque
  identiques visuellement, mais sont des caractères  Unicode de différents ensembles.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>     Chaîne à tester.
  <info>int</info>     <strong>$errorCode</strong>  Cette variable est définie par référence à un entier contenant une erreur,
                      s'il y en avait.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> s'il y a des caractères suspects, et <info>false</info> sinon.


id: Spoofchecker::setAllowedLocales
type: function
doc:
<comment>Description:</comment>
  Locales à utiliser lors de la vérification
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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

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


id: Spoofchecker::setChecks
type: function
doc:
<comment>Description:</comment>
  Spécifie les vérifications à effectuer
  
  Définit les contrôles qui seront effectués par SpoofChecker::isSuspicious.

<comment>Param:</comment>
  <info>int</info>  <strong>$checks</strong>  Les contrôles qui seront effectués par SpoofChecker::isSuspicious. Un masque de bits
                de <info>Spoofchecker::SINGLE_SCRIPT_CONFUSABLE</info>, <info>Spoofchecker::MIXED_SCRIPT_CONFUSABLE</info>,
                <info>Spoofchecker::WHOLE_SCRIPT_CONFUSABLE</info>, <info>Spoofchecker::ANY_CASE</info>,
                <info>Spoofchecker::SINGLE_SCRIPT</info>, <info>Spoofchecker::INVISIBLE</info> ou <info>Spoofchecker::CHAR_LIMIT</info>.
                Par défaut, toutes les vérifications à partir de ICU 58 ; avant cette version,
                <info>Spoofchecker::SINGLE_SCRIPT</info> était exclu.

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


id: Spoofchecker::setRestrictionLevel
type: function
doc:
<comment>Description:</comment>
  Set the restriction level
  
  Sets the restriction level of SpoofChecker::isSuspicious.

<comment>Param:</comment>
  <info>int</info>  <strong>$level</strong>  The restriction level of SpoofChecker::isSuspicious. One of <info>Spoofchecker::ASCII</info>,
               <info>Spoofchecker::SINGLE_SCRIPT_RESTRICTIVE</info>, <info>Spoofchecker::HIGHLY_RESTRICTIVE</info>,
               <info>Spoofchecker::MODERATELY_RESTRICTIVE</info>, <info>Spoofchecker::MINIMALLY_RESTRICTIVE</info>, or
               <info>Spoofchecker::UNRESTRICTIVE</info>. Defaults to <info>Spoofchecker::HIGHLY_RESTRICTIVE</info>.

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


id: SqlStatement::__construct
type: function
doc:
<comment>Description:</comment>
  Description constructor
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.


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

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

<comment>Return:</comment>
  <info>mysql_xdevapi\SqlStatement</info>  


id: SqlStatement::execute
type: function
doc:
<comment>Description:</comment>
  Execute the operation
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::getNextResult
type: function
doc:
<comment>Description:</comment>
  Get next result
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::getResult
type: function
doc:
<comment>Description:</comment>
  Get result
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  


id: SqlStatement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  Check for more results
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the result set has more objects to fetch.


id: SqlStatementResult::fetchAll
type: function
doc:
<comment>Description:</comment>
  Get all rows from result
  
  Fetch all the rows from the result set.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>array</info>  A numerical array with all results from the query; each result is an associative array. An
         empty array is returned if no rows are present.


id: SqlStatementResult::fetchOne
type: function
doc:
<comment>Description:</comment>
  Get single row
  
  Fetch one row from the result set.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>array</info>  The result, as an associative array. In case there is not any result, null will be
         returned.


id: SqlStatementResult::getAffectedItemsCount
type: function
doc:
<comment>Description:</comment>
  Get affected row count
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: SqlStatementResult::getColumnNames
type: function
doc:
<comment>Description:</comment>
  Get column names
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: SqlStatementResult::getColumns
type: function
doc:
<comment>Description:</comment>
  Get columns
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>Array</info>  


id: SqlStatementResult::getColumnsCount
type: function
doc:
<comment>Description:</comment>
  Get column count
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int</info>  The number of columns; 0 if there are none.


id: SqlStatementResult::getGeneratedIds
type: function
doc:
<comment>Description:</comment>
  Get generated ids
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>array</info>  An array of generated _id's from the last operation,  or an empty array if there are none.


id: SqlStatementResult::getLastInsertId
type: function
doc:
<comment>Description:</comment>
  Get last insert id
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>String</info>  The ID for the last insert operation.


id: SqlStatementResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Get warnings from last operation
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>array</info>  An array of Warning objects from the last operation. Each object defines an error
         'message', error 'level', and error 'code'. An empty array is returned if no errors are
         present.


id: SqlStatementResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  Get warning count from last operation
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int</info>  The number of warnings raised during the last CRUD operation.


id: SqlStatementResult::hasData
type: function
doc:
<comment>Description:</comment>
  Check if result has data
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the result set has data.


id: SqlStatementResult::nextResult
type: function
doc:
<comment>Description:</comment>
  Get next result
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  The next Result object from the result set.


id: Statement::hasMoreResults
type: function
doc:
<comment>Description:</comment>
  Check if more results
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: Stomp
type: class
doc:
<comment>Description:</comment>
  Représente une connexion entre PHP et un Broker de message compatible Stomp.


id: Stomp::__construct
type: function
doc:
<comment>Description:</comment>
  Ouvre une connexion
  
  Style orienté objet (constructeur) :
  
  Style procédural :
  
  Ouvre une connexion à un Broker de message compatible Stomp.

<comment>Param:</comment>
  <info>string</info>  <strong>$broker</strong>    URI du Broker.
  <info>string</info>  <strong>$username</strong>  Nom d'utilisateur.
  <info>string</info>  <strong>$password</strong>  Mot de passe.
  <info>array</info>   <strong>$headers</strong>   Tableau associatif contenant les en-têtes additionnels (exemple : receipt).

<comment>Return:</comment>
  <info>resource</info>  Un en-tête de transaction peut être spécifié, indiquant que la confirmation des messages
            doit faire partie de la transaction.


id: Stomp::__destruct
type: function
doc:
<comment>Description:</comment>
  Ferme une connexion
  
  Style orienté objet (destructeur) :
  
  Style procédural :
  
  Ferme une connexion préalablement ouverte.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Style procédural uniquement : L'identifiant stomp retourné par la
                   fonction<strong>stomp_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: Stomp::abort
type: function
doc:
<comment>Description:</comment>
  Annule une transaction en cours
  
  Style orienté objet (méthode) :
  
  Style procédural :
  
  Annule une transaction en cours.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Style procédural uniquement : L'identifiant stomp retourné par la
                             fonction<strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  ID de la transaction à annuler.
  <info>array</info>     <strong>$headers</strong>         Tableau associatif contenant les en-têtes additionnels (exemple :
                             receipt).

<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: Stomp::ack
type: function
doc:
<comment>Description:</comment>
  Valide la réception d'un message
  
  Style orienté objet (méthode) :
  
  Style procédural :
  
  Valide la réception d'un message par une souscription.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>     Style procédural uniquement : L'identifiant stomp retourné par la
                      fonction<strong>stomp_connect()</strong>.
  <info>mixed</info>     <strong>$msg</strong>      Le message où l'identifiant du message à valider.
  <info>array</info>     <strong>$headers</strong>  Tableau associatif contenant les en-têtes additionnels (exemple : receipt).

<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: Stomp::begin
type: function
doc:
<comment>Description:</comment>
  Débute une transaction
  
  Style orienté objet (méthode) :
  
  Style procédural :
  
  Débute une transaction.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Style procédural uniquement : L'identifiant stomp retourné par la
                             fonction<strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  Identifiant de la transaction.
  <info>array</info>     <strong>$headers</strong>         Tableau associatif contenant les en-têtes additionnels (exemple :
                             receipt).

<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: Stomp::commit
type: function
doc:
<comment>Description:</comment>
  Valide une transaction en cours
  
  Style orienté objet (méthode) :
  
  Style procédural :
  
  Valide une transaction en cours.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>            Style procédural uniquement : L'identifiant stomp retourné par la
                             fonction<strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$transaction_id</strong>  Identifiant de la transaction.
  <info>array</info>     <strong>$headers</strong>         Tableau associatif contenant les en-têtes additionnels (exemple :
                             receipt).

<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: Stomp::error
type: function
doc:
<comment>Description:</comment>
  Récupère la dernière erreur stomp
  
  Style orienté objet (méthode) :
  
  Style procédural :
  
  Récupère la dernière erreur stomp.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Style procédural uniquement : L'identifiant stomp retourné par la
                   fonction<strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne décrivant la dernière erreur ou <info>false</info> si aucune erreur n'est survenue.


id: Stomp::getReadTimeout
type: function
doc:
<comment>Description:</comment>
  Récupère le délai d'expiration de lecture
  
  Style orienté objet (méthode) :
  
  Style procédural :
  
  Récupère le délai d'expiration de lecture.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Style procédural uniquement : L'identifiant stomp retourné par la
                   fonction<strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau associatif avec 2 éléments : sec et usec.


id: Stomp::getSessionId
type: function
doc:
<comment>Description:</comment>
  Retourne l'identifiant de la session courante
  
  Style orienté objet (méthode) :
  
  Style procédural :
  
  Retourne l'identifiant de la session courante.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Style procédural uniquement : L'identifiant stomp retourné par la
                   fonction<strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>string|false</info>  Retourne une chaîne contenant l'identifiant de la session ou <info>false</info> si une erreur
                survient.


id: Stomp::hasFrame
type: function
doc:
<comment>Description:</comment>
  Indique si un message est en attente de lecture ou non
  
  Style orienté objet (méthode) :
  
  Style procédural :
  
  Indique si un message est en attente de lecture ou non.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>  Style procédural uniquement : L'identifiant stomp retourné par la
                   fonction<strong>stomp_connect()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si un message est en attente de lecture, ou <info>false</info> dans le cas contraire.


id: Stomp::readFrame
type: function
doc:
<comment>Description:</comment>
  Lit le prochain message
  
  Style orienté objet (méthode) :
  
  Style procédural :
  
  Lit le prochain message. Il est possible d'instancier un objet d'une classe spécifique, et de
  passer les paramètres au constructeur de cette classe.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>        Style procédural uniquement : L'identifiant stomp retourné par la
                         fonction<strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$class_name</strong>  Le nom de la classe à instancier. Si ce paramètre n'est pas spécifié, un
                         objet stompFrame est retourné.

<comment>Return:</comment>
  <info>stompframe</info>  Un en-tête de transaction peut être spécifié, indiquant que la confirmation des
              messages doit faire partie de la transaction.


id: Stomp::send
type: function
doc:
<comment>Description:</comment>
  Envoi un message
  
  Style orienté objet (méthode) :
  
  Style procédural :
  
  Envoi un message au Broker de message.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Style procédural uniquement : L'identifiant stomp retourné par la
                          fonction<strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  Destination du message.
  <info>mixed</info>     <strong>$msg</strong>          Message à envoyer.
  <info>array</info>     <strong>$headers</strong>      Tableau associatif contenant les en-têtes additionnels (exemple :
                          receipt).

<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: Stomp::setReadTimeout
type: function
doc:
<comment>Description:</comment>
  Définit le délai d'expiration de lecture
  
  Style orienté objet (méthode) :
  
  Style procédural:
  
  Définit le délai d'expiration de lecture pour une connexion stomp.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>          Style procédural uniquement : L'identifiant stomp retourné par la
                           fonction<strong>stomp_connect()</strong>.
  <info>int</info>       <strong>$seconds</strong>       Le nombre de secondes entières du délai d'expiration de lecture à
                           définir.
  <info>int</info>       <strong>$microseconds</strong>  Le nombre de microsecondes entières du délai d'expiration de lecture à
                           définir.

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


id: Stomp::subscribe
type: function
doc:
<comment>Description:</comment>
  Souscrit à l'écoute d'une destination donnée
  
  Style orienté objet (méthode) :
  
  Style procédural :
  
  Souscrit à l'écoute d'une destination donnée.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Style procédural uniquement : L'identifiant stomp retourné par la
                          fonction<strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  Destination à écouter.
  <info>array</info>     <strong>$headers</strong>      Tableau associatif contenant les en-têtes additionnels (exemple :
                          receipt).

<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: Stomp::unsubscribe
type: function
doc:
<comment>Description:</comment>
  Supprime une souscription existante
  
  Style orienté objet (méthode):
  
  Style procédural :
  
  Supprime une souscription existante.

<comment>Param:</comment>
  <info>resource</info>  <strong>$link</strong>         Style procédural uniquement : L'identifiant stomp retourné par la
                          fonction<strong>stomp_connect()</strong>.
  <info>string</info>    <strong>$destination</strong>  Souscription à supprimer.
  <info>array</info>     <strong>$headers</strong>      Tableau associatif contenant les en-têtes additionnels (exemple :
                          receipt).

<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: StompException
type: class
doc:
<comment>Description:</comment>
  Représente une erreur émise par l'extension stomp.  Voir le chapitre sur les Exceptions pour plus
  d'informations sur les exceptions en PHP.


id: StompException::getDetails
type: function
doc:
<comment>Description:</comment>
  Récupère les détails de l'exception
  
  Récupère les détails de l'exception.

<comment>Return:</comment>
  <info>string</info>  chaîne de caractères contenant les détails de l'exception.


id: StompFrame
type: class
doc:
<comment>Description:</comment>
  Représente un message envoyé ou reçu par un Broker de message compatible stomp.


id: StompFrame::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur
  
  Constructeur.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>  Commande du message.
  <info>array</info>   <strong>$headers</strong>  En-têtes du message (tableau).
  <info>string</info>  <strong>$body</strong>     Corps du message.


id: Stringable
type: class
doc:
<comment>Description:</comment>
  L'interface Stringable désigne une classe possédant une méthode __toString(). Contrairement à la
  plupart des interfaces, Stringable est implicitement présente sur toute classe pour laquelle la
  méthode magique __toString() est définie, et ce bien qu'elle puisse et devrait être déclarée
  explicitement.
  
  Sa valeur principale est de permettre aux fonctions de vérifier le type par rapport au type
  d'union <return>string|Stringable</return> pour accepter soit une chaîne de caractères primitive, soit un objet
  pouvant être transtypé en chaîne de caractères.


id: Stringable::__toString
type: function
doc:
<comment>Description:</comment>
  Retourne la représentation de l'objet sous forme de chaîne

<comment>Return:</comment>
  <info>string</info>  Retourne la représentation d'un object sous la forme d'une chaîne de caractères.

<comment>See Also:</comment>
   * __toString()


id: Swoole\Async::dnsLookup
type: function
doc:
<comment>Description:</comment>
  Async and non-blocking hostname to IP lookup.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>    <strong>$hostname</strong>  The host name.
  <info>callable</info>  <strong>$callback</strong>  The host name.
                       
                       The IP address.
  <info>string</info>    <strong>$hostname</strong>  The host name.
  <info></info>          <strong>$IP</strong>        The IP address.

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


id: Swoole\Async::read
type: function
doc:
<comment>Description:</comment>
  Read file stream asynchronously.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>    The name of the file.
  <info>callable</info>  <strong>$callback</strong>    The name of the file.
                         
                         The content readed from the file stream.
  <info>string</info>    <strong>$filename</strong>    The name of the file.
  <info>string</info>    <strong>$content</strong>     The content readed from the file stream.
  <info>int</info>       <strong>$chunk_size</strong>  The chunk length.
  <info>int</info>       <strong>$offset</strong>      The offset.

<comment>Return:</comment>
  <info>bool</info>  Whether the read is succeed.


id: Swoole\Async::readFile
type: function
doc:
<comment>Description:</comment>
  Read a file asynchronously.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename of the file being read.
  <info>callable</info>  <strong>$callback</strong>  The name of the file.
                       
                       The content readed from the file.
  <info>string</info>    <strong>$filename</strong>  The name of the file.
  <info>string</info>    <strong>$content</strong>   The content readed from the file.

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


id: Swoole\Async::set
type: function
doc:
<comment>Description:</comment>
  Update the async I/O options.

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

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


id: Swoole\Async::write
type: function
doc:
<comment>Description:</comment>
  Write data to a file stream asynchronously.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename being written.
  <info>string</info>    <strong>$content</strong>   The content writing to the file.
  <info>int</info>       <strong>$offset</strong>    The offset.
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Async::writeFile
type: function
doc:
<comment>Description:</comment>
  Description
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>    <strong>$filename</strong>  The filename being written.
  <info>string</info>    <strong>$content</strong>   The content writing to the file.
  <info>callable</info>  <strong>$callback</strong>  
  <info>string</info>    <strong>$flags</strong>     

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


id: Swoole\Atomic::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a swoole atomic object.
  
  Swoole atomic object is a integer variable allows any processor to atomically test and modify.  It
  is implemented based on CPU atomic instructions. The Swoole atomic variables have to  defined
  before swoole_server-&gt;start.
  
  Compare-and-swap (CAS) is an atomic instruction used in multithreading to achieve synchronization.
  It compares the content of a memory location with a given value and, only if they are the same,
  modifies the content of that memory location to a new given value.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The value of the atomic object.


id: Swoole\Atomic::add
type: function
doc:
<comment>Description:</comment>
  Add a number to the value to the atomic object.
  
  Add a number to the value to the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$add_value</strong>  The value which will be added to the current value.

<comment>Return:</comment>
  <info>int</info>  The new value of the atomic object.


id: Swoole\Atomic::cmpset
type: function
doc:
<comment>Description:</comment>
  Compare and set the value of the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$cmp_value</strong>  The value to compare with the current value of the atomic object.
  <info>int</info>  <strong>$new_value</strong>  The value to set to the atomic object if the cmp_value is the same as the current
                   value of the atomic object.

<comment>Return:</comment>
  <info>int</info>  The new value of the atomic object.


id: Swoole\Atomic::get
type: function
doc:
<comment>Description:</comment>
  Get the current value of the atomic object.
  
  Get the current value of the atomic object.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Atomic::set
type: function
doc:
<comment>Description:</comment>
  Set a new value to the atomic object.
  
  Set a new value to the atomic object.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The value to set to the atomic object.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Atomic::sub
type: function
doc:
<comment>Description:</comment>
  Subtract a number to the value of the atomic object.
  
  Subtract a number to the value of the atomic object.

<comment>Param:</comment>
  <info>int</info>  <strong>$sub_value</strong>  The value which will be subtracted to the current value.

<comment>Return:</comment>
  <info>int</info>  The current value of the atomic object.


id: Swoole\Buffer::__construct
type: function
doc:
<comment>Description:</comment>
  Fixed size memory blocks allocation.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The size of the memory to allocate.


id: Swoole\Buffer::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the Swoole memory buffer.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: Swoole\Buffer::__toString
type: function
doc:
<comment>Description:</comment>
  Get the string value of the memory buffer.

<comment>Return:</comment>
  <info>string</info>  The string value of the memory buffer.


id: Swoole\Buffer::append
type: function
doc:
<comment>Description:</comment>
  Append the string or binary data at the end of the memory buffer and return the new size of memory
  allocated.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The string or binary data to append at the end of the memory buffer.

<comment>Return:</comment>
  <info>int</info>  The new size of the memory buffer.


id: Swoole\Buffer::clear
type: function
doc:
<comment>Description:</comment>
  Reset the memory buffer.

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


id: Swoole\Buffer::expand
type: function
doc:
<comment>Description:</comment>
  Expand the size of memory buffer.

<comment>Param:</comment>
  <info>int</info>  <strong>$size</strong>  The new size of the memory buffer.

<comment>Return:</comment>
  <info>int</info>  The new size of the memory buffer.


id: Swoole\Buffer::read
type: function
doc:
<comment>Description:</comment>
  Read data from the memory buffer based on offset and length.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset.
  <info>int</info>  <strong>$length</strong>  The length.

<comment>Return:</comment>
  <info>string</info>  The data readed from the memory buffer.


id: Swoole\Buffer::recycle
type: function
doc:
<comment>Description:</comment>
  Release the memory to OS which is not used by the memory buffer.

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


id: Swoole\Buffer::substr
type: function
doc:
<comment>Description:</comment>
  Read data from the memory buffer based on offset and length. Or remove data from the memory
  buffer.
  
  If $remove is set to be true and $offset is set to be 0, the data will be removed from the buffer.
  The memory for storing the data will be released when the buffer object is deconstructed.

<comment>Param:</comment>
  <info>int</info>   <strong>$offset</strong>  The offset.
  <info>int</info>   <strong>$length</strong>  The length.
  <info>bool</info>  <strong>$remove</strong>  Whether to remove the data from the memory buffer.

<comment>Return:</comment>
  <info>string</info>  The data or string readed from the memory buffer.


id: Swoole\Buffer::write
type: function
doc:
<comment>Description:</comment>
  Write data to the memory buffer. The memory allocated for the buffer will not be changed.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  The offset.
  <info>string</info>  <strong>$data</strong>    The data to write to the memory buffer.

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


id: Swoole\Channel::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole Channel
  
  Swoole channel is memory data structure works like Chan in Golang, implemented based on  shared
  memory and mutex locks. It can be used as high performance message queue in memory. Construct a
  swoole channel with a fixed size. The minimum size of a swoole channel is 64KB. Exceptions will be
  thrown if there is not enough memory.

<comment>Param:</comment>
  <info>string</info>  <strong>$size</strong>  The size of the Swoole channel.


id: Swoole\Channel::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct a Swoole channel.

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


id: Swoole\Channel::pop
type: function
doc:
<comment>Description:</comment>
  Read and pop data from swoole channel.

<comment>Return:</comment>
  <info>mixed</info>  If the channel is empty, the function will return false, or return the unserialized data.


id: Swoole\Channel::push
type: function
doc:
<comment>Description:</comment>
  Write and push data into Swoole channel.
  
  Data can be any non-empty PHP variable, the variable will be serialized if it is not string type.
  
  If size of the data is more than 8KB, swoole channel will use temp files storage.
  
  The function will return true if the write operation is succeeded, or return false if there is not
  enough space.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The data to push into the Swoole channel.

<comment>Return:</comment>
  <info>bool</info>  Wheter the data is pushed into he Swoole channel.


id: Swoole\Channel::stats
type: function
doc:
<comment>Description:</comment>
  Get stats of swoole channel.
  
  Get the numbers of queued elements and total size of the memory used by the queue.

<comment>Return:</comment>
  <info>array</info>  The stats of the Swoole channel.


id: Swoole\Client::__construct
type: function
doc:
<comment>Description:</comment>
  Create Swoole sync or async TCP/UDP client, with or without SSL.

<comment>Param:</comment>
  <info>int</info>  <strong>$sock_type</strong>  The type of socket: SWOOLE_TCP, SWOOLE_UDP, SWOOLE_ASYNC, SWOOLE_SSL,
                   SWOOLE_KEEP.
  <info>int</info>  <strong>$is_async</strong>   Synchronous or asynchronous client.


id: Swoole\Client::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the Swoole client.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: Swoole\Client::close
type: function
doc:
<comment>Description:</comment>
  Close the connection established.

<comment>Param:</comment>
  <info>bool</info>  <strong>$force</strong>  Whether force to close the connection.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is closed.


id: Swoole\Client::connect
type: function
doc:
<comment>Description:</comment>
  Connect to the remote TCP or UDP port.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>     The host name of the remote address.
  <info>int</info>     <strong>$port</strong>     The port number of the remote address.
  <info>int</info>     <strong>$timeout</strong>  The timeout(second) of connect/send/recv, the dafault value is 0.1s
  <info>int</info>     <strong>$flag</strong>     If the type of client is UDP, the $flag means if to enable the configuration
                    udp_connect.  If the configuration udp_connect is enabled, the client will only
                    receive the data from specified ip:port. If the type of client is TCP and the
                    $flag is set to 1, it must use swoole_client_select to check the connection
                    status before send/recv.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is established.


id: Swoole\Client::getpeername
type: function
doc:
<comment>Description:</comment>
  Get the remote socket name of the connection.

<comment>Return:</comment>
  <info>array</info>  The host and port of the remote socket.


id: Swoole\Client::getsockname
type: function
doc:
<comment>Description:</comment>
  Get the local socket name of the connection.

<comment>Return:</comment>
  <info>array</info>  The host and port of the local socket.


id: Swoole\Client::isConnected
type: function
doc:
<comment>Description:</comment>
  Check if the connection is established.
  
  This method returns the connection status of application layer.

<comment>Return:</comment>
  <info>bool</info>  Whether the connection is established.


id: Swoole\Client::on
type: function
doc:
<comment>Description:</comment>
  Add callback functions triggered by events.

<comment>Param:</comment>
  <info>string</info>    <strong>$event</strong>     
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Client::pause
type: function
doc:
<comment>Description:</comment>
  Pause receiving data.

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


id: Swoole\Client::pipe
type: function
doc:
<comment>Description:</comment>
  Redirect the data to another file descriptor.

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

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


id: Swoole\Client::recv
type: function
doc:
<comment>Description:</comment>
  Receive data from the remote socket.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$size</strong>  
  <info>string</info>  <strong>$flag</strong>  

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


id: Swoole\Client::resume
type: function
doc:
<comment>Description:</comment>
  Resume receiving data.

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


id: Swoole\Client::send
type: function
doc:
<comment>Description:</comment>
  Send data to the remote TCP socket.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  The data to send which can be string or binary
  <info>string</info>  <strong>$flag</strong>  

<comment>Return:</comment>
  <info>int</info>  If the client sends data successfully, it returns the length of data sent.  Or it returns
       false and sets $swoole_client-&gt;errCode. For sync client,  there is no limit for the data
       to send. For async client, The limit  for the data to send is socket_buffer_size.


id: Swoole\Client::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file to the remote TCP socket.
  
  This is a wrapper of the Linux sendfile system call.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  File path of the file to send.
  <info>int</info>     <strong>$offset</strong>    Offset of the file to send

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


id: Swoole\Client::sendto
type: function
doc:
<comment>Description:</comment>
  Send data to the remote UDP address.
  
  The swoole client should be type of SWOOLE_SOCK_UDP or SWOOLE_SOCK_UDP6.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>    The IP address of remote host, IPv4 or IPv6.
  <info>int</info>     <strong>$port</strong>  The port number of remote host.
  <info>string</info>  <strong>$data</strong>  The data to send which should be less-than 64K.

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


id: Swoole\Client::set
type: function
doc:
<comment>Description:</comment>
  Set the Swoole client parameters before the connection is established.

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

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


id: Swoole\Client::sleep
type: function
doc:
<comment>Description:</comment>
  Remove the TCP client from system event loop.
  
  Remove the TCP client from system event loop.

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


id: Swoole\Client::wakeup
type: function
doc:
<comment>Description:</comment>
  Add the TCP client back into the system event loop.

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


id: Swoole\Connection\Iterator::count
type: function
doc:
<comment>Description:</comment>
  Count connections.
  
  Gets the number of connections.

<comment>Return:</comment>
  <info>int</info>  The number of connections.


id: Swoole\Connection\Iterator::current
type: function
doc:
<comment>Description:</comment>
  Return current connection entry.
  
  Get current connection entry.

<comment>Return:</comment>
  <info>Connection</info>  The current connection entry.


id: Swoole\Connection\Iterator::key
type: function
doc:
<comment>Description:</comment>
  Return key of the current connection.
  
  This function returns key of the current connection.

<comment>Return:</comment>
  <info>int</info>  Key of the current connection.


id: Swoole\Connection\Iterator::next
type: function
doc:
<comment>Description:</comment>
  Move to the next connection.
  
  The iterator to the next connection.

<comment>Return:</comment>
  <info>Connection</info>  


id: Swoole\Connection\Iterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  Check if offet exists.
  
  Check if offset exists.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The offset being checked.

<comment>Return:</comment>
  <info>bool</info>  Returns TRUE if the offset exists, otherwise FALSE.


id: Swoole\Connection\Iterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  Offset to retrieve.
  
  Return the connection at specified offset.

<comment>Param:</comment>
  <info>string</info>  <strong>$index</strong>  The offset to retrieve.

<comment>Return:</comment>
  <info>Connection</info>  


id: Swoole\Connection\Iterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  Assign a Connection to the specified offset.
  
  Assign a Connection to the specified offset.

<comment>Param:</comment>
  <info>int</info>    <strong>$offset</strong>      The offset to assign the Connection to.
  <info>mixed</info>  <strong>$connection</strong>  The connection to set.

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


id: Swoole\Connection\Iterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Unset an offset.
  
  Unsets an offset.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  The offset to unset.

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


id: Swoole\Connection\Iterator::rewind
type: function
doc:
<comment>Description:</comment>
  Rewinds iterator

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


id: Swoole\Connection\Iterator::valid
type: function
doc:
<comment>Description:</comment>
  Check if current position is valid.
  
  Checks if the current position is valid.

<comment>Return:</comment>
  <info>bool</info>  Returns TRUE if the current iterator position is valid, otherwise FALSE.


id: Swoole\Coroutine::call_user_func
type: function
doc:
<comment>Description:</comment>
  Call a callback given by the first parameter
  
  Calls the <strong>$callback</strong> given by the first parameter and passes the remaining parameters as arguments.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The <info>callable</info> to be called.
  <info>mixed</info>     <strong>$args</strong>      Zero or more parameters to be passed to the callback.

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


id: Swoole\Coroutine::call_user_func_array
type: function
doc:
<comment>Description:</comment>
  Call a callback with an array of parameters
  
  Calls the callback given by the first parameter with the parameters in param_array.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>     The <info>callable</info> to be called.
  <info>array</info>     <strong>$param_array</strong>  Zero or more parameters in the array to be passed to the callback.

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


id: Swoole\Coroutine::cli_wait
type: function
doc:
<comment>Description:</comment>
  Description

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Coroutine::create
type: function
doc:
<comment>Description:</comment>
  Description
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Event::add
type: function
doc:
<comment>Description:</comment>
  Add new callback functions of a socket into the EventLoop.

<comment>Param:</comment>
  <info>int</info>       <strong>$fd</strong>              
  <info>callable</info>  <strong>$read_callback</strong>   
  <info>callable</info>  <strong>$write_callback</strong>  
  <info>string</info>    <strong>$events</strong>          

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


id: Swoole\Event::defer
type: function
doc:
<comment>Description:</comment>
  Add a callback function to the next event loop.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$callback</strong>  

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


id: Swoole\Event::del
type: function
doc:
<comment>Description:</comment>
  Remove all event callback functions of a socket.

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

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


id: Swoole\Event::exit
type: function
doc:
<comment>Description:</comment>
  Exit the eventloop, only available at client side.

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


id: Swoole\Event::set
type: function
doc:
<comment>Description:</comment>
  Update the event callback functions of a socket.

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>              
  <info>string</info>  <strong>$read_callback</strong>   
  <info>string</info>  <strong>$write_callback</strong>  
  <info>string</info>  <strong>$events</strong>          

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


id: Swoole\Event::wait
type: function
doc:
<comment>Description:</comment>
  Description
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: Swoole\Event::write
type: function
doc:
<comment>Description:</comment>
  Write data to the socket.

<comment>Param:</comment>
  <info>string</info>  <strong>$fd</strong>    
  <info>string</info>  <strong>$data</strong>  

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


id: Swoole\Http\Client::__construct
type: function
doc:
<comment>Description:</comment>
  Construct the async HTTP client.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  The hostname of the remote host.
  <info>string</info>  <strong>$port</strong>  The port number of the remote host.
  <info>bool</info>    <strong>$ssl</strong>   Whether to enable SSL.


id: Swoole\Http\Client::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP client.

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


id: Swoole\Http\Client::addFile
type: function
doc:
<comment>Description:</comment>
  Add a file to the post form.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$type</strong>      
  <info>string</info>  <strong>$filename</strong>  
  <info>string</info>  <strong>$offset</strong>    

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


id: Swoole\Http\Client::close
type: function
doc:
<comment>Description:</comment>
  Close the http connection.

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


id: Swoole\Http\Client::download
type: function
doc:
<comment>Description:</comment>
  Download a file from the remote server.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>string</info>    <strong>$file</strong>      
  <info>callable</info>  <strong>$callback</strong>  
  <info>int</info>       <strong>$offset</strong>    

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


id: Swoole\Http\Client::execute
type: function
doc:
<comment>Description:</comment>
  Send the HTTP request after setting the parameters.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Client::get
type: function
doc:
<comment>Description:</comment>
  Send GET http request to the remote server.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Client::isConnected
type: function
doc:
<comment>Description:</comment>
  Check if the HTTP connection is connected.

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


id: Swoole\Http\Client::on
type: function
doc:
<comment>Description:</comment>
  Register callback function by event name.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\Http\Client::post
type: function
doc:
<comment>Description:</comment>
  Send POST http request to the remote server.

<comment>Param:</comment>
  <info>string</info>    <strong>$path</strong>      
  <info>string</info>    <strong>$data</strong>      
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Client::push
type: function
doc:
<comment>Description:</comment>
  Push data to websocket client.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  

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


id: Swoole\Http\Client::set
type: function
doc:
<comment>Description:</comment>
  Update the HTTP client paramters.

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

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


id: Swoole\Http\Client::setCookies
type: function
doc:
<comment>Description:</comment>
  Set the http request cookies.

<comment>Param:</comment>
  <info>array</info>  <strong>$cookies</strong>  

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


id: Swoole\Http\Client::setData
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request body data.
  
  The HTTP method will be changed to be POST.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Client::setHeaders
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request headers.

<comment>Param:</comment>
  <info>array</info>  <strong>$headers</strong>  

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


id: Swoole\Http\Client::setMethod
type: function
doc:
<comment>Description:</comment>
  Set the HTTP request method.

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

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


id: Swoole\Http\Client::upgrade
type: function
doc:
<comment>Description:</comment>
  Upgrade to websocket protocol.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$callback</strong>  

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


id: Swoole\Http\Request::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP request.

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


id: Swoole\Http\Request::rawcontent
type: function
doc:
<comment>Description:</comment>
  Get the raw HTTP POST body.
  
  This method is used for the POST data which isn't in the form of
  `application/x-www-form-urlencoded`.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: Swoole\Http\Response::__destruct
type: function
doc:
<comment>Description:</comment>
  Destruct the HTTP response.

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


id: Swoole\Http\Response::cookie
type: function
doc:
<comment>Description:</comment>
  Set the cookies of the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$value</strong>     
  <info>string</info>  <strong>$expires</strong>   
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$domain</strong>    
  <info>string</info>  <strong>$secure</strong>    
  <info>string</info>  <strong>$httponly</strong>  

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


id: Swoole\Http\Response::end
type: function
doc:
<comment>Description:</comment>
  Send data for the HTTP request and finish the response.

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

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


id: Swoole\Http\Response::gzip
type: function
doc:
<comment>Description:</comment>
  Enable the gzip of response content.
  
  
  The header about Content-Encoding will be added automatically.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::header
type: function
doc:
<comment>Description:</comment>
  Set the HTTP response headers.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>      
  <info>string</info>  <strong>$value</strong>    
  <info>string</info>  <strong>$ucwords</strong>  

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


id: Swoole\Http\Response::initHeader
type: function
doc:
<comment>Description:</comment>
  Init the HTTP response header.
  
  Init the HTTP response header.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::rawcookie
type: function
doc:
<comment>Description:</comment>
  Set the raw cookies to the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      
  <info>string</info>  <strong>$value</strong>     
  <info>string</info>  <strong>$expires</strong>   
  <info>string</info>  <strong>$path</strong>      
  <info>string</info>  <strong>$domain</strong>    
  <info>string</info>  <strong>$secure</strong>    
  <info>string</info>  <strong>$httponly</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file through the HTTP response.
  
  Send file through the HTTP response.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  
  <info>int</info>     <strong>$offset</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::status
type: function
doc:
<comment>Description:</comment>
  Set the status code of the HTTP response.
  
  Set the status code of the HTTP response.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Http\Response::write
type: function
doc:
<comment>Description:</comment>
  Append HTTP body content to the HTTP response.
  
  Append HTTP body content to the HTTP response.

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

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


id: Swoole\Http\Server::on
type: function
doc:
<comment>Description:</comment>
  Bind callback function to HTTP server by event name.
  
  Bind callback function to HTTP server by event name.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\Http\Server::start
type: function
doc:
<comment>Description:</comment>
  Start the swoole http server.
  
  Start the swoole http server.

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


id: Swoole\Lock::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a memory lock.
  
  Swoole lock is used for data synchronization between multiple theads or processes.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>                
  <info>string</info>  <strong>$file_lock_location</strong>  


id: Swoole\Lock::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory a Swoole memory lock.

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


id: Swoole\Lock::lock
type: function
doc:
<comment>Description:</comment>
  Try to acquire the lock. It will block if the lock is not available.

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


id: Swoole\Lock::lock_read
type: function
doc:
<comment>Description:</comment>
  Lock a read-write lock for reading.
  
  Lock a read-write lock for reading.

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


id: Swoole\Lock::trylock
type: function
doc:
<comment>Description:</comment>
  Try to acquire the lock and return straight away even the lock is not available.

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


id: Swoole\Lock::trylock_read
type: function
doc:
<comment>Description:</comment>
  Try to lock a read-write lock for reading and return straight away even the lock is not available.

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


id: Swoole\Lock::unlock
type: function
doc:
<comment>Description:</comment>
  Release the lock.

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


id: Swoole\Mmap::open
type: function
doc:
<comment>Description:</comment>
  Map a file into memory and return the stream resource which can be used by PHP stream operations.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  
  <info>string</info>  <strong>$size</strong>      
  <info>string</info>  <strong>$offset</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\MySQL::__construct
type: function
doc:
<comment>Description:</comment>
  Construct an async MySQL client.
  
  Construct an async MySQL client.


id: Swoole\MySQL::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory the async MySQL client.

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


id: Swoole\MySQL::close
type: function
doc:
<comment>Description:</comment>
  Close the async MySQL connection.

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


id: Swoole\MySQL::connect
type: function
doc:
<comment>Description:</comment>
  Connect to the remote MySQL server.
  
  Connect to the remote MySQL server.

<comment>Param:</comment>
  <info>array</info>     <strong>$server_config</strong>  
  <info>callable</info>  <strong>$callback</strong>       

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


id: Swoole\MySQL::on
type: function
doc:
<comment>Description:</comment>
  Register callback function based on event name.
  
  Register callback function based on event name, current only 'close' event is supported.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\MySQL::query
type: function
doc:
<comment>Description:</comment>
  Run the SQL query.

<comment>Param:</comment>
  <info>string</info>    <strong>$sql</strong>       
  <info>callable</info>  <strong>$callback</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Process::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a process.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>                   
  <info>bool</info>      <strong>$redirect_stdin_and_stdout</strong>  
  <info>int</info>       <strong>$pipe_type</strong>                  


id: Swoole\Process::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory the process.

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


id: Swoole\Process::alarm
type: function
doc:
<comment>Description:</comment>
  High precision timer which triggers signal with fixed interval.

<comment>Param:</comment>
  <info>int</info>  <strong>$interval_usec</strong>  

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


id: Swoole\Process::close
type: function
doc:
<comment>Description:</comment>
  Close the pipe to the child process.
  
  Close the pipe to the child process.

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


id: Swoole\Process::daemon
type: function
doc:
<comment>Description:</comment>
  Change the process to be a daemon process.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>bool</info>  <strong>$nochdir</strong>  
  <info>bool</info>  <strong>$noclose</strong>  

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


id: Swoole\Process::exec
type: function
doc:
<comment>Description:</comment>
  Execute system commands.
  
  The process will be replaced to be the system command process, but the pipe to the parent process
  will be kept.

<comment>Param:</comment>
  <info>string</info>  <strong>$exec_file</strong>  
  <info>string</info>  <strong>$args</strong>       

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Process::exit
type: function
doc:
<comment>Description:</comment>
  Stop the child processes.

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

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


id: Swoole\Process::freeQueue
type: function
doc:
<comment>Description:</comment>
  Destroy the message queue created by swoole_process::useQueue.

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


id: Swoole\Process::kill
type: function
doc:
<comment>Description:</comment>
  Send signal to the child process.
  
  Send signal to the child process.

<comment>Param:</comment>
  <info>int</info>  <strong>$pid</strong>        Process pid
  <info>int</info>  <strong>$signal_no</strong>  Signal to be sent

<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: Swoole\Process::name
type: function
doc:
<comment>Description:</comment>
  Set name of the process.

<comment>Param:</comment>
  <info>string</info>  <strong>$process_name</strong>  Set name of the process.

<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: Swoole\Process::pop
type: function
doc:
<comment>Description:</comment>
  Read and pop data from the message queue.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxsize</strong>  

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


id: Swoole\Process::push
type: function
doc:
<comment>Description:</comment>
  Write and push data into the message queue.

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

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


id: Swoole\Process::read
type: function
doc:
<comment>Description:</comment>
  Read data sending to the process.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxsize</strong>  

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


id: Swoole\Process::signal
type: function
doc:
<comment>Description:</comment>
  Send signal to the child processes.

<comment>Param:</comment>
  <info>string</info>    <strong>$signal_no</strong>  
  <info>callable</info>  <strong>$callback</strong>   

<comment>Return:</comment>
  <info>void</info>  If signal sent successfully, it returns TRUE, otherwise it returns FALSE.


id: Swoole\Process::start
type: function
doc:
<comment>Description:</comment>
  Start the process.

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


id: Swoole\Process::statQueue
type: function
doc:
<comment>Description:</comment>
  Get the stats of the message queue used as the communication method between processes.

<comment>Return:</comment>
  <info>array</info>  The array of status of the message queue.


id: Swoole\Process::useQueue
type: function
doc:
<comment>Description:</comment>
  Create a message queue as the communication method between the parent process and child processes.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>   
  <info>int</info>  <strong>$mode</strong>  

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


id: Swoole\Process::wait
type: function
doc:
<comment>Description:</comment>
  Wait for the events of child processes.

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

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


id: Swoole\Process::write
type: function
doc:
<comment>Description:</comment>
  Write data into the pipe and communicate with the parent process or child processes.

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

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


id: Swoole\Redis\Server::format
type: function
doc:
<comment>Description:</comment>
  Description
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>   
  <info>string</info>  <strong>$value</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Redis\Server::setHandler
type: function
doc:
<comment>Description:</comment>
  Description
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$command</strong>                 
  <info>string</info>  <strong>$callback</strong>                
  <info>string</info>  <strong>$number_of_string_param</strong>  
  <info>string</info>  <strong>$type_of_array_param</strong>     

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Serialize::pack
type: function
doc:
<comment>Description:</comment>
  Serialize the data.
  
  Swoole provides a fast and high performance serialization module.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Serialize::unpack
type: function
doc:
<comment>Description:</comment>
  Unserialize the data.
  
  Unserialize the data.

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

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole server.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>       
  <info>int</info>     <strong>$port</strong>       
  <info>integr</info>  <strong>$mode</strong>       
  <info>int</info>     <strong>$sock_type</strong>  


id: Swoole\Server::addProcess
type: function
doc:
<comment>Description:</comment>
  Add a user defined swoole_process to the server.

<comment>Param:</comment>
  <info>swoole_process</info>  <strong>$process</strong>  

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


id: Swoole\Server::addlistener
type: function
doc:
<comment>Description:</comment>
  Add a new listener to the server.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>         
  <info>int</info>     <strong>$port</strong>         
  <info>string</info>  <strong>$socket_type</strong>  

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


id: Swoole\Server::after
type: function
doc:
<comment>Description:</comment>
  Trigger a callback function after a period of time.

<comment>Param:</comment>
  <info>int</info>       <strong>$after_time_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>       
  <info>string</info>    <strong>$param</strong>          

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::bind
type: function
doc:
<comment>Description:</comment>
  Bind the connection to a user defined user ID.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>   
  <info>int</info>  <strong>$uid</strong>  

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


id: Swoole\Server::clearTimer
type: function
doc:
<comment>Description:</comment>
  Stop and destory a timer.
  
  Style orienté objet (method):
  
  Style procédural:
  
  Stop and destory a timer

<comment>Param:</comment>
  <info>int</info>  <strong>$timer_id</strong>  

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


id: Swoole\Server::close
type: function
doc:
<comment>Description:</comment>
  Close a connection to the client.

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>     
  <info>bool</info>  <strong>$reset</strong>  

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


id: Swoole\Server::confirm
type: function
doc:
<comment>Description:</comment>
  Check status of the connection.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>  

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


id: Swoole\Server::connection_info
type: function
doc:
<comment>Description:</comment>
  Get the connection info by file description.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>          
  <info>int</info>  <strong>$reactor_id</strong>  

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


id: Swoole\Server::connection_list
type: function
doc:
<comment>Description:</comment>
  Get all of the established connections.

<comment>Param:</comment>
  <info>int</info>  <strong>$start_fd</strong>  
  <info>int</info>  <strong>$pagesize</strong>  

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


id: Swoole\Server::defer
type: function
doc:
<comment>Description:</comment>
  Delay execution of the callback function at the end of current EventLoop.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  

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


id: Swoole\Server::exist
type: function
doc:
<comment>Description:</comment>
  Check if the connection is existed.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>  

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


id: Swoole\Server::finish
type: function
doc:
<comment>Description:</comment>
  Used in task process for sending result to the worker process when the task is finished.

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

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


id: Swoole\Server::getClientInfo
type: function
doc:
<comment>Description:</comment>
  Get the connection info by file description.

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>            File descriptors.
  <info>int</info>   <strong>$reactor_id</strong>    The Reactor thread ID where the connection is made.
  <info>bool</info>  <strong>$ignore_error</strong>  Whether to ignore errors, if set to true, connection information will be
                       returned even if the connection is closed.

<comment>Return:</comment>
  <info>array</info>  Returns information about the client connection.


id: Swoole\Server::getClientList
type: function
doc:
<comment>Description:</comment>
  Get all of the established connections.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>  <strong>$start_fd</strong>  
  <info>int</info>  <strong>$pagesize</strong>  

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


id: Swoole\Server::getLastError
type: function
doc:
<comment>Description:</comment>
  Get the error code of the most recent error.

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


id: Swoole\Server::heartbeat
type: function
doc:
<comment>Description:</comment>
  Check all the connections on the server.

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

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


id: Swoole\Server::listen
type: function
doc:
<comment>Description:</comment>
  Listen on the given IP and port, socket type.

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>         
  <info>int</info>     <strong>$port</strong>         
  <info>string</info>  <strong>$socket_type</strong>  

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


id: Swoole\Server::on
type: function
doc:
<comment>Description:</comment>
  Register a callback function by event name.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

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


id: Swoole\Server::pause
type: function
doc:
<comment>Description:</comment>
  Stop receiving data from the connection.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>  

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


id: Swoole\Server::protect
type: function
doc:
<comment>Description:</comment>
  Set the connection to be protected mode.

<comment>Param:</comment>
  <info>int</info>   <strong>$fd</strong>            
  <info>bool</info>  <strong>$is_protected</strong>  

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


id: Swoole\Server::reload
type: function
doc:
<comment>Description:</comment>
  Restart all the worker process.

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


id: Swoole\Server::resume
type: function
doc:
<comment>Description:</comment>
  Start receving data from the connection.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>  

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


id: Swoole\Server::send
type: function
doc:
<comment>Description:</comment>
  Send data to the client.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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

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


id: Swoole\Server::sendMessage
type: function
doc:
<comment>Description:</comment>
  Send message to worker processes by ID.

<comment>Param:</comment>
  <info></info>        <strong>$dst_worker_id</strong>  
  <info>string</info>  <strong>$data</strong>           

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


id: Swoole\Server::sendfile
type: function
doc:
<comment>Description:</comment>
  Send file to the connection.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>     <strong>$fd</strong>        
  <info>string</info>  <strong>$filename</strong>  
  <info>int</info>     <strong>$offset</strong>    

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


id: Swoole\Server::sendto
type: function
doc:
<comment>Description:</comment>
  Send data to the remote UDP address.

<comment>Param:</comment>
  <info>string</info>  <strong>$ip</strong>             
  <info>int</info>     <strong>$port</strong>           
  <info>string</info>  <strong>$data</strong>           
  <info>string</info>  <strong>$server_socket</strong>  

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


id: Swoole\Server::sendwait
type: function
doc:
<comment>Description:</comment>
  Send data to the remote socket in the blocking way.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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

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


id: Swoole\Server::set
type: function
doc:
<comment>Description:</comment>
  Set the runtime settings of the swoole server.
  
  Set the runtime settings of the swoole server. The settings can be accessed by $server-&gt;setting
  when the swoole server has started.

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server::shutdown
type: function
doc:
<comment>Description:</comment>
  Shutdown the master server process, this function can be called in worker processes.

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


id: Swoole\Server::start
type: function
doc:
<comment>Description:</comment>
  Start the Swoole server.

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


id: Swoole\Server::stats
type: function
doc:
<comment>Description:</comment>
  Get the stats of the Swoole server.

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


id: Swoole\Server::stop
type: function
doc:
<comment>Description:</comment>
  Stop the Swoole server.

<comment>Param:</comment>
  <info>int</info>  <strong>$worker_id</strong>  

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


id: Swoole\Server::task
type: function
doc:
<comment>Description:</comment>
  Send data to the task worker processes.
  
  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>$dst_worker_id</strong>  
  <info>callable</info>  <strong>$callback</strong>       

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


id: Swoole\Server::taskWaitMulti
type: function
doc:
<comment>Description:</comment>
  Execute multiple tasks concurrently.

<comment>Param:</comment>
  <info>array</info>  <strong>$tasks</strong>       
  <info>float</info>  <strong>$timeout_ms</strong>  

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


id: Swoole\Server::taskwait
type: function
doc:
<comment>Description:</comment>
  Send data to the task worker processes in blocking way.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>       
  <info>float</info>   <strong>$timeout</strong>    
  <info>int</info>     <strong>$worker_id</strong>  

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


id: Swoole\Server::tick
type: function
doc:
<comment>Description:</comment>
  Repeats a given function at every given time-interval.

<comment>Param:</comment>
  <info>int</info>       <strong>$interval_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>     

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


id: Swoole\Server\Port::__destruct
type: function
doc:
<comment>Description:</comment>
  Destory server port

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


id: Swoole\Server\Port::on
type: function
doc:
<comment>Description:</comment>
  Register callback functions by event.

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Server\Port::set
type: function
doc:
<comment>Description:</comment>
  Set protocol of the server port.

<comment>Param:</comment>
  <info>array</info>  <strong>$settings</strong>  

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


id: Swoole\Table::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Swoole memory table with fixed size.

<comment>Param:</comment>
  <info>int</info>  <strong>$table_size</strong>  


id: Swoole\Table::column
type: function
doc:
<comment>Description:</comment>
  Set the data type and size of the columns.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  
  <info>string</info>  <strong>$type</strong>  
  <info>int</info>     <strong>$size</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::count
type: function
doc:
<comment>Description:</comment>
  Count the rows in the table, or count all the elements in the table if $mode = 1.

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


id: Swoole\Table::create
type: function
doc:
<comment>Description:</comment>
  Create the swoole memory table.

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


id: Swoole\Table::current
type: function
doc:
<comment>Description:</comment>
  Get the current row.

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


id: Swoole\Table::decr
type: function
doc:
<comment>Description:</comment>
  Decrement the value in the Swoole table by $row_key and $column_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     
  <info>string</info>  <strong>$column</strong>  
  <info>int</info>     <strong>$decrby</strong>  

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::del
type: function
doc:
<comment>Description:</comment>
  Delete a row in the Swoole table by $row_key.

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

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


id: Swoole\Table::destroy
type: function
doc:
<comment>Description:</comment>
  Destroy the Swoole table.

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


id: Swoole\Table::exist
type: function
doc:
<comment>Description:</comment>
  Check if a row is existed by $row_key.

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

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


id: Swoole\Table::get
type: function
doc:
<comment>Description:</comment>
  Get the value in the Swoole table by $row_key and $column_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$row_key</strong>     
  <info>string</info>  <strong>$column_key</strong>  

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


id: Swoole\Table::incr
type: function
doc:
<comment>Description:</comment>
  Increment the value by $row_key and $column_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>     
  <info>string</info>  <strong>$column</strong>  
  <info>int</info>     <strong>$incrby</strong>  

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


id: Swoole\Table::key
type: function
doc:
<comment>Description:</comment>
  Get the key of current row.

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


id: Swoole\Table::next
type: function
doc:
<comment>Description:</comment>
  Iterator the next row.

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\Table::rewind
type: function
doc:
<comment>Description:</comment>
  Rewind the iterator.

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


id: Swoole\Table::set
type: function
doc:
<comment>Description:</comment>
  Update a row of the table by $row_key.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    
  <info>array</info>   <strong>$value</strong>  

<comment>Return:</comment>
  <info>VOID</info>  


id: Swoole\Table::valid
type: function
doc:
<comment>Description:</comment>
  Check current if the current row is valid.

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


id: Swoole\Timer::after
type: function
doc:
<comment>Description:</comment>
  Trigger a callback function after a period of time.
  
  Trigger a callback function after a period of time.

<comment>Param:</comment>
  <info>int</info>       <strong>$after_time_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>       

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


id: Swoole\Timer::clear
type: function
doc:
<comment>Description:</comment>
  Delete a timer by timer ID.
  
  Delete a timer by timer ID.

<comment>Param:</comment>
  <info>int</info>  <strong>$timer_id</strong>  

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


id: Swoole\Timer::exists
type: function
doc:
<comment>Description:</comment>
  Check if a timer is existed.
  
  Check if a timer is existed.

<comment>Param:</comment>
  <info>int</info>  <strong>$timer_id</strong>  

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


id: Swoole\Timer::tick
type: function
doc:
<comment>Description:</comment>
  Repeats a given function at every given time-interval.

<comment>Param:</comment>
  <info>int</info>       <strong>$interval_ms</strong>  
  <info>callable</info>  <strong>$callback</strong>     
  <info>string</info>    <strong>$param</strong>        

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


id: Swoole\WebSocket\Server::exist
type: function
doc:
<comment>Description:</comment>
  Check if the file descriptor exists.

<comment>Param:</comment>
  <info>int</info>  <strong>$fd</strong>  

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


id: Swoole\WebSocket\Server::on
type: function
doc:
<comment>Description:</comment>
  Register event callback function
  
  Register event callback function

<comment>Param:</comment>
  <info>string</info>    <strong>$event_name</strong>  
  <info>callable</info>  <strong>$callback</strong>    

<comment>Return:</comment>
  <info>ReturnType</info>  


id: Swoole\WebSocket\Server::pack
type: function
doc:
<comment>Description:</comment>
  Get a pack of binary data to send in a single frame.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  
  <info>string</info>  <strong>$mask</strong>    

<comment>Return:</comment>
  <info>binary</info>  


id: Swoole\WebSocket\Server::push
type: function
doc:
<comment>Description:</comment>
  Push data to the remote client.

<comment>Param:</comment>
  <info>string</info>  <strong>$fd</strong>      
  <info>string</info>  <strong>$data</strong>    
  <info>string</info>  <strong>$opcode</strong>  
  <info>string</info>  <strong>$finish</strong>  

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


id: Swoole\WebSocket\Server::unpack
type: function
doc:
<comment>Description:</comment>
  Unpack the binary data received from the client.

<comment>Param:</comment>
  <info>binary</info>  <strong>$data</strong>  

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


id: SyncEvent
type: class
doc:
<comment>Description:</comment>
  Une implémentation cross-plateforme, native des objets d'événements nommés ou non. Les objets
  d'événements à la fois automatique et manuelle sont supportés.
  
  Un objet d'évément, attend, sans mise en file, que les objets soient lancés/définis. Une instance
  attend sur l'objet d'événement tandis qu'une autre lance/définie l'événement. Les objets
  d'événements sont utiles tout au long d'un processus long (i.e. vérifier pour voir si un
  téléchargement de données doit être analysé).


id: SyncEvent::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet SyncEvent
  
  Construit un objet d'événement nommé ou non.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>     Le nom de l'événement si c'est un objet d'événement nommé.
                    
                    Si le nom existe déjà, on doit être capable de l'ouvrir avec l'utilisateur
                    courant qui exécute le processus, ou une exception sera émise avec le contenu du
                    message d'erreur.
  <info>bool</info>    <strong>$manual</strong>   Spécifie si l'objet d'événement doit être ou non réinitialisé manuellement.
                    
                    La réinitialisation manuelle des objets d'événements permet la mise en attente
                    des processus tant que l'objet n'est pas réinitialisé.
  <info>bool</info>    <strong>$prefire</strong>  Spécifie s'il faut ou non pré-envoyer (le signal) à l'objet event.
                    
                    N'a d'impact que si l'appel au processus/thread est le premier à créer l'objet.

<comment>Return:</comment>
  <info>unknown</info>  Le nouvel objet <class>SyncEvent</class>.

<comment>See Also:</comment>
   * SyncEvent::fire
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::fire
type: function
doc:
<comment>Description:</comment>
  Lance/défini l'événement
  
  Lance/défini un objet <class>SyncEvent</class>. Conserve plusieurs threads en attente si l'objet d'événement a
  été créé avec une valeur manuelle à <info>true</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>
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::reset
type: function
doc:
<comment>Description:</comment>
  Réinitialise manuellement un événement
  
  Réinitialise un objet <class>SyncEvent</class> qui a été lancé/défini. Seulement valide pour les objets
  d'événement manuels.

<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>
   * SyncEvent::fire
   * SyncEvent::reset
   * SyncEvent::wait


id: SyncEvent::wait
type: function
doc:
<comment>Description:</comment>
  Attend que l'objet SyncEvent ne soit lancé
  
  Attend que l'objet <class>SyncEvent</class> ne soit lancé.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  Le nombre de millisecondes à attendre que l'événement ne soit lancé. Une valeur de -1
              signifie que l'on attend indéfiniement.

<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>
   * SyncEvent::fire


id: SyncMutex
type: class
doc:
<comment>Description:</comment>
  Une implémentation cross-plateforme, native des objets Mutex nommés ou non.
  
  Un Mutex est un objet d'exclusion mutuel qui restreint l'accès à une ressource partagée (i.e. un
  fichier) à une seule instance. Les Mutex comptables acquière le mutex une seule fois et, en
  interne, traque le nombre de fois que le mutex est verrouillé. Le Mutex est déverouillé dès qu'il
  sort du scope ou s'il est déverrouillé le même nombre de fois qu'il n'a été verrouillé.


id: SyncMutex::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet SyncMutex
  
  Construit un objet comptable nommé ou non.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Le nom du mutex s'il s'agit d'un objet mutex nommé.
                 
                 Si le nom existe déjà, il doit être capable d'être ouvert par l'utilisateur courant
                 exécutant le processus, ou bien une exception sera lancée avec le message d'erreur
                 correspondant.

<comment>Return:</comment>
  <info>unknown</info>  Le nouvel objet <class>SyncMutex</class>.

<comment>See Also:</comment>
   * SyncMutex::lock
   * SyncMutex::unlock


id: SyncMutex::lock
type: function
doc:
<comment>Description:</comment>
  Obtient un verrou exclusif
  
  Obtient un verrou exclusif sur un objet <class>SyncMutex</class>. Si le verrou est déjà acquis, alors cette
  méthode va incrémenter le compteur interne.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  Le nombre de millisecondes à attendre pour l'obtention du verrou exclusif. Une valeur
              -1 signifie que l'on attend indéfiniement.

<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>
   * SyncMutex::unlock


id: SyncMutex::unlock
type: function
doc:
<comment>Description:</comment>
  Déverouille le mutex
  
  Décrémente le compteur interne d'un objet <class>SyncMutex</class>. Lorsque le compteur interne atteint zéro, le
  verrou actuel de l'objet est libéré.

<comment>Param:</comment>
  <info>bool</info>  <strong>$all</strong>  Spécifie si l'on doit ou non définir le compteur interne à zéro et donc, libérer le
              verrou.

<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>
   * SyncMutex::lock


id: SyncReaderWriter
type: class
doc:
<comment>Description:</comment>
  Une implémentation cross-plateforme, native des objets lecture-écriture nommés ou non.
  
  Un objet lecture-écriture autorisent plusieurs lectures, ou une écriture à accéder à une
  ressource. C'est une solution efficace pour gérer les ressources où l'accès est originalement en
  lecture seule mais qu'un accès en écriture est occasionnellement nécessaire.


id: SyncReaderWriter::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet SyncReaderWriter
  
  Construit un objet de lecture/écriture nommé ou non.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        Le nom de l'objet s'il est nommé.
                       
                       Si le nom existe déjà, l'objet doit pouvoir être ouvert avec l'utilisateur
                       courant qui exécute le processus, ou une exception sera émise contenant le
                       message d'erreur.
                       
                       Sous Windows, <strong>$name</strong> ne doit pas contenir de barres obliques inverses.
  <info>int</info>     <strong>$autounlock</strong>  Spécifie si l'on doit déverrouiller automatiquement l'objet à la fin du
                       script PHP.
                       
                       Si l'objet est un objet de lecture/écriture avec l'autounlock à <info>false</info>,
                       l'objet est verrouillé en lecture ou en écriture, et le script PHP va se
                       terminer avant le déverouillage de l'objet, et donc, l'objet sous-jacent se
                       terminera dans un statut non consistent.

<comment>Return:</comment>
  <info>unknown</info>  Le nouvel objet <class>SyncReaderWriter</class>.

<comment>See Also:</comment>
   * SyncReaderWriter::readlock
   * SyncReaderWriter::readunlock
   * SyncReaderWriter::writelock
   * SyncReaderWriter::writeunlock


id: SyncReaderWriter::readlock
type: function
doc:
<comment>Description:</comment>
  Obtiens un verrou de lecture
  
  Obtiens un verrou de lecture sur un objet <class>SyncReaderWriter</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  Le nombre de millisecondes à attente un verrou. Une valeur de -1 signifie que l'on
              attend indéfiniement.

<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>
   * SyncReaderWriter::readunlock


id: SyncReaderWriter::readunlock
type: function
doc:
<comment>Description:</comment>
  Libère un verrou de lecture
  
  Libère un verrou de lecture sur un objet <class>SyncReaderWriter</class>.

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

<comment>See Also:</comment>
   * SyncReaderWriter::readlock


id: SyncReaderWriter::writelock
type: function
doc:
<comment>Description:</comment>
  Obtiens un verrou d'écriture exclusif
  
  Obtiens un verrou d'écriture exclusif sur un objet <class>SyncReaderWriter</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  Le nombre de millisecondes à attendre le verrou. Une valeur de -1 signifie que l'on
              attend indéfiniement.

<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>
   * SyncReaderWriter::writeunlock


id: SyncReaderWriter::writeunlock
type: function
doc:
<comment>Description:</comment>
  Libère un verrou d'écriture
  
  Libère un verrou d'écriture sur un objet <class>SyncReaderWriter</class>.

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

<comment>See Also:</comment>
   * SyncReaderWriter::writelock


id: SyncSemaphore
type: class
doc:
<comment>Description:</comment>
  Une implémentation cross-plateforme, native des objets Sémaphore nommés ou non.
  
  Un sémaphore réstreint l'accès à une ressource limitée à un nombre limité d'instances. Les
  sémaphores diffèrent des mutexes dans le sens où il permet à plus d'une instance à accéder à une
  ressource en même temps, alors que le mutex ne permet qu'une seule instance à la fois.


id: SyncSemaphore::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet SyncSemaphore
  
  Construit un sémaphore nommé ou non.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        Le nom du sémaphore s'il est nommé.
                       
                       Si le nom existe déjà, l'objet doit pouvoir être ouvert par l'utilisateur
                       courant qui exécute le processus, ou une exception sera émise contenant le
                       message d'erreur.
  <info>int</info>     <strong>$initialval</strong>  La valeur initiale du sémaphore. Ce sera le nombre de verrous qui peuvent
                       être obtenus.
  <info>bool</info>    <strong>$autounlock</strong>  Spécifie si l'on doit ou non déverouiller automatiquement le sémaphore à la
                       fin du script PHP.
                       
                       Si l'objet est un sémaphore nommé dont l'autounlock vaut <info>false</info>, l'objet est
                       verrouillé, et le script PHP se termine avant que l'objet ne soit
                       déverouillé, alors le sémaphore sous-jacent se terminera dans un statut non
                       consistent.

<comment>Return:</comment>
  <info>unknown</info>  Le nouvel objet <class>SyncSemaphore</class>.

<comment>See Also:</comment>
   * SyncSemaphore::lock
   * SyncSemaphore::unlock


id: SyncSemaphore::lock
type: function
doc:
<comment>Description:</comment>
  Décrémente le compteur de l'objet SyncSemaphore ou attend
  
  Décrémente le compteur de l'objet <class>SyncSemaphore</class> ou attend que le sémaphore soit à une valeur
  différente de zéro.

<comment>Param:</comment>
  <info>int</info>  <strong>$wait</strong>  Le nombre de millisecondes à attendre le sémaphore. Une valuer à -1 signifie que l'on
              attend indéfiniement.

<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>
   * SyncSemaphore::unlock


id: SyncSemaphore::unlock
type: function
doc:
<comment>Description:</comment>
  Incrémente le compteur de l'objet SyncSemaphore
  
  Incrémente le compteur de l'objet <class>SyncSemaphore</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$prevcount</strong>  Retourne le compteur précédent du sémaphore.

<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>
   * SyncSemaphore::lock


id: SyncSharedMemory
type: class
doc:
<comment>Description:</comment>
  A cross-platform, native, consistent implementation of named shared memory objects.
  
  Shared memory lets two separate processes communicate without the need for complex pipes or
  sockets.  There are several integer-based shared memory implementations for PHP.  Named shared
  memory is an alternative.
  
  Synchronization objects (e.g. SyncMutex) are still required to protect most uses of shared memory.


id: SyncSharedMemory::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs a new SyncSharedMemory object
  
  Constructs a named shared memory object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the shared memory object.
                 
                 If the name already exists, it must be able to be opened by the current user that
                 the process is running as or an exception will be thrown with a meaningless error
                 message.
  <info>int</info>     <strong>$size</strong>  The size, in bytes, of shared memory to reserve.
                 
                 The amount of memory cannot be resized later.  Request sufficient storage up front.

<comment>Return:</comment>
  <info>unknown</info>  The new <class>SyncSharedMemory</class> object.

<comment>See Also:</comment>
   * SyncSharedMemory::first
   * SyncSharedMemory::size
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::first
type: function
doc:
<comment>Description:</comment>
  Check to see if the object is the first instance system-wide of named shared memory
  
  Retrieves the system-wide first instance status of a <class>SyncSharedMemory</class> object.

<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>
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::read
type: function
doc:
<comment>Description:</comment>
  Copy data from named shared memory
  
  Copies data from named shared memory.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>   The start/offset, in bytes, to begin reading.
                
                If the value is negative, the starting position will begin at the specified number
                of bytes from the end of the shared memory segment.
  <info>int</info>  <strong>$length</strong>  The number of bytes to read.
                
                If unspecified, reading will stop at the end of the shared memory segment.
                
                If the value is negative, reading will stop the specified number of bytes from the
                end of the shared memory segment.

<comment>Return:</comment>
  <info>unknown</info>  A string containing the data read from shared memory.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::first
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::size
type: function
doc:
<comment>Description:</comment>
  Returns the size of the named shared memory
  
  Retrieves the shared memory size of a <class>SyncSharedMemory</class> object.

<comment>Return:</comment>
  <info>int</info>  An integer containing the size of the shared memory. This will be the same size that was
       passed to the constructor.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SyncSharedMemory::write
type: function
doc:
<comment>Description:</comment>
  Copy data to named shared memory
  
  Copies data to named shared memory.

<comment>Param:</comment>
  <info>string</info>  <strong>$string</strong>  The data to write to shared memory.
                   
                   If the size of the data exceeds the size of the shared memory, the number of
                   bytes written returned will be less than the length of the input.
  <info>int</info>     <strong>$start</strong>   The start/offset, in bytes, to begin writing.
                   
                   If the value is negative, the starting position will begin at the specified
                   number of bytes from the end of the shared memory segment.

<comment>Return:</comment>
  <info>unknown</info>  An integer containing the number of bytes written to shared memory.

<comment>See Also:</comment>
   * SyncSharedMemory::__construct
   * SyncSharedMemory::first
   * SyncSharedMemory::write
   * SyncSharedMemory::read


id: SysvMessageQueue
type: class
doc:
<comment>Description:</comment>
  Une classe complètement opaque qui remplace la ressource <return>sysvmsg queue</return> à partir de PHP 8.0.0.


id: SysvSemaphore
type: class
doc:
<comment>Description:</comment>
  Une classe complètement opaque qui remplace la ressource <return>sysvsem</return> à partir de PHP 8.0.0.


id: SysvSharedMemory
type: class
doc:
<comment>Description:</comment>
  Une classe complètement opaque qui remplace la ressource <return>sysvshm</return> à partir de PHP 8.0.0.


id: Table::count
type: function
doc:
<comment>Description:</comment>
  Get row count
  
  Fetch the number of rows in the table.

<comment>Return:</comment>
  <info>int</info>  The total number of rows in the table.


id: Table::delete
type: function
doc:
<comment>Description:</comment>
  Delete rows from table
  
  Deletes rows from a table.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  A TableDelete object; use the execute() method to execute the delete
                             query.


id: Table::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Check if table exists in database
  
  Verifies if this table exists in the database.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if table exists in the database, else <info>false</info> if it does not.


id: Table::getName
type: function
doc:
<comment>Description:</comment>
  Get table name
  
  Returns the name of this database object.

<comment>Return:</comment>
  <info>string</info>  The name of this database object.


id: Table::getSchema
type: function
doc:
<comment>Description:</comment>
  Get table schema
  
  Fetch the schema associated with the table.

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  A Schema object.


id: Table::getSession
type: function
doc:
<comment>Description:</comment>
  Get table session
  
  Get session associated with the table.

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  A Session object.


id: Table::insert
type: function
doc:
<comment>Description:</comment>
  Insert table rows
  
  Inserts rows into a table.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$columns</strong>       The columns to insert data into. Can be an array with one or more values, or
                        a string.
  <info>mixed</info>  <strong>$more_columns</strong>  Additional columns definitions.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableInsert</info>  A TableInsert object; use the execute() method to execute the insert
                             statement.


id: Table::isView
type: function
doc:
<comment>Description:</comment>
  Check if table is view
  
  Determine if the underlying object is a view or not.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the underlying object is a view, otherwise <info>false</info>.


id: Table::select
type: function
doc:
<comment>Description:</comment>
  Select rows from table
  
  Fetches data from a table.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$columns</strong>       The columns to select data from. Can be an array with one or more values, or
                        a string.
  <info>mixed</info>  <strong>$more_columns</strong>  Additional columns parameter definitions.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object; use the execute() method to execute the select
                             and return a RowResult object.


id: Table::update
type: function
doc:
<comment>Description:</comment>
  Update rows in table
  
  Updates columns in a table.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  A TableUpdate object; use the execute() method to execute the update
                             statement.


id: TableDelete::__construct
type: function
doc:
<comment>Description:</comment>
  TableDelete constructor
  
  Initiated by using the delete() method.


id: TableDelete::bind
type: function
doc:
<comment>Description:</comment>
  Bind delete query parameters
  
  Binds a value to a specific placeholder.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  The name of the placeholder and the value to bind.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  A TableDelete object.


id: TableDelete::execute
type: function
doc:
<comment>Description:</comment>
  Execute delete query
  
  Execute the delete query.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object.


id: TableDelete::limit
type: function
doc:
<comment>Description:</comment>
  Limit deleted rows
  
  Sets the maximum number of records or documents to delete.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of records or documents to delete.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  TableDelete object.


id: TableDelete::orderby
type: function
doc:
<comment>Description:</comment>
  Set delete sort criteria
  
  Set the order options for a result set.

<comment>Param:</comment>
  <info>string</info>  <strong>$orderby_expr</strong>  The sort definition.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  A TableDelete object.


id: TableDelete::where
type: function
doc:
<comment>Description:</comment>
  Set delete search condition
  
  Sets the search condition to filter.

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  Define the search condition to filter documents or records.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableDelete</info>  TableDelete object.


id: TableInsert::__construct
type: function
doc:
<comment>Description:</comment>
  TableInsert constructor
  
  Initiated by using the insert() method.


id: TableInsert::execute
type: function
doc:
<comment>Description:</comment>
  Execute insert query
  
  Execute the statement.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object.


id: TableInsert::values
type: function
doc:
<comment>Description:</comment>
  Add insert row values
  
  Set the values to be inserted.

<comment>Param:</comment>
  <info>array</info>  <strong>$row_values</strong>  Values (an array) of columns to insert.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableInsert</info>  A TableInsert object.


id: TableSelect::__construct
type: function
doc:
<comment>Description:</comment>
  TableSelect constructor
  
  An object returned by the select() method; use execute() to  execute the query.


id: TableSelect::bind
type: function
doc:
<comment>Description:</comment>
  Bind select query parameters
  
  Binds a value to a specific placeholder.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  The name of the placeholder, and the value to bind.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::execute
type: function
doc:
<comment>Description:</comment>
  Execute select statement
  
  Execute the select statement by chaining it with the execute() method.

<comment>Return:</comment>
  <info>mysql_xdevapi\RowResult</info>  A RowResult object.


id: TableSelect::groupBy
type: function
doc:
<comment>Description:</comment>
  Set select grouping criteria
  
  Sets a grouping criteria for the result set.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sort_expr</strong>  The grouping criteria.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::having
type: function
doc:
<comment>Description:</comment>
  Set select having condition
  
  Sets a condition for records to consider in aggregate function operations.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  A condition on the aggregate functions used on the grouping criteria.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::limit
type: function
doc:
<comment>Description:</comment>
  Limit selected rows
  
  Sets the maximum number of records or documents to return.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of records or documents.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::lockExclusive
type: function
doc:
<comment>Description:</comment>
  Execute EXCLUSIVE LOCK
  
  Execute a read operation with EXCLUSIVE LOCK. Only one lock can be active at a time.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  The optional waiting option that defaults to <info>MYSQLX_LOCK_DEFAULT</info>. Valid
                             values are:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  TableSelect object.


id: TableSelect::lockShared
type: function
doc:
<comment>Description:</comment>
  Execute SHARED LOCK
  
  Execute a read operation with SHARED LOCK. Only one lock can be active at a time.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  The optional waiting option that defaults to <info>MYSQLX_LOCK_DEFAULT</info>.
                             Valid values are:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::offset
type: function
doc:
<comment>Description:</comment>
  Set limit offset
  
  Skip given number of rows in result.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  The limit offset.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::orderby
type: function
doc:
<comment>Description:</comment>
  Set select sort criteria
  
  Sets the order by criteria.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$sort_expr</strong>   The expressions that define the order by criteria. Can be an array with one or
                      more expressions, or a string.
  <info>mixed</info>  <strong>$sort_exprs</strong>  Additional sort_expr parameters.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableSelect::where
type: function
doc:
<comment>Description:</comment>
  Set select search condition
  
  Sets the search condition to filter.

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  Define the search condition to filter documents or records.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableSelect</info>  A TableSelect object.


id: TableUpdate::__construct
type: function
doc:
<comment>Description:</comment>
  TableUpdate constructor
  
  Initiated by using the update() method.


id: TableUpdate::bind
type: function
doc:
<comment>Description:</comment>
  Bind update query parameters
  
  Binds a value to a specific placeholder.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  The name of the placeholder, and the value to bind, defined as a JSON
                              array.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  A TableUpdate object.


id: TableUpdate::execute
type: function
doc:
<comment>Description:</comment>
  Execute update query
  
  Executes the update statement.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  A TableUpdate object.


id: TableUpdate::limit
type: function
doc:
<comment>Description:</comment>
  Limit update row count
  
  Set the maximum number of records or documents update.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of records or documents to update.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  A TableUpdate object.


id: TableUpdate::orderby
type: function
doc:
<comment>Description:</comment>
  Set sorting criteria
  
  Sets the sorting criteria.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$orderby_expr</strong>   The expressions that define the order by criteria. Can be an array with one
                         or more expressions, or a string.
  <info>mixed</info>  <strong>$orderby_exprs</strong>  Additional sort_expr parameters.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate object.


id: TableUpdate::set
type: function
doc:
<comment>Description:</comment>
  Add field to be updated
  
  Updates the column value on records in a table.

<comment>Param:</comment>
  <info>string</info>  <strong>$table_field</strong>            The column name to be updated.
  <info>string</info>  <strong>$expression_or_literal</strong>  The value to be set on the specified column.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  TableUpdate object.


id: TableUpdate::where
type: function
doc:
<comment>Description:</comment>
  Set search filter
  
  Set the search condition to filter.

<comment>Param:</comment>
  <info>string</info>  <strong>$where_expr</strong>  The search condition to filter documents or records.

<comment>Return:</comment>
  <info>mysql_xdevapi\TableUpdate</info>  A TableUpdate object.


id: Thread
type: class
doc:
<comment>Description:</comment>
  Quand la méthode start d'un Thread est appelée, le code de la méthode run sera  exécuté de façon
  parallèle dans un Thread séparé.
  
  Après l'exécution de la méthode run, le Thread se terminera immédiatement, il  sera rattaché au
  Thread d'origine par la suite.
  
  S'appuyer sur le moteur pour déterminer quand un Thread sera rattaché peut  provoquer un
  comportement non désiré. Le développeur doit être explicite  tant que possible.


id: Thread::getCreatorId
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Retourne l'identité du Thread qui a créé le Thread référencé.

<comment>Return:</comment>
  <info>int</info>  Une identité numérique.


id: Thread::getCurrentThread
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Retourne un référence du thread actuellement en cours d'exécution

<comment>Return:</comment>
  <info>Thread</info>  Un objet représentant le thread actuellement en cours d'exécution.


id: Thread::getCurrentThreadId
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Retourne l'identité du thread actuellement en cours d'exécution

<comment>Return:</comment>
  <info>int</info>  Une identité numérique


id: Thread::getThreadId
type: function
doc:
<comment>Description:</comment>
  Identification
  
  Retourne l'identité du Thread référencé.

<comment>Return:</comment>
  <info>int</info>  Une identité numérique.


id: Thread::isJoined
type: function
doc:
<comment>Description:</comment>
  Détection de statut
  
  Indique si le Thread référencé a été joint.

<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: Thread::isStarted
type: function
doc:
<comment>Description:</comment>
  Détection de statut
  
  Indique si le Thread référencé a été démarré.

<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: Thread::join
type: function
doc:
<comment>Description:</comment>
  Synchronisation
  
  Fait attendre le contexte appelant du Thread référencé la fin de l'exécution.

<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: Thread::start
type: function
doc:
<comment>Description:</comment>
  Exécution
  
  Démarre un nouveau Thread et exécute la méthode run implémentée.

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  Un masque optionnel de constantes héritées ; par défaut, PTHREADS_INHERIT_ALL

<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: Threaded
type: class
doc:
<comment>Description:</comment>
  Les objets Threaded sont la base de pthreads pour exécuter du code de facon parallèle;  ils
  exposent et incluent des méthodes de synchronisation ainsi que diverses interfaces utiles.
  
  Les objets Threaded fournissent une sécurité native pour le développeur; toutes les opérations
  sont thread-safe dans le scope de l'objet.


id: Threaded::chunk
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Parcours une partie de la table des propriétés des objets en préservant, optionnellement, les
  clés.

<comment>Param:</comment>
  <info>int</info>   <strong>$size</strong>      Le nombre d'éléments à parcourir
  <info>bool</info>  <strong>$preserve</strong>  Préserve les clés des membres ; par défaut, vaut <info>false</info>

<comment>Return:</comment>
  <info>array</info>  Un tableau d'éléments depuis la table de propriétés des objets.


id: Threaded::count
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Retourne le nombre de propriétés pour cet objet.

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


id: Threaded::extend
type: function
doc:
<comment>Description:</comment>
  Manipulation pendant l'exécution
  
  Rend la classe standart sécurisée au nivau du thread pendant l'exécution.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  La classe à étendre.

<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: Threaded::isRunning
type: function
doc:
<comment>Description:</comment>
  Détection de statut
  
  Demande si l'objet référencé est en cours d'exécution.

<comment>Return:</comment>
  <info>bool</info>  Un booléen indiquant le statut.  Un objet est considéré comme étant en cours d'exécution
        lorsqu'il exécute la méthode run.
        
        Un objet est considéré comme étant en cours d'exécution lorsqu'il exécute la méthode run.


id: Threaded::isTerminated
type: function
doc:
<comment>Description:</comment>
  Détection de statut
  
  Demande si l'objet référencé s'est terminé durant l'exécution ; si il a subi une erreur fatale ou
  émis des exceptions qui n'ont pu être attrapées.

<comment>Return:</comment>
  <info>bool</info>  Un booléen indiquant le statut.


id: Threaded::merge
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Fusionne les données dans l'objet courant

<comment>Param:</comment>
  <info>mixed</info>  <strong>$from</strong>       Les données à fusionner
  <info>bool</info>   <strong>$overwrite</strong>  Ecrase les clés existantes ; par défaut vaut <info>true</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.


id: Threaded::notify
type: function
doc:
<comment>Description:</comment>
  Synchronisation
  
  Envoi une notification à l'objet référencé

<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: Threaded::notifyOne
type: function
doc:
<comment>Description:</comment>
  Synchronization
  
  Send notification to the referenced object. This unblocks at least one of the blocked threads (as
  opposed to unblocking all of them, as seen with Threaded::notify).

<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: Threaded::pop
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Enlève le dernier élément depuis la table des propriétés de l'objet.

<comment>Return:</comment>
  <info>bool</info>  Le dernier élément de la table des propriétés de l'objet.


id: Threaded::run
type: function
doc:
<comment>Description:</comment>
  Exécution
  
  Le développeur doit toujours implément la méthode run pour les objets qui doivent être exécuté.

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


id: Threaded::shift
type: function
doc:
<comment>Description:</comment>
  Manipulation
  
  Enlève le premier élément depuis la table de propriétés de l'objet.

<comment>Return:</comment>
  <info>bool</info>  Le premier élément depuis la table de propriétés de l'objet.


id: Threaded::synchronized
type: function
doc:
<comment>Description:</comment>
  Synchronisation
  
  Exécute le bloc tout en retenant les verrous de synchronisation des objets référencés pour le
  contexte appelant.

<comment>Param:</comment>
  <info>Closure</info>  <strong>$block</strong>  Le bloc de code à exécuter
  <info>mixed</info>    <strong>$args</strong>   Liste variable d'arguments à utiliser comme argument de la fonction

<comment>Return:</comment>
  <info>mixed</info>  La valeur retournée du bloc


id: Threaded::wait
type: function
doc:
<comment>Description:</comment>
  Synchronisation
  
  Fera attendre le contexte appelant une notification depuis l'objet référencé.

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  Un délai d'attente maximal optionnel, en microsecondes.

<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: Throwable
type: class
doc:
<comment>Description:</comment>
  <class>Throwable</class> est l'interface de base pour tout objet qui peut être jeté grâce à la déclaration <return>throw</return>,
  ceci inclus <class>Error</class> et <class>Exception</class>.
  
  Les classes PHP ne peuvent pas directement implémenter l'interface <class>Throwable</class>, et doivent à la
  place étendre de <class>Exception</class>.


id: Throwable::__toString
type: function
doc:
<comment>Description:</comment>
  Récupère la représentation sous forme de chaîne de caractère de l'objet jeté

<comment>Return:</comment>
  <info>string</info>  Retourne la représentation sous forme de chaîne de caractères de l'objet jeté.

<comment>See Also:</comment>
   * Exception::__toString


id: Throwable::getCode
type: function
doc:
<comment>Description:</comment>
  Récupère le code de l'exception
  
  Retourne le code d'erreur associé avec l'objet jeté.

<comment>Return:</comment>
  <info>int</info>  Retourne le code de l'exception en tant que entier dans <class>Exception</class> mais éventuellement sous un
       autre type dans les descendants de <class>Exception</class> (par exemple chaîne de caractères dans
       <class>PDOException</class>).

<comment>See Also:</comment>
   * Exception::getCode


id: Throwable::getFile
type: function
doc:
<comment>Description:</comment>
  Récupère le fichier où l'objet a été créé
  
  Récupère le fichier où l'objet lancé a été créé.

<comment>Return:</comment>
  <info>string</info>  Retourne le nom de fichier où l'objet lancé a été créé.

<comment>See Also:</comment>
   * Exception::getFile


id: Throwable::getLine
type: function
doc:
<comment>Description:</comment>
  Récupère le numéro de ligne où l'objet instancié a été jeté
  
  Récupère le numéro de ligne où l'objet instancié a été jeté.

<comment>Return:</comment>
  <info>int</info>  Retourne le numéro de ligne où l'objet instancié a été jeté.

<comment>See Also:</comment>
   * Exception::getLine


id: Throwable::getMessage
type: function
doc:
<comment>Description:</comment>
  Récupère le message
  
  Retourne le message associé avec l'objet jeté.

<comment>Return:</comment>
  <info>string</info>  Retourne le message associé avec l'objet jeté.

<comment>See Also:</comment>
   * Exception::getMessage


id: Throwable::getPrevious
type: function
doc:
<comment>Description:</comment>
  Retourne le Throwable précédent
  
  Retourne un Throwable précedent (par exemple, un fournit grâce au troisième paramètre de
  Exception::__construct).

<comment>Return:</comment>
  <info>Throwable|null</info>  Retourne le <class>Throwable</class> précédent si disponible ou <info>null</info> sinon.

<comment>See Also:</comment>
   * Exception::getPrevious


id: Throwable::getTrace
type: function
doc:
<comment>Description:</comment>
  Récupère la trace d'appels
  
  Retourne la trace d'appels en tant que tableau.

<comment>Return:</comment>
  <info>array</info>  Retourne la trace d'appels en tant que tableau dans le même format que <strong>debug_backtrace()</strong>.

<comment>See Also:</comment>
   * Exception::getTrace


id: Throwable::getTraceAsString
type: function
doc:
<comment>Description:</comment>
  Récupère la trace d'appels en tant que chaîne de caractères

<comment>Return:</comment>
  <info>string</info>  Retourne la trace d'appels en tant que chaîne de caractères.

<comment>See Also:</comment>
   * Exception::getTraceAsString


id: Tidy::getopt
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur de l'option de configuration Tidy
  
  Style orienté objet
  
  Style procédural
  
  <strong>tidy_getopt()</strong> retourne la valeur de l'option spécifiée <strong>$option</strong> pour l'objet <strong>$tidy</strong>. Le type
  retourné dépend du type de l'option spécifiée <strong>$option</strong>.

<comment>Param:</comment>
  <info>tidy</info>    <strong>$tidy</strong>    L'objet <class>Tidy</class>
  <info>string</info>  <strong>$option</strong>  Pour une explication sur chaque option, voyez
                   http://api.html-tidy.org/#quick-reference.

<comment>Return:</comment>
  <info>string|int|bool</info>  Retourne la valeur spécifiée par l'option  <strong>$option</strong>. Le type de la valeur dépend
                   de l'option elle-même.


id: Transliterator
type: class
doc:
<comment>Description:</comment>
  La classe Transliterator fournit la translittération des chaînes de caractères.


id: Transliterator::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur privé pour interdire l'instantiation
  
  Cette méthode ne doit pas être appelée. Son seul but est d'interdire l'instantiation avec
  l'opérateur new operator.
  
  Utilisez les méthodes factorisées Transliterator::create et Transliterator::createFromRules à la
  place.

<comment>See Also:</comment>
   * Transliterator::create
   * Transliterator::createFromRules


id: Transliterator::create
type: function
doc:
<comment>Description:</comment>
  Crée un Transliterator
  
  Style orienté objet
  
  Style procédural
  
  Ouvre un Transliterator par son identifiant.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>         L'identifiant. Une listede tous les identifiants transliterator enregistrés
                      peut être retrouvée en utilisant la méthode Transliterator::listIDs.
  <info>int</info>     <strong>$direction</strong>  La direction, par défaut  Transliterator::FORWARD. Peut également être défini
                      à Transliterator::REVERSE.

<comment>Return:</comment>
  <info>Transliterator|null</info>  Retourne un objet <class>Transliterator</class> en cas de succès, ou <info>null</info> si une erreur
                       survient.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


id: Transliterator::createFromRules
type: function
doc:
<comment>Description:</comment>
  Crée un translittérateur depuis des règles
  
  Style orienté objet
  
  Style procédural
  
  Crée un translittérateur depuis des règles.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$rules</strong>      Les règles comme définie dans Transform Rules Syntax de UTS #35 : Unicode
                      LDML.
  <info>int</info>     <strong>$direction</strong>  La direction, par défaut Transliterator::FORWARD. Peut également être défini à
                      Transliterator::REVERSE.

<comment>Return:</comment>
  <info>Transliterator|null</info>  Retourne un objet <class>Transliterator</class> en cas de succès, ou <info>null</info> si une erreur
                       survient.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


id: Transliterator::createInverse
type: function
doc:
<comment>Description:</comment>
  Crée un translittérateur inverse
  
  Style orienté objet
  
  Style procédural
  
  Crée un translittérateur inverse.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>Transliterator|null</info>  Retourne un objet <class>Transliterator</class> en cas de succès, ou <info>null</info> si une erreur
                       survient.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::create


id: Transliterator::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Récupère le dernier code erreur
  
  Style orienté objet
  
  Style procédural
  
  Récupère le dernier code erreur depuis ce translittérateur.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>Transliterator</info>  <strong>$transliterator</strong>  

<comment>Return:</comment>
  <info>int|false</info>  Le code erreur en cas de succès, ou <info>false</info> s'il n'en existe pas ou si une erreur
             survient.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::listIDs


id: Transliterator::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Récupère le dernier message d'erreur
  
  Style orienté objet
  
  Style procédural
  
  Récupère le dernier message d'erreur depuis ce translittérateur.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>Transliterator</info>  <strong>$transliterator</strong>  

<comment>Return:</comment>
  <info>string|false</info>  Le message d'erreur en cas de succès, ou <info>false</info> si aucune erreur n'existe, ou si une
                erreur survient.

<comment>See Also:</comment>
   * Transliterator::getErrorCode
   * Transliterator::listIDs


id: Transliterator::listIDs
type: function
doc:
<comment>Description:</comment>
  Récupère les identifiants de ce translittérateur
  
  Style orienté objet
  
  Style procédural
  
  Retourne un tableau contenant tous les identifiants enregistrés pour ce translittérateur.

<comment>Return:</comment>
  <info>array|false</info>  Un tableau contenant tous les identifiants enregistrés pour ce translittérateur en
               cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::transliterate


id: Transliterator::transliterate
type: function
doc:
<comment>Description:</comment>
  Translittère une chaîne de caractères
  
  Style orienté objet
  
  Style procédural
  
  Transforme une chaîne de caractères ou seulement une partie en utilisant un translittérateur ICU.

<comment>Param:</comment>
  <info>Transliterator|string</info>  <strong>$transliterator</strong>  Dans la version procédurale, soit un <class>Transliterator</class> soit
                                          une chaîne de caractères depuis laquelle un <class>Transliterator</class>
                                          peut être construit.
  <info>string</info>                 <strong>$string</strong>          La chaîne de caractères à transformer.
  <info>int</info>                    <strong>$start</strong>           L'index de départ (en unité UTF-16) depuis lequel la
                                          chaîne commencera à être transformée, inclusif. Les index
                                          commencent à 0. Le texte avant cet index restera inchangé.
  <info>int</info>                    <strong>$end</strong>             L'index de fin (en unité UTF-16) indiquant la fin de la
                                          transformation, exclusif. Les index commencent à 0. Le
                                          texte après cet index restera inchangé.

<comment>Return:</comment>
  <info>string|false</info>  La chaîne de caractères transformée en cas de succès, ou <info>false</info> si une erreur
                survient.

<comment>See Also:</comment>
   * Transliterator::getErrorMessage
   * Transliterator::__construct


id: Traversable
type: class
doc:
<comment>Description:</comment>
  Interface permettant de détecter si une classe peut être parcourue en utilisant foreach.
  
  L'interface de base est abstraite et ne peut être implémentée seule. Elle doit être implémentée
  par soit IteratorAggregate, soit Iterator.


id: UConverter::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un objet UConverter
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$destination_encoding</strong>  
  <info>string|null</info>  <strong>$source_encoding</strong>       


id: UConverter::convert
type: function
doc:
<comment>Description:</comment>
  Convertit une chaîne d'un jeu de caractères vers un autre jeu de caractères
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$str</strong>      
  <info>bool</info>    <strong>$reverse</strong>  

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


id: UConverter::fromUCallback
type: function
doc:
<comment>Description:</comment>
  Fonction de rappel "from"
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>    <strong>$reason</strong>     
  <info>array</info>  <strong>$source</strong>     
  <info>int</info>    <strong>$codePoint</strong>  
  <info>int</info>    <strong>$error</strong>      

<comment>Return:</comment>
  <info>string|int|array|null</info>  


id: UConverter::getAliases
type: function
doc:
<comment>Description:</comment>
  Récupère les alias du nom fourni
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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

<comment>Return:</comment>
  <info>array|false|null</info>  


id: UConverter::getAvailable
type: function
doc:
<comment>Description:</comment>
  Récupère le nom canonique des convertisseurs diponibles
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: UConverter::getDestinationEncoding
type: function
doc:
<comment>Description:</comment>
  Récupère l'encodage de la destination
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: UConverter::getDestinationType
type: function
doc:
<comment>Description:</comment>
  Récupère le type de la destination du convertisseur
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int|false|null</info>  


id: UConverter::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Récupère le code de la dernière erreur survenue sur l'objet
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: UConverter::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Récupère le message de la dernière erreur survenue sur l'objet
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: UConverter::getSourceEncoding
type: function
doc:
<comment>Description:</comment>
  Récupère l'encodage de la source
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: UConverter::getSourceType
type: function
doc:
<comment>Description:</comment>
  Récupère le type de source du convertisseur
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int|false|null</info>  


id: UConverter::getStandards
type: function
doc:
<comment>Description:</comment>
  Récupère les normes associées aux noms de conversion
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: UConverter::getSubstChars
type: function
doc:
<comment>Description:</comment>
  Récupère les caractères de substitution
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: UConverter::reasonText
type: function
doc:
<comment>Description:</comment>
  Récupère la chaîne représentant la raison de la fonction de rappel
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>  <strong>$reason</strong>  

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


id: UConverter::setDestinationEncoding
type: function
doc:
<comment>Description:</comment>
  Définit l'encodage de la destination
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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

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


id: UConverter::setSourceEncoding
type: function
doc:
<comment>Description:</comment>
  Définit l'encodage de la source
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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

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


id: UConverter::setSubstChars
type: function
doc:
<comment>Description:</comment>
  Définit les caractères de substitution
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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

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


id: UConverter::toUCallback
type: function
doc:
<comment>Description:</comment>
  Fonction de rappel "to"
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>     <strong>$reason</strong>     
  <info>string</info>  <strong>$source</strong>     
  <info>string</info>  <strong>$codeUnits</strong>  
  <info>int</info>     <strong>$error</strong>      

<comment>Return:</comment>
  <info>string|int|array|null</info>  


id: UConverter::transcode
type: function
doc:
<comment>Description:</comment>
  Convertit une chaîne d'un jeu de caractères à un autre
  
  Convertit <strong>$str</strong> de <strong>$fromEncoding</strong> à <strong>$toEncoding</strong>.

<comment>Param:</comment>
  <info>string</info>      <strong>$str</strong>           La chaîne de caractères à convertir.
  <info>string</info>      <strong>$toEncoding</strong>    Le jeu de caractères souhaité pour le résultat.
  <info>string</info>      <strong>$fromEncoding</strong>  Le jeu de caractères actuel utilisé pour interpréter <strong>$str</strong>.
  <info>array|null</info>  <strong>$options</strong>       Un tableau optionnel, qui peut contenir les clés suivantes : <return>'to_subst'</return>
                             - le caractère de substitution à utiliser à la place de tout caractère
                             de <strong>$str</strong> qui ne peut pas être encodé en <strong>$toEncoding</strong>. S'il est spécifié,
                             il doit représenter un seul caractère dans l'encodage cible.

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

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


id: UI\Area
type: class
doc:
<comment>Description:</comment>
  An Area represents a canvas which can be used to draw, and respond to mouse and key events.


id: UI\Area::Alt
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the ALT key is active


id: UI\Area::Ctrl
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the CTRL key is active


id: UI\Area::Shift
type: constant
doc:
<comment>Description:</comment>
  Shall be set in the modifiers passed to key and mouse events when the SHIFT key is active


id: UI\Area::onDraw
type: function
doc:
<comment>Description:</comment>
  Draw Callback
  
  Shall be invoked when this Area requires redrawing

<comment>Param:</comment>
  <info>UI\Draw\Pen</info>  <strong>$pen</strong>        A Pen suitable for drawing in this Area
  <info>UI\Size</info>      <strong>$areaSize</strong>   The size of the Area
  <info>UI\Point</info>     <strong>$clipPoint</strong>  The clip point of the Area
  <info>UI\Size</info>      <strong>$clipSize</strong>   The clip size of the Area


id: UI\Area::onKey
type: function
doc:
<comment>Description:</comment>
  Key Callback
  
  Shall be executed on key events

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    The key pressed
  <info>int</info>     <strong>$ext</strong>    The extended key pressed
  <info>int</info>     <strong>$flags</strong>  Event modifiers


id: UI\Area::onMouse
type: function
doc:
<comment>Description:</comment>
  Mouse Callback
  
  Shall be executed on mouse events

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$areaPoint</strong>  The co-ordinates of the event
  <info>UI\Size</info>   <strong>$areaSize</strong>   The size of the area of the event
  <info>int</info>       <strong>$flags</strong>      Event modifiers


id: UI\Area::scrollTo
type: function
doc:
<comment>Description:</comment>
  Area Scroll
  
  Scroll this Area

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to scroll to
  <info>UI\Size</info>   <strong>$size</strong>   The size of the scroll pane


id: UI\Area::setSize
type: function
doc:
<comment>Description:</comment>
  Set Size
  
  Sets the size of this Area

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  The new size


id: UI\Control::getParent
type: function
doc:
<comment>Description:</comment>
  Get Parent Control
  
  Shall return the parent Control

<comment>Return:</comment>
  <info>UI\Control</info>  


id: UI\Control::getTopLevel
type: function
doc:
<comment>Description:</comment>
  Get Top Level
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: UI\Control::isEnabled
type: function
doc:
<comment>Description:</comment>
  Determine if Control is enabled
  
  Shall detect if this Control is enabled

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


id: UI\Control::isVisible
type: function
doc:
<comment>Description:</comment>
  Determine if Control is visible
  
  Shall detect if this Control is visible

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


id: UI\Control::setParent
type: function
doc:
<comment>Description:</comment>
  Set Parent Control
  
  Shall set the parent Control of this Control

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$parent</strong>  The parent Control


id: UI\Controls\Box::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Box
  
  Shall construct a new box

<comment>Param:</comment>
  <info>int</info>  <strong>$orientation</strong>  Box::Horizontal or Box::Vertical


id: UI\Controls\Box::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append the given control to this Box

<comment>Param:</comment>
  <info>Control</info>  <strong>$control</strong>   The control to append
  <info>bool</info>     <strong>$stretchy</strong>  Set true to stretch the control

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Box::delete
type: function
doc:
<comment>Description:</comment>
  Delete Control
  
  Shall delete the control at the given index from this Box

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the control to delete

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Controls\Box::getOrientation
type: function
doc:
<comment>Description:</comment>
  Get Orientation
  
  Shall retrieve the orientation of this Box

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


id: UI\Controls\Box::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Box

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


id: UI\Controls\Box::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding on this Box

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


id: UI\Controls\Button::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Button
  
  Shall construct a new Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for this Button


id: UI\Controls\Button::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall retrieve the text (label) for this Button

<comment>Return:</comment>
  <info>string</info>  The current text (label)


id: UI\Controls\Button::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text (label) for this Button

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text (label)


id: UI\Controls\Check::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Check
  
  Shall construct a new Check

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for the Check box


id: UI\Controls\Check::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the text (label) for this Check

<comment>Return:</comment>
  <info>string</info>  The current text (label)


id: UI\Controls\Check::isChecked
type: function
doc:
<comment>Description:</comment>
  Checked Detection
  
  Shall detect the status of this Check

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


id: UI\Controls\Check::onToggle
type: function
doc:
<comment>Description:</comment>
  Toggle Callback
  
  Shall be executed when the status of this Check is changed


id: UI\Controls\Check::setChecked
type: function
doc:
<comment>Description:</comment>
  Set Checked
  
  Shall change the status of this Check

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  The new status


id: UI\Controls\Check::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text (label) for this Check

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text (label)


id: UI\Controls\ColorButton
type: class
doc:
<comment>Description:</comment>
  A Color Button is a button which displays a color picker when clicked


id: UI\Controls\ColorButton::getColor
type: function
doc:
<comment>Description:</comment>
  Get Color
  
  Shall retrieve the currently selected Color

<comment>Return:</comment>
  <info>UI\Color</info>  


id: UI\Controls\ColorButton::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the selected Color is changed


id: UI\Controls\ColorButton::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the currently selected Color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  The new color


id: UI\Controls\Combo
type: class
doc:
<comment>Description:</comment>
  A Combo control represents a list of options, like the familiar select HTML element.


id: UI\Controls\Combo::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Append an option to this Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for the new option


id: UI\Controls\Combo::getSelected
type: function
doc:
<comment>Description:</comment>
  Get Selected Option
  
  Shall retrieve the index of the option selected in this Combo

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


id: UI\Controls\Combo::onSelected
type: function
doc:
<comment>Description:</comment>
  Selected Handler
  
  Shall be executed when an option is selected in this Combo


id: UI\Controls\Combo::setSelected
type: function
doc:
<comment>Description:</comment>
  Set Selected Option
  
  Shall set the currently selected option in this Combo

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the option to select


id: UI\Controls\EditableCombo
type: class
doc:
<comment>Description:</comment>
  An Editable Combo is a Combo which allows the user to enter custom options


id: UI\Controls\EditableCombo::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Shall append a new option to this Editable Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for the new option


id: UI\Controls\EditableCombo::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Get the value of the currently selected option in this Editable Combo

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


id: UI\Controls\EditableCombo::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value of this Editable Combobox changes


id: UI\Controls\EditableCombo::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text of the currently selected option in this Editable Combo

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Entry
type: class
doc:
<comment>Description:</comment>
  An Entry is a text entry control, suitable for entering plain text, passwords, or search terms.


id: UI\Controls\Entry::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Entry
  
  Construct a new entry of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Entry::Normal, Entry::Password, or Entry::Search


id: UI\Controls\Entry::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the current text from this Entry

<comment>Return:</comment>
  <info>string</info>  The current text


id: UI\Controls\Entry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Detect Read Only
  
  Shall detect if this Entry is read only

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


id: UI\Controls\Entry::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the text in this Entry changes


id: UI\Controls\Entry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Set Read Only
  
  Shall enable or disable read only for this Entry

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


id: UI\Controls\Entry::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text for this Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Form
type: class
doc:
<comment>Description:</comment>
  A Form is a control which allows the arrangement of other controls into a familiar layout (the
  form).


id: UI\Controls\Form::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append the control to the form, and set the label

<comment>Param:</comment>
  <info>string</info>      <strong>$label</strong>     The text for the label
  <info>UI\Control</info>  <strong>$control</strong>   A control
  <info>bool</info>        <strong>$stretchy</strong>  Should be set true to stretch the control

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Form::delete
type: function
doc:
<comment>Description:</comment>
  Delete Control
  
  Shall delete the control at the given index in this Form

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the control to remove

<comment>Return:</comment>
  <info>bool</info>  Indication of succcess


id: UI\Controls\Form::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Form

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


id: UI\Controls\Form::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding on this Form

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


id: UI\Controls\Grid
type: class
doc:
<comment>Description:</comment>
  A Grid is a control which is allows the arrangement of children into a grid


id: UI\Controls\Grid::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The Control to append
  <info>int</info>         <strong>$left</strong>     
  <info>int</info>         <strong>$top</strong>      
  <info>int</info>         <strong>$xspan</strong>    
  <info>int</info>         <strong>$yspan</strong>    
  <info>bool</info>        <strong>$hexpand</strong>  
  <info>int</info>         <strong>$halign</strong>   
  <info>bool</info>        <strong>$vexpand</strong>  
  <info>int</info>         <strong>$valign</strong>   


id: UI\Controls\Grid::isPadded
type: function
doc:
<comment>Description:</comment>
  Padding Detection
  
  Shall detect if padding is enabled on this Grid

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


id: UI\Controls\Grid::setPadded
type: function
doc:
<comment>Description:</comment>
  Set Padding
  
  Shall enable or disable padding for this Grid

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


id: UI\Controls\Group::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Group
  
  Shall construct a new Group with the given title

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The text for the title label


id: UI\Controls\Group::append
type: function
doc:
<comment>Description:</comment>
  Append Control
  
  Shall append a control to this Group

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The control to append


id: UI\Controls\Group::getTitle
type: function
doc:
<comment>Description:</comment>
  Get Title
  
  Shall return the current title for this Group

<comment>Return:</comment>
  <info>string</info>  The current title


id: UI\Controls\Group::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if this Group has a margin

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


id: UI\Controls\Group::setMargin
type: function
doc:
<comment>Description:</comment>
  Set Margin
  
  Shall enable or disable margins for this Group

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


id: UI\Controls\Group::setTitle
type: function
doc:
<comment>Description:</comment>
  Set Title
  
  Shall set the title for this Group

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The text for the new title


id: UI\Controls\Label
type: class
doc:
<comment>Description:</comment>
  A Label is a single line of text, meant to identify, for the user, some element of the interface.


id: UI\Controls\Label::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Label
  
  Shall construct a new Label

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text for this label


id: UI\Controls\Label::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the current text for this Label
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: UI\Controls\Label::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text for this Label

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\MultilineEntry
type: class
doc:
<comment>Description:</comment>
  A Multiline Entry is a text entry control able to hold multiple lines of text, with or without
  wrapping.


id: UI\Controls\MultilineEntry::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Multiline Entry
  
  Shall construct a new Multiline Entry of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  MultilineEntry::Wrap or MultilineEntry::NoWrap


id: UI\Controls\MultilineEntry::append
type: function
doc:
<comment>Description:</comment>
  Append Text
  
  Shall append the given text to the text in this Multiline Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text to append


id: UI\Controls\MultilineEntry::getText
type: function
doc:
<comment>Description:</comment>
  Get Text
  
  Shall return the text in this Multiline Entry

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


id: UI\Controls\MultilineEntry::isReadOnly
type: function
doc:
<comment>Description:</comment>
  Read Only Detection
  
  Shall detect if this Multiline Entry is read only

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


id: UI\Controls\MultilineEntry::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the text in this Multiline Entry is changed


id: UI\Controls\MultilineEntry::setReadOnly
type: function
doc:
<comment>Description:</comment>
  Set Read Only
  
  Shall enable or disable read only on this Multiline Entry

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


id: UI\Controls\MultilineEntry::setText
type: function
doc:
<comment>Description:</comment>
  Set Text
  
  Shall set the text in this Multiline Entry

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The new text


id: UI\Controls\Picker
type: class
doc:
<comment>Description:</comment>
  A Picker represents a button which when clicked presents a native Date/Time/DateTime Picker
  interface to the user.


id: UI\Controls\Picker::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Picker
  
  Construct a new Picker of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Picker::Date, Picker::Time, or Picker::DateTime


id: UI\Controls\Progress
type: class
doc:
<comment>Description:</comment>
  A Progress control is a familiar Progress bar: It represents progress as a percentage, with a
  possible range of 0 to 100 (inclusive).


id: UI\Controls\Progress::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Shall retrieve the current value of this Progress bar

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


id: UI\Controls\Progress::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Shall set the value for this Progress bar

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  An integer between 0 and 100 (inclusive)


id: UI\Controls\Radio::append
type: function
doc:
<comment>Description:</comment>
  Append Option
  
  Shall append a new option to this Radio

<comment>Param:</comment>
  <info>string</info>  <strong>$text</strong>  The text (label) for the option


id: UI\Controls\Radio::getSelected
type: function
doc:
<comment>Description:</comment>
  Get Selected Option
  
  Shall retrieve the index of the currently selected option in this Radio

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


id: UI\Controls\Radio::onSelected
type: function
doc:
<comment>Description:</comment>
  Selected Handler
  
  Shall be executed when the option selected in this Radio changes


id: UI\Controls\Radio::setSelected
type: function
doc:
<comment>Description:</comment>
  Set Selected Option
  
  Shall set the currently selected option in this Radio

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the option to select


id: UI\Controls\Separator
type: class
doc:
<comment>Description:</comment>
  A Separator represents a control separator, it has no other function.


id: UI\Controls\Separator::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Separator
  
  Shall construct a new Separator of the given type

<comment>Param:</comment>
  <info>int</info>  <strong>$type</strong>  Separator::Horizonal or Separator::Vertical


id: UI\Controls\Slider
type: class
doc:
<comment>Description:</comment>
  A Slider is a control which represents a range, and a current value in the range. The sliding
  element of the control (sometimes called the "thumb") reflects the value, and can be adjusted
  within the range.


id: UI\Controls\Slider::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Slider
  
  Construct a new Slider with the given range

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  The minimum allowed value
  <info>int</info>  <strong>$max</strong>  The maximum allowed value


id: UI\Controls\Slider::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Get the value from this Slider

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


id: UI\Controls\Slider::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value of this Slider changes


id: UI\Controls\Slider::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Shall set the value for this Slider

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The new value


id: UI\Controls\Spin
type: class
doc:
<comment>Description:</comment>
  A Spin box is a text box with an up-down control which changes the integer value in the box,
  within a defined range


id: UI\Controls\Spin::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Spin
  
  Constructs a new Spin with the given range

<comment>Param:</comment>
  <info>int</info>  <strong>$min</strong>  The minimum value allowed
  <info>int</info>  <strong>$max</strong>  The maximum value allowed


id: UI\Controls\Spin::getValue
type: function
doc:
<comment>Description:</comment>
  Get Value
  
  Get the value in this Spin

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


id: UI\Controls\Spin::onChange
type: function
doc:
<comment>Description:</comment>
  Change Handler
  
  Shall be executed when the value in this Spin changes


id: UI\Controls\Spin::setValue
type: function
doc:
<comment>Description:</comment>
  Set Value
  
  Set the value in this Spin

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  The new value


id: UI\Controls\Tab
type: class
doc:
<comment>Description:</comment>
  A Tab can contain many pages of Controls, each with a title, each selectable by the user.


id: UI\Controls\Tab::append
type: function
doc:
<comment>Description:</comment>
  Append Page
  
  Append a new page to this Tab

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>     The name for the new page
  <info>UI\Control</info>  <strong>$control</strong>  The control for the new page

<comment>Return:</comment>
  <info>int</info>  Shall return the index of the appended control, may be 0


id: UI\Controls\Tab::delete
type: function
doc:
<comment>Description:</comment>
  Delete Page
  
  Shall remove the selected page from this Tab

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the page to remove

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Controls\Tab::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if the given page has a margin.

<comment>Param:</comment>
  <info>int</info>  <strong>$page</strong>  The index of the page

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


id: UI\Controls\Tab::insertAt
type: function
doc:
<comment>Description:</comment>
  Insert Page
  
  Shall insert a new page into this Tab

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>     The name for the new page
  <info>int</info>         <strong>$page</strong>     The index to perform the insertion before
  <info>UI\Control</info>  <strong>$control</strong>  The control for the new page


id: UI\Controls\Tab::pages
type: function
doc:
<comment>Description:</comment>
  Page Count
  
  Shall return the number of pages in this Tab

<comment>Return:</comment>
  <info>int</info>  The number of pages in this Tab


id: UI\Controls\Tab::setMargin
type: function
doc:
<comment>Description:</comment>
  Set Margin
  
  Shall enable or disable margins on the selected page

<comment>Param:</comment>
  <info>int</info>   <strong>$page</strong>    The page to select
  <info>bool</info>  <strong>$margin</strong>  Margin switch


id: UI\Draw\Brush::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Brush
  
  Shall construct a solid brush using the given color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Can be a UI\Draw\Color or RRGGBBAA


id: UI\Draw\Brush::getColor
type: function
doc:
<comment>Description:</comment>
  Get Color
  
  Shall return a UI\Draw\Color for this brush

<comment>Return:</comment>
  <info>UI\Draw\Color</info>  The current color of the brush


id: UI\Draw\Brush::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the color of this brush to the color provided

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  Can be a UI\Draw\Color or RRGGBBAA

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


id: UI\Draw\Brush\Gradient::addStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation
  
  Shall at a stop of the given color at the given position

<comment>Param:</comment>
  <info>float</info>          <strong>$position</strong>  The position for the new stop
  <info>UI\Draw\Color</info>  <strong>$color</strong>     The color for the new stop, may be UI\Draw\Color or RRGGBBAA

<comment>Return:</comment>
  <info>int</info>  Total number of stops


id: UI\Draw\Brush\Gradient::delStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  

<comment>Return:</comment>
  <info>int</info>  Total number of stops


id: UI\Draw\Brush\Gradient::setStop
type: function
doc:
<comment>Description:</comment>
  Stop Manipulation

<comment>Param:</comment>
  <info>int</info>            <strong>$index</strong>     The index of the stop to set
  <info>float</info>          <strong>$position</strong>  The position for the stop
  <info>UI\Draw\Color</info>  <strong>$color</strong>     The color for the stop, may be UI\Draw\Color or RRGGBBAA

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Draw\Brush\LinearGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a Linear Gradient
  
  Shall construct a new linear gradient

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start</strong>  
  <info>UI\Point</info>  <strong>$end</strong>    


id: UI\Draw\Brush\RadialGradient::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Radial Gradient
  
  Shall construct a new radial gradient

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$start</strong>   
  <info>UI\Point</info>  <strong>$outer</strong>   
  <info>float</info>     <strong>$radius</strong>  


id: UI\Draw\Color
type: class
doc:
<comment>Description:</comment>
  Represents RGBA colours, individual channels are accessible via public properties.


id: UI\Draw\Color::__construct
type: function
doc:
<comment>Description:</comment>
  Construct new Color
  
  Shall construct a new color

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  May be UI\Draw\Color or RRGGBBAA


id: UI\Draw\Color::getChannel
type: function
doc:
<comment>Description:</comment>
  Color Manipulation
  
  Shall retrieve the value for a channel

<comment>Param:</comment>
  <info>int</info>  <strong>$channel</strong>  Constant channel identity

<comment>Return:</comment>
  <info>float</info>  The current value of the requested channel


id: UI\Draw\Color::setChannel
type: function
doc:
<comment>Description:</comment>
  Color Manipulation
  
  Shall set the selected channel to the given value

<comment>Param:</comment>
  <info>int</info>    <strong>$channel</strong>  Constant channel identity
  <info>float</info>  <strong>$value</strong>    The new value for the selected channel

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


id: UI\Draw\Matrix::isInvertible
type: function
doc:
<comment>Description:</comment>
  Invertible Detection
  
  Shall detect if this Matrix may be inverted

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


id: UI\Draw\Matrix::multiply
type: function
doc:
<comment>Description:</comment>
  Multiply Matrix
  
  Shall multiply this matrix with the given matrix

<comment>Return:</comment>
  <info>UI\Draw\Matrix</info>  The new Matrix


id: UI\Draw\Matrix::rotate
type: function
doc:
<comment>Description:</comment>
  Rotate Matrix
  
  Shall rotate this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>   
  <info>float</info>     <strong>$amount</strong>  


id: UI\Draw\Matrix::scale
type: function
doc:
<comment>Description:</comment>
  Scale Matrix
  
  Shall scale this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$center</strong>  
  <info>UI\Point</info>  <strong>$point</strong>   


id: UI\Draw\Matrix::skew
type: function
doc:
<comment>Description:</comment>
  Skew Matrix
  
  Shall skew this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>   
  <info>UI\Point</info>  <strong>$amount</strong>  


id: UI\Draw\Matrix::translate
type: function
doc:
<comment>Description:</comment>
  Translate Matrix
  
  Shall translate this Matrix

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  


id: UI\Draw\Path
type: class
doc:
<comment>Description:</comment>
  A Draw Path guides a Draw Pen, telling the Pen where to draw on an Area.


id: UI\Draw\Path::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Path
  
  Shall construct a new path in the given mode

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Path::Winding or Path::Alternate


id: UI\Draw\Path::addRectangle
type: function
doc:
<comment>Description:</comment>
  Draw a Rectangle
  
  Shall map the path of a rectangle of the given size, at the given point

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to begin the shape
  <info>UI\Size</info>   <strong>$size</strong>   The size of the rectangle


id: UI\Draw\Path::arcTo
type: function
doc:
<comment>Description:</comment>
  Draw an Arc
  
  Shall map the path for an arc

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     The point to begin mapping
  <info>float</info>     <strong>$radius</strong>    The radius of the arc
  <info>float</info>     <strong>$angle</strong>     The angle of the arc
  <info>float</info>     <strong>$sweep</strong>     The sweep of the arc
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::bezierTo
type: function
doc:
<comment>Description:</comment>
  Draw Bezier Curve
  
  Shall draw a bezier curve

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     The point at which to begin mapping
  <info>float</info>     <strong>$radius</strong>    The radius of the curve
  <info>float</info>     <strong>$angle</strong>     The angle of the curve
  <info>float</info>     <strong>$sweep</strong>     The sweep of the curve
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::lineTo
type: function
doc:
<comment>Description:</comment>
  Draw a Line
  
  Shall map the path for a line

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     The point to begin mapping
  <info>float</info>     <strong>$radius</strong>    
  <info>float</info>     <strong>$angle</strong>     
  <info>float</info>     <strong>$sweep</strong>     
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Path::newFigure
type: function
doc:
<comment>Description:</comment>
  Draw Figure
  
  Shall map a new figure at the given point

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>  The point to begin mapping


id: UI\Draw\Path::newFigureWithArc
type: function
doc:
<comment>Description:</comment>
  Draw Figure with Arc

<comment>Param:</comment>
  <info>UI\Point</info>  <strong>$point</strong>     
  <info>float</info>     <strong>$radius</strong>    
  <info>float</info>     <strong>$angle</strong>     
  <info>float</info>     <strong>$sweep</strong>     
  <info>float</info>     <strong>$negative</strong>  


id: UI\Draw\Pen
type: class
doc:
<comment>Description:</comment>
  The Pen is passed to the Area Draw event handler, it is used for clipping, filling, stroking, and
  writing to Draw Paths.


id: UI\Draw\Pen::clip
type: function
doc:
<comment>Description:</comment>
  Clip a Path
  
  Shall clip the given Path

<comment>Param:</comment>
  <info>UI\Draw\Path</info>  <strong>$path</strong>  The path to clip


id: UI\Draw\Pen::fill
type: function
doc:
<comment>Description:</comment>
  Fill a Path
  
  Shall fill the given path

<comment>Param:</comment>
  <info>UI\Draw\Path</info>   <strong>$path</strong>  The path to fill
  <info>UI\Draw\Brush</info>  <strong>$with</strong>  The color or brush to fill with


id: UI\Draw\Pen::stroke
type: function
doc:
<comment>Description:</comment>
  Stroke a Path
  
  Shall stroke the given path

<comment>Param:</comment>
  <info>UI\Draw\Path</info>    <strong>$path</strong>    The path to stroke
  <info>UI\Draw\Brush</info>   <strong>$with</strong>    The color or brush to stroke with
  <info>UI\Draw\Stroke</info>  <strong>$stroke</strong>  The configuration of the stroke


id: UI\Draw\Pen::transform
type: function
doc:
<comment>Description:</comment>
  Matrix Transform
  
  Shall perform matrix transformation

<comment>Param:</comment>
  <info>UI\Draw\Matrix</info>  <strong>$matrix</strong>  The matrix to use


id: UI\Draw\Pen::write
type: function
doc:
<comment>Description:</comment>
  Draw Text at Point
  
  Shall draw the given text layout at the given point

<comment>Param:</comment>
  <info>UI\Point</info>             <strong>$point</strong>   The point to perform the drawing
  <info>UI\Draw\Text\Layout</info>  <strong>$layout</strong>  The layout of the text to draw


id: UI\Draw\Stroke::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Stroke
  
  Shall construct a new Stroke

<comment>Param:</comment>
  <info>int</info>    <strong>$cap</strong>         UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square
  <info>int</info>    <strong>$join</strong>        UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or
                      UI\Draw\Line\Join::Bevel
  <info>float</info>  <strong>$thickness</strong>   The thickness of the stroke
  <info>float</info>  <strong>$miterLimit</strong>  Miter limit (default is sensible for all supported platforms)


id: UI\Draw\Stroke::getCap
type: function
doc:
<comment>Description:</comment>
  Get Line Cap
  
  Shall retrieve the line cap setting of this Stroke

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::getJoin
type: function
doc:
<comment>Description:</comment>
  Get Line Join
  
  Shall retrieve the line join setting of this Stroke

<comment>Return:</comment>
  <info>int</info>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::getMiterLimit
type: function
doc:
<comment>Description:</comment>
  Get Miter Limit
  
  Shall retrieve the miter limit of this Stroke

<comment>Return:</comment>
  <info>float</info>  The current miter limit


id: UI\Draw\Stroke::getThickness
type: function
doc:
<comment>Description:</comment>
  Get Thickness
  
  Shall retrieve the thickness of this Stroke

<comment>Return:</comment>
  <info>float</info>  The current thickness


id: UI\Draw\Stroke::setCap
type: function
doc:
<comment>Description:</comment>
  Set Line Cap
  
  Shall set the line cap setting for this Stroke

<comment>Param:</comment>
  <info>int</info>  <strong>$cap</strong>  UI\Draw\Line\Cap::Flat, UI\Draw\Line\Cap::Round, or UI\Draw\Line\Cap::Square


id: UI\Draw\Stroke::setJoin
type: function
doc:
<comment>Description:</comment>
  Set Line Join
  
  Shall set the line join setting for this Stroke

<comment>Param:</comment>
  <info>int</info>  <strong>$join</strong>  UI\Draw\Line\Join::Miter, UI\Draw\Line\Join::Round, or UI\Draw\Line\Join::Bevel


id: UI\Draw\Stroke::setMiterLimit
type: function
doc:
<comment>Description:</comment>
  Set Miter Limit
  
  Set the miter limit for this Stroke

<comment>Param:</comment>
  <info>float</info>  <strong>$limit</strong>  The new limit


id: UI\Draw\Stroke::setThickness
type: function
doc:
<comment>Description:</comment>
  Set Thickness
  
  Shall set the thickness for this Stroke

<comment>Param:</comment>
  <info>float</info>  <strong>$thickness</strong>  The new thickness


id: UI\Draw\Text\Font::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Font
  
  Shall construct a new Font using the given descriptor

<comment>Param:</comment>
  <info>UI\Draw\Text\Font\Descriptor</info>  <strong>$descriptor</strong>  The descriptor for the Font


id: UI\Draw\Text\Font\Descriptor::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Font Descriptor
  
  Shall construct a new Font Descriptor

<comment>Param:</comment>
  <info>string</info>  <strong>$family</strong>   The name of a valid family of fonts
  <info>float</info>   <strong>$size</strong>     The preferred size
  <info>int</info>     <strong>$weight</strong>   UI\Draw\Text\Font\Weight constant
  <info>int</info>     <strong>$italic</strong>   UI\Draw\Text\Font\Italic constant
  <info>int</info>     <strong>$stretch</strong>  UI\Draw\Text\Font\Stretch constant


id: UI\Draw\Text\Font\Descriptor::getFamily
type: function
doc:
<comment>Description:</comment>
  Get Font Family
  
  Shall return the requested font family

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


id: UI\Draw\Text\Font\Descriptor::getItalic
type: function
doc:
<comment>Description:</comment>
  Style Detection
  
  Shall return constant setting

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


id: UI\Draw\Text\Font\Descriptor::getSize
type: function
doc:
<comment>Description:</comment>
  Size Detection
  
  Shall return the requested size

<comment>Return:</comment>
  <info>float</info>  


id: UI\Draw\Text\Font\Descriptor::getStretch
type: function
doc:
<comment>Description:</comment>
  Style Detection
  
  Shall return requested stretch

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


id: UI\Draw\Text\Font\Descriptor::getWeight
type: function
doc:
<comment>Description:</comment>
  Weight Detection
  
  Shall return requested weight

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


id: UI\Draw\Text\Font\fontFamilies
type: function
doc:
<comment>Description:</comment>
  Récupére les familles de polices
  
  Retourne un tableau des familles de polices valide pour le système actuel

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau des familles de polices valide pour le système actuel.


id: UI\Draw\Text\Layout
type: class
doc:
<comment>Description:</comment>
  A Text Layout represents the layout of text which will be drawn by the Pen


id: UI\Draw\Text\Layout::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Text Layout
  
  Shall construct a new Text Layout

<comment>Param:</comment>
  <info>string</info>             <strong>$text</strong>   The text for the layout
  <info>UI\Draw\Text\Font</info>  <strong>$font</strong>   The font to use for writing
  <info>float</info>              <strong>$width</strong>  The width of the layout


id: UI\Draw\Text\Layout::setColor
type: function
doc:
<comment>Description:</comment>
  Set Color
  
  Shall set the Color for all of, or a range of the text in the Layout

<comment>Param:</comment>
  <info>UI\Draw\Color</info>  <strong>$color</strong>  The color to use
  <info>int</info>            <strong>$start</strong>  The starting character
  <info>int</info>            <strong>$end</strong>    The ending character, by default the end of the string


id: UI\Draw\Text\Layout::setWidth
type: function
doc:
<comment>Description:</comment>
  Set Width
  
  Shall set the width of this Text Layout

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>  The new width


id: UI\Executor
type: class
doc:
<comment>Description:</comment>
  This facility schedules repetitive execution of a callback, useful for animations and other such
  activities.


id: UI\Executor::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Executor
  
  Shall construct an executor with the given interval, will not start executing until main loop is
  entered

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>       Seconds between executions
  <info>int</info>  <strong>$microseconds</strong>  Microseconds between executions


id: UI\Executor::kill
type: function
doc:
<comment>Description:</comment>
  Stop Executor
  
  Shall stop an executor, the executor cannot be restarted

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


id: UI\Executor::onExecute
type: function
doc:
<comment>Description:</comment>
  Execution Callback
  
  Shall be repetitively queued for execution in the main thread

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


id: UI\Executor::setInterval
type: function
doc:
<comment>Description:</comment>
  Interval Manipulation
  
  Shall set the new interval. An interval of 0 will pause the executor until a new interval has been
  set

<comment>Param:</comment>
  <info>int</info>  <strong>$seconds</strong>       
  <info>int</info>  <strong>$microseconds</strong>  

<comment>Return:</comment>
  <info>bool</info>  Indication of success


id: UI\Menu
type: class
doc:
<comment>Description:</comment>
  Menus must be constructed before the first Window, and can be shown on any Window


id: UI\Menu::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Menu
  
  Shall construct a new Menu

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the menu


id: UI\Menu::append
type: function
doc:
<comment>Description:</comment>
  Append Menu Item
  
  Shall append a new Menu Item

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the new item
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed object of the given type


id: UI\Menu::appendAbout
type: function
doc:
<comment>Description:</comment>
  Append About Menu Item
  
  Shall append an About menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed About menu item of the given type


id: UI\Menu::appendCheck
type: function
doc:
<comment>Description:</comment>
  Append Checkable Menu Item
  
  Shall append a checkable menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name (text) for the new item
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed checkable menu item of the given type


id: UI\Menu::appendPreferences
type: function
doc:
<comment>Description:</comment>
  Append Preferences Menu Item
  
  Shall append a Preferences menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed Preferences menu item of the given type


id: UI\Menu::appendQuit
type: function
doc:
<comment>Description:</comment>
  Append Quit Menu Item
  
  Shall append a Quit menu item

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  The type for the new item

<comment>Return:</comment>
  <info>UI\MenuItem</info>  A constructed Quit menu item of the given type


id: UI\MenuItem::isChecked
type: function
doc:
<comment>Description:</comment>
  Detect Checked
  
  Shall detect if this Menu Item is checked

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


id: UI\MenuItem::onClick
type: function
doc:
<comment>Description:</comment>
  On Click Callback
  
  Shall be executed when this Menu Item is clicked


id: UI\MenuItem::setChecked
type: function
doc:
<comment>Description:</comment>
  Set Checked
  
  Shall set the checked status of this Menu Item

<comment>Param:</comment>
  <info>bool</info>  <strong>$checked</strong>  The new status


id: UI\Point
type: class
doc:
<comment>Description:</comment>
  Points are used throughout UI to represent co-ordinates on a screen, control, or area.


id: UI\Point::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Point
  
  Construct a new Point using new co-ordinates

<comment>Param:</comment>
  <info>float</info>  <strong>$x</strong>  The new X co-ordinate
  <info>float</info>  <strong>$y</strong>  The new Y co-ordinate


id: UI\Point::at
type: function
doc:
<comment>Description:</comment>
  Size Coercion
  
  Shall return a UI\Point object where x and y are equal to those supplied, either in float or
  UI\Size form

<comment>Param:</comment>
  <info>float</info>    <strong>$point</strong>  The value for x and y
  <info>UI\Size</info>  <strong>$size</strong>   The Size to convert

<comment>Return:</comment>
  <info>UI\Point</info>  The resulting Point


id: UI\Point::getX
type: function
doc:
<comment>Description:</comment>
  Retrieves X
  
  Retrieves the X co-ordinate

<comment>Return:</comment>
  <info>float</info>  The current X co-ordinate


id: UI\Point::getY
type: function
doc:
<comment>Description:</comment>
  Retrieves Y
  
  Retrieves the Y co-ordinate

<comment>Return:</comment>
  <info>float</info>  The current Y co-ordinate


id: UI\Point::setX
type: function
doc:
<comment>Description:</comment>
  Set X
  
  Set the X co-ordinate

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  The new X co-ordinate


id: UI\Point::setY
type: function
doc:
<comment>Description:</comment>
  Set Y
  
  Set the Y co-ordinate

<comment>Param:</comment>
  <info>float</info>  <strong>$point</strong>  The new Y co-ordinate


id: UI\Size
type: class
doc:
<comment>Description:</comment>
  Sizes are used throughout UI to represent the size of a screen, control, or area.


id: UI\Size::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Size
  
  Construct a new Size using new width and height

<comment>Param:</comment>
  <info>float</info>  <strong>$width</strong>   The new width
  <info>float</info>  <strong>$height</strong>  The new height


id: UI\Size::getHeight
type: function
doc:
<comment>Description:</comment>
  Retrieves Height
  
  Retrieves the Height

<comment>Return:</comment>
  <info>float</info>  The current Height


id: UI\Size::getWidth
type: function
doc:
<comment>Description:</comment>
  Retrives Width
  
  Retrieves the Width

<comment>Return:</comment>
  <info>float</info>  The current Width


id: UI\Size::of
type: function
doc:
<comment>Description:</comment>
  Point Coercion
  
  Shall return a UI\Size object where width and height are equal to those supplied, either in float
  or UI\Point form

<comment>Param:</comment>
  <info>float</info>     <strong>$size</strong>   The value for width and height
  <info>UI\Point</info>  <strong>$point</strong>  The Point to convert

<comment>Return:</comment>
  <info>UI\Size</info>  The resulting Size


id: UI\Size::setHeight
type: function
doc:
<comment>Description:</comment>
  Set Height
  
  Set new Height

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  The new Height


id: UI\Size::setWidth
type: function
doc:
<comment>Description:</comment>
  Set Width
  
  Set new Width

<comment>Param:</comment>
  <info>float</info>  <strong>$size</strong>  The new Width


id: UI\Window::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a new Window
  
  Shall construct a new Window

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The title of the Window
  <info>Size</info>    <strong>$size</strong>   The size of the Window
  <info>bool</info>    <strong>$menu</strong>   Menu switch


id: UI\Window::add
type: function
doc:
<comment>Description:</comment>
  Add a Control
  
  Shall add a Control to this Window

<comment>Param:</comment>
  <info>UI\Control</info>  <strong>$control</strong>  The Control to add


id: UI\Window::error
type: function
doc:
<comment>Description:</comment>
  Affiche un message d'erreur
  
  Devrait montrer un message d'erreur

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  Titre du message d'erreur
  <info>string</info>  <strong>$msg</strong>    Message d'erreur


id: UI\Window::getSize
type: function
doc:
<comment>Description:</comment>
  Get Window Size
  
  Shall return the size of this Window

<comment>Return:</comment>
  <info>UI\Size</info>  


id: UI\Window::getTitle
type: function
doc:
<comment>Description:</comment>
  Get Title
  
  Shall retrieve the title of this Window

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


id: UI\Window::hasBorders
type: function
doc:
<comment>Description:</comment>
  Border Detection
  
  Shall detect if borders are used on this Window

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


id: UI\Window::hasMargin
type: function
doc:
<comment>Description:</comment>
  Margin Detection
  
  Shall detect if margins are used on this Window

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


id: UI\Window::isFullScreen
type: function
doc:
<comment>Description:</comment>
  Full Screen Detection
  
  Shall detect if this Window us using the whole screen

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


id: UI\Window::msg
type: function
doc:
<comment>Description:</comment>
  Show Message Box
  
  Shall show a message box

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The title of the message box
  <info>string</info>  <strong>$msg</strong>    The message


id: UI\Window::onClosing
type: function
doc:
<comment>Description:</comment>
  Closing Callback
  
  Should gracefully destroy this Window

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


id: UI\Window::open
type: function
doc:
<comment>Description:</comment>
  Open Dialog
  
  Shall show an open file dialog

<comment>Return:</comment>
  <info>string</info>  Returns the name of the file selected for opening


id: UI\Window::save
type: function
doc:
<comment>Description:</comment>
  Save Dialog
  
  Shall show a save dialog

<comment>Return:</comment>
  <info>string</info>  Returns the file name selecting for saving


id: UI\Window::setBorders
type: function
doc:
<comment>Description:</comment>
  Border Use
  
  Shall enable or disable the use of borders on this Window

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


id: UI\Window::setFullScreen
type: function
doc:
<comment>Description:</comment>
  Full Screen Use
  
  Shall enable or disable the use of the full screen for this Window
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: UI\Window::setMargin
type: function
doc:
<comment>Description:</comment>
  Margin Use
  
  Shall enable or disable the use of margins for this Window

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


id: UI\Window::setSize
type: function
doc:
<comment>Description:</comment>
  Set Size
  
  Shall set the size of this Window

<comment>Param:</comment>
  <info>UI\Size</info>  <strong>$size</strong>  


id: UI\Window::setTitle
type: function
doc:
<comment>Description:</comment>
  Window Title
  
  Shall set the title for this Window

<comment>Param:</comment>
  <info>string</info>  <strong>$title</strong>  The new title


id: UI\quit
type: function
doc:
<comment>Description:</comment>
  Quitte la boucle UI
  
  Doit faire arrêter la boucle principale

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


id: UI\run
type: function
doc:
<comment>Description:</comment>
  Entre dans la boucle UI
  
  Doit pousser PHP à entrer dans la boucle principale. Par défaut, le contrôle ne sera pas retourné
  à la fonction appelante.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Mettre UI\Loop pour retourner le contrôle et UI\Wait pour retourner le contrôle après
               l'attente.

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


id: UnitEnum
type: class
doc:
<comment>Description:</comment>
  L'interface <class>UnitEnum</class> est automatiquement appliquée à toutes les énumérations par le moteur. Elle
  ne peut pas être implémentée par des classes définies par l'utilisateur. Les énumérations ne
  peuvent pas surcharger ses méthodes, car les implémentations par défaut sont fournies par le
  moteur.  Elle n'est disponible que pour les vérifications de type.


id: UnitEnum::cases
type: function
doc:
<comment>Description:</comment>
  Génère une liste de cas sur une énumération
  
  Cette méthode retourne un tableau de tous les cas d'une énumération, dans l'ordre de leur
  déclaration.

<comment>Return:</comment>
  <info>array</info>  Un tableau de tous les cas définis de cette énumération, dans l'ordre de la déclaration.


id: V8Js
type: class
doc:
<comment>Description:</comment>
  C'est la classe de base de l'extension V8Js. Chaque instance créée depuis cette classe a son
  propre contexte dans lequel tout le Javascript est compilé et exécuté.
  
  Voir <strong>V8Js::__construct()</strong> pour plus d'informations.


id: V8Js::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet V8Js
  
  Construit un nouvel objet <class>V8Js</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$object_name</strong>                 Le nom de l'objet passé à Javascript.
  <info>array</info>   <strong>$variables</strong>                   Une liste des variables PHP qui seront disponibles en
                                       Javascript. Doit être un tableau associatif au format
                                       <return>array("nom-pour-js" =&gt; "nom-de-la-variable-php")</return>. Par
                                       défaut, un tableau vide.
  <info>array</info>   <strong>$extensions</strong>                  Liste des extensions enregistrées en utilisant la méthode
                                       <strong>V8Js::registerExtension()</strong>, qui devraient être disponibles
                                       dans le contexte Javascript de l'objet <class>V8Js</class> créé.  Les
                                       extensions enregistrées de telle façon qu'elles soient
                                       automatiquement actives n'ont pas besoin d'être listées dans
                                       ce tableau. De plus, si une extension a des dépendances,
                                       celles-ci peuvent être omises. Par défaut, un tableau vide.
                                       
                                       Les extensions enregistrées de telle façon qu'elles soient
                                       automatiquement actives n'ont pas besoin d'être listées dans
                                       ce tableau. De plus, si une extension a des dépendances,
                                       celles-ci peuvent être omises. Par défaut, un tableau vide.
  <info>bool</info>    <strong>$report_uncaught_exceptions</strong>  Contrôle si les exceptions Javascript non attrapées sont
                                       reportées immédiatement ou non. Par défaut, vaut <info>true</info>. Si
                                       défini à <info>false</info>, l'exception non attrapée peut être accédée en
                                       utilisant la méthode <strong>V8Js::getPendingException()</strong>.


id: V8Js::executeString
type: function
doc:
<comment>Description:</comment>
  Exécute une chaîne comme du code Javascript
  
  Compile et exécute la chaîne passée par le paramètre <strong>$script</strong> comme du code Javascript.

<comment>Param:</comment>
  <info>string</info>  <strong>$script</strong>      La chaîne à exécuter.
  <info>string</info>  <strong>$identifier</strong>  Identifiant pour le code exécuté. Utilisé lors du débogage.
  <info>int</info>     <strong>$flags</strong>       Drapeaux d'exécution. Cette valeur doit être une des constantes <return>V8Js::FLAG_*</return>,
                       et vaut par défaut <info>V8Js::FLAG_NONE</info>. <info>V8Js::FLAG_NONE</info> : aucun drapeau
                       <info>V8Js::FLAG_FORCE_ARRAY</info> : force tous les objets Javascript passés à PHP à être
                       des tableaux associatifs
                       
                       <info>V8Js::FLAG_NONE</info> : aucun drapeau
                       
                       <info>V8Js::FLAG_FORCE_ARRAY</info> : force tous les objets Javascript passés à PHP à être
                       des tableaux associatifs

<comment>Return:</comment>
  <info>mixed</info>  Retourne la dernière variable instanciée dans le code Javascript, convertie en variable PHP
         de type correspondant.


id: V8Js::getExtensions
type: function
doc:
<comment>Description:</comment>
  Retourne un tableau contenant les extensions enregistrées
  
  Cette fonction retourne un tableau contenant les extensions Javascript enregistrées en utilisant
  la méthode <strong>V8Js::registerExtension()</strong>.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant les extensions enregistrées ou un tableau vide s'il n'y en a
         aucune.


id: V8Js::getPendingException
type: function
doc:
<comment>Description:</comment>
  Retourne l'exception Javascript non attrapée restante
  
  Retourne toute exception Javascript non attrapée restante depuis un ou plusieurs appel(s) à la
  méthode <strong>V8Js::executeString()</strong>, sous forme de <class>V8JsException</class>.

<comment>Return:</comment>
  <info>V8JsException</info>  Un objet <class>V8JsException</class> ou <info>null</info>.


id: V8Js::registerExtension
type: function
doc:
<comment>Description:</comment>
  Enregistre des extensions Javascript pour V8Js
  
  Enregistre le code Javascript passé par le paramètre <strong>$script</strong> comme extension à utiliser dans les
  contextes <class>V8Js</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$extension_name</strong>  Nom de l'extension à enregistrer.
  <info>string</info>  <strong>$script</strong>          Le code Javascript à enregistrer.
  <info>array</info>   <strong>$dependencies</strong>    Un tableau de noms d'extensions dont l'extension en cours
                           d'enregistrement dépend. Chacune d'elles sera activée automatiquement
                           lors du chargement de cette extension.  Toutes les extensions, y compris
                           les dépendances, doivent être enregistrées avant la création de tout
                           objet <class>V8Js</class> les utilisant.
                           
                           Toutes les extensions, y compris les dépendances, doivent être
                           enregistrées avant la création de tout objet <class>V8Js</class> les utilisant.
  <info>bool</info>    <strong>$auto_enable</strong>     Si défini à <info>true</info>, l'extension sera activée automatiquement dans tous les
                           contextes <class>V8Js</class>.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si l'extension a été enregistrée avec succès, <info>false</info> sinon.


id: V8JsException::getJsFileName
type: function
doc:
<comment>Description:</comment>
  Le but de getJsFileName
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: V8JsException::getJsLineNumber
type: function
doc:
<comment>Description:</comment>
  Le but de getJsLineNumber
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: V8JsException::getJsSourceLine
type: function
doc:
<comment>Description:</comment>
  Le but de getJsSourceLine
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: V8JsException::getJsTrace
type: function
doc:
<comment>Description:</comment>
  Le but de getJsTrace
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: VARCMP_GT
type: constant
doc:
<comment>Description:</comment>
  Le <return>bstr</return> de gauche est plus grand que le <return>bstr</return> de droite.


id: VARCMP_LT
type: constant
doc:
<comment>Description:</comment>
  Le <return>bstr</return> de gauche est plus petit que le <return>bstr</return> de droite.


id: VAR_REPRESENTATION_SINGLE_LINE
type: constant
doc:
<comment>Description:</comment>
  <strong>var_representation()</strong> flag indicating that newlines  should not be used for whitespace in variable
  representations.


id: VAR_REPRESENTATION_UNESCAPED
type: constant
doc:
<comment>Description:</comment>
  <strong>var_representation()</strong> flag indicating that strings should be encoded as single quoted strings with
  unescaped control characters.


id: VT_ARRAY
type: constant
doc:
<comment>Description:</comment>
  Si l'indicateur de type est combiné avec <info>VT_ARRAY</info> via un opérateur OR, la valeur sera un pointeur
  vers un <return>SAFEARRAY</return>. <info>VT_ARRAY</info> peut utiliser l'opérateur OR avec les types de données suivantes :
  <info>VT_I1</info>, <info>VT_UI1</info>, <info>VT_I2</info>, <info>VT_UI2</info>, <info>VT_I4</info>, <info>VT_UI4</info>, <info>VT_INT</info>, <info>VT_UINT</info>, <info>VT_R4</info>, <info>VT_R8</info>, <info>VT_BOOL</info>, <info>VT_DECIMAL</info>,
  <info>VT_ERROR</info>, <info>VT_CY</info>, <info>VT_DATE</info>, <info>VT_BSTR</info>, <info>VT_DISPATCH</info>, <info>VT_UNKNOWN</info> et <info>VT_VARIANT</info>.


id: VT_BYREF
type: constant
doc:
<comment>Description:</comment>
  Si l'indicateur de type est combiné avec <info>VT_BYREF</info> via un opérateur OR, la valeur sera une
  référence. Les types de référence sont interprétés comme une référence vers les données, similaire
  au type de référence en C++.


id: VT_DATE
type: constant
doc:
<comment>Description:</comment>
  Nombre à virgule flottante de 64 bits, représentant le nombre de jours (et non de secondes) depuis
  le 01 Décembre 1899. Par exemple, <return>January 1, 1900</return>, vaut 2.0, <return>January 2, 1900</return>, vaut 3.0, et ainsi
  de suite). Stocké sous la même représentation que la constante <info>VT_R8</info>.


id: VT_EMPTY
type: constant
doc:
<comment>Description:</comment>
  Une propriété, dont le type de l'indicateur est <info>VT_EMPTY</info>, n'a aucune donné accosiée ; aussi, la
  taille de la valeur est de zéro.


id: VT_I8
type: constant
doc:
<comment>Description:</comment>
  Entier signé sur 8 octets.
  
  Disponible à partir de PHP 7.0.0 (x64 uniquement).


id: VT_INT
type: constant
doc:
<comment>Description:</comment>
  Valeur entière signée sur 4 octets (équivalent à <info>VT_I4</info>).


id: VT_UI8
type: constant
doc:
<comment>Description:</comment>
  Entier non signé sur 8 octets.
  
  Disponible à partir de PHP 7.0.0 (x64 uniquement).


id: VT_UINT
type: constant
doc:
<comment>Description:</comment>
  Entier non signé sur 4 octets (équivalent à <info>VT_UI4</info>).


id: VT_VARIANT
type: constant
doc:
<comment>Description:</comment>
  Un indicateur de type suivi par la valeur correspondante. <info>VT_VARIANT</info> peut être utilisé uniquement
  avec <info>VT_BYREF</info>.


id: VarnishAdmin::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur VarnishAdmin

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Arguments de configuration. Les clés possibles sont :
                


id: VarnishAdmin::auth
type: function
doc:
<comment>Description:</comment>
  S'Authentifie sur une instance Varnish

<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: VarnishAdmin::ban
type: function
doc:
<comment>Description:</comment>
  Ban des URLs en utilisant une expression VCL

<comment>Param:</comment>
  <info>string</info>  <strong>$vcl_regex</strong>  Expression VLC Varnish. Elle est basée sur la commande ban de Varnish.

<comment>Return:</comment>
  <info>int</info>  Retourne le statut de la commande Varnish.


id: VarnishAdmin::banUrl
type: function
doc:
<comment>Description:</comment>
  Ban une URL en utilisant une expression VCL

<comment>Param:</comment>
  <info>string</info>  <strong>$vcl_regex</strong>  Expression rationnelle dans une syntaxe compatible PCRE. Elle est basée sur la
                      commande ban.url de Varnish.

<comment>Return:</comment>
  <info>int</info>  Retourne le statut de la commande Varnish.


id: VarnishAdmin::clearPanic
type: function
doc:
<comment>Description:</comment>
  Efface les messages de panique de l'instance Varnish

<comment>Return:</comment>
  <info>int</info>  Retourne le statut de la commande Varnish.


id: VarnishAdmin::connect
type: function
doc:
<comment>Description:</comment>
  Connexion à l'interface d'administration de l'instance Varnish

<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: VarnishAdmin::disconnect
type: function
doc:
<comment>Description:</comment>
  Déconnexion de l'interface d'administration d'une instance varnish

<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: VarnishAdmin::getPanic
type: function
doc:
<comment>Description:</comment>
  Récupère le dernier message de panique de l'instance Varnish

<comment>Return:</comment>
  <info>string</info>  Retourne le dernier message de panique de l'instance Varnish courante.


id: VarnishAdmin::getParams
type: function
doc:
<comment>Description:</comment>
  Récupère les paramètres de configuration de l'instance Varnish courante

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant les paramètres de configuration de l'instance Varnish.


id: VarnishAdmin::isRunning
type: function
doc:
<comment>Description:</comment>
  Vérifie si un processus esclave Varnish est actuellement en cours d'exécution

<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: VarnishAdmin::setCompat
type: function
doc:
<comment>Description:</comment>
  Définit le paramètre de configuration compat

<comment>Param:</comment>
  <info>int</info>  <strong>$compat</strong>  Option de compatibilité Varnish.

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


id: VarnishAdmin::setHost
type: function
doc:
<comment>Description:</comment>
  Définit le paramètre de configuration host

<comment>Param:</comment>
  <info>string</info>  <strong>$host</strong>  Paramètre de configuration host.

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


id: VarnishAdmin::setIdent
type: function
doc:
<comment>Description:</comment>
  Définit le paramètre de configuration ident

<comment>Param:</comment>
  <info>string</info>  <strong>$ident</strong>  Paramètre de configuration ident.

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


id: VarnishAdmin::setParam
type: function
doc:
<comment>Description:</comment>
  Définit un paramètre de configuration sur l'instance courante Varnish

<comment>Param:</comment>
  <info>string</info>      <strong>$name</strong>   Nom du paramètre de configuration.
  <info>string|int</info>  <strong>$value</strong>  Valeur du paramètre de configuration.

<comment>Return:</comment>
  <info>int</info>  Retourne le statut de la commande Varnish.


id: VarnishAdmin::setPort
type: function
doc:
<comment>Description:</comment>
  Définit le paramètre de configuration port

<comment>Param:</comment>
  <info>int</info>  <strong>$port</strong>  Le paramètre de configuration port.

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


id: VarnishAdmin::setSecret
type: function
doc:
<comment>Description:</comment>
  Définit le paramètre de configuration secret

<comment>Param:</comment>
  <info>string</info>  <strong>$secret</strong>  Le paramètre de configuration secret.

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


id: VarnishAdmin::setTimeout
type: function
doc:
<comment>Description:</comment>
  Définit le paramètre de configuration timeout

<comment>Param:</comment>
  <info>int</info>  <strong>$timeout</strong>  Le paramètre de configuration timeout.

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


id: VarnishAdmin::start
type: function
doc:
<comment>Description:</comment>
  Démarre un processus Varnish

<comment>Return:</comment>
  <info>int</info>  Retourne le statut de la commande Varnish.


id: VarnishAdmin::stop
type: function
doc:
<comment>Description:</comment>
  Arrête un processus Varnish

<comment>Return:</comment>
  <info>int</info>  Retourne le statut de la commande Varnish.


id: VarnishLog::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur Varnishlog

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Arguments de configuration. Les clés possibles sont :
                


id: VarnishLog::getLine
type: function
doc:
<comment>Description:</comment>
  Récupère la prochaine ligne de log

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant les données de la prochaine ligne de log.


id: VarnishLog::getTagName
type: function
doc:
<comment>Description:</comment>
  Récupère le nom de la balise représenté par son index

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index de la balise.

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


id: VarnishStat::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur VarnishStat

<comment>Param:</comment>
  <info>array</info>  <strong>$args</strong>  Arguments de configuration. Les clés possibles sont :
                


id: VarnishStat::getSnapshot
type: function
doc:
<comment>Description:</comment>
  Récupère les statistiques de l'instance courante Varnish

<comment>Return:</comment>
  <info>array</info>  Un tableau contenant les statistiques Varnish. Les clés du tableau sont identiques à celles
         de l'outil Varnishstat.


id: Volatile
type: class
doc:
<comment>Description:</comment>
  The <class>Volatile</class> class is new to pthreads v3. Its introduction is a consequence of the new
  immutability semantics of <class>Threaded</class> members of <class>Threaded</class> classes. The <class>Volatile</class> class enables for
  mutability of its <class>Threaded</class> members, and is also used to store PHP arrays in <class>Threaded</class> contexts.


id: Vtiful\Kernel\Excel
type: class
doc:
<comment>Description:</comment>
  Créé des fichiers xlsx et définie des cellules afin de récupérer des fichiers xlsx en sortie


id: Vtiful\Kernel\Excel::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur de la classe Vtiful\Kernel\Excel
  
  Constructeur de la classe <class>Vtiful\Kernel\Excel</class> ; crée un nouvel objet.

<comment>Param:</comment>
  <info>array</info>  <strong>$config</strong>  Configuration de l'exportation du fichier XLSX


id: Vtiful\Kernel\Excel::addSheet
type: function
doc:
<comment>Description:</comment>
  Ajoute une feuille de calcul
  
  Crée une nouvelle feuille de calcul dans le fichier xlsx.

<comment>Param:</comment>
  <info>string</info>  <strong>$sheetName</strong>  Nom de la feuille de calcul

<comment>Return:</comment>
  <info>unknown</info>  Instance de la classe <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::autoFilter
type: function
doc:
<comment>Description:</comment>
  Ajoute un filtre automatique
  
  Ajoute un filtre automatique à une feuille de travail.

<comment>Param:</comment>
  <info>string</info>  <strong>$scope</strong>  Chaîne de caractères représentant les coordonnées de la cellule de début et la
                  cellule de fin.

<comment>Return:</comment>
  <info>unknown</info>  Instance de la classe <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::constMemory
type: function
doc:
<comment>Description:</comment>
  Ecrit un gros fichier avec une utilisation constante de la mémoire
  
  Ecrit un gros fichier avec une utilisation constante de la mémoire.

<comment>Param:</comment>
  <info>string</info>  <strong>$fileName</strong>   Nom du fichier XLSX
  <info>string</info>  <strong>$sheetName</strong>  Nom de la feuille de calcul

<comment>Return:</comment>
  <info>unknown</info>  Instance de la classe <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::data
type: function
doc:
<comment>Description:</comment>
  Ecrit des données
  
  Ecrit des données dans une feuille de calcul.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  Les données de la feuille de calcul

<comment>Return:</comment>
  <info>unknown</info>  Instance de la classe  <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::fileName
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau fichier ainsi qu'une feuille de calcul
  
  Crée un nouveau fichier xlsx et crée une feuille de calcul.

<comment>Param:</comment>
  <info>string</info>  <strong>$fileName</strong>   Nom du fichier XLSX
  <info>string</info>  <strong>$sheetName</strong>  Nom de la feuille de calcul

<comment>Return:</comment>
  <info>unknown</info>  Instance de la classe <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::getHandle
type: function
doc:
<comment>Description:</comment>
  Récupère le gestionnaire de ressource
  
  Récupère le gestionnaire de ressource xlsx.

<comment>Return:</comment>
  <info>unknown</info>  La ressource


id: Vtiful\Kernel\Excel::header
type: function
doc:
<comment>Description:</comment>
  Ecrit l'en-tête d'une feuille de calcul
  
  Ecrit l'en-tête d'une feuille de calcul.

<comment>Param:</comment>
  <info>array</info>  <strong>$headerData</strong>  Les données de l'en-tête de la feuille de calcul

<comment>Return:</comment>
  <info>unknown</info>  Instance de la classe <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::insertFormula
type: function
doc:
<comment>Description:</comment>
  Insère une formule
  
  Insère une formule.

<comment>Param:</comment>
  <info>int</info>     <strong>$row</strong>      Cellule de la ligne
  <info>int</info>     <strong>$column</strong>   Cellule de la colonne
  <info>string</info>  <strong>$formula</strong>  Chaîne de caractères représentant la formule

<comment>Return:</comment>
  <info>unknown</info>  Instance de la classe  <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::insertImage
type: function
doc:
<comment>Description:</comment>
  Insère une image dans une cellule
  
  Insère une image locale dans une cellule.

<comment>Param:</comment>
  <info>int</info>     <strong>$row</strong>             Ligne de la cellule
  <info>int</info>     <strong>$column</strong>          Colonne de la cellule
  <info>string</info>  <strong>$localImagePath</strong>  Chemin local de l'image

<comment>Return:</comment>
  <info>unknown</info>  Une instance de la classe <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::insertText
type: function
doc:
<comment>Description:</comment>
  Ecrit du texte dans une cellule
  
  Ecrit du texte dans une cellule.

<comment>Param:</comment>
  <info>int</info>               <strong>$row</strong>     Ligne de la cellule
  <info>int</info>               <strong>$column</strong>  Colonne de la cellule
  <info>int|float|string</info>  <strong>$data</strong>    Le texte à écrire
  <info>string</info>            <strong>$format</strong>  Une chaîne de caractère représentant le format

<comment>Return:</comment>
  <info>unknown</info>  Une instance de la classe <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::mergeCells
type: function
doc:
<comment>Description:</comment>
  Fusionne des cellules
  
  Fusionne des cellules.

<comment>Param:</comment>
  <info>string</info>  <strong>$scope</strong>  Chaîne de caractères représentant les coordonnées de la cellule de début et de la
                  cellule de fin
  <info>string</info>  <strong>$data</strong>   Les données

<comment>Return:</comment>
  <info>unknown</info>  Une instance de la classe <class>Vtiful\Kernel\Excel</class>


id: Vtiful\Kernel\Excel::output
type: function
doc:
<comment>Description:</comment>
  Enregistre le fichier xlsx sur le disque
  
  Enregistre le fichier xlsx sur le disque.

<comment>Return:</comment>
  <info>unknown</info>  Chemin vers le fichier XLSX


id: Vtiful\Kernel\Excel::setColumn
type: function
doc:
<comment>Description:</comment>
  Définit le format d'une colonne
  
  Définit le format d'une colonne.

<comment>Param:</comment>
  <info>string</info>    <strong>$range</strong>   Chaîne de caractères représentant les coordonnées de la cellule de début et de
                     la cellule de fin
  <info>float</info>     <strong>$width</strong>   Largeur de la colonne
  <info>resource</info>  <strong>$format</strong>  Une ressource de format

<comment>Return:</comment>
  <info>unknown</info>  Une instance de la classe  <class>Vtiful\Kernel\Excel</class>.


id: Vtiful\Kernel\Excel::setRow
type: function
doc:
<comment>Description:</comment>
  Définit le format d'une ligne
  
  Définit le format d'une ligne.

<comment>Param:</comment>
  <info>string</info>    <strong>$range</strong>   Chaîne de caractères représentant les coordonnées de la cellule de début et de
                     la cellule de fin
  <info>float</info>     <strong>$height</strong>  Hauteur de la ligne
  <info>resource</info>  <strong>$format</strong>  Ressource de format

<comment>Return:</comment>
  <info>unknown</info>  Une instance de la classe  <class>Vtiful\Kernel\Excel</class>.


id: Vtiful\Kernel\Format::align
type: function
doc:
<comment>Description:</comment>
  Définit l'alignement de la cellule
  
  Définit l'alignement de la cellule.

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  Gestionnaire de fichier xlsx
  <info>int</info>       <strong>$style</strong>   Une constante <class>Vtiful\Kernel\Format</class>

<comment>Return:</comment>
  <info>unknown</info>  Resource


id: Vtiful\Kernel\Format::bold
type: function
doc:
<comment>Description:</comment>
  Mise en gras
  
  Mise en gras.

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  Gestionnaire de fichier xlsx

<comment>Return:</comment>
  <info>unknown</info>  Une ressource de formattage.


id: Vtiful\Kernel\Format::italic
type: function
doc:
<comment>Description:</comment>
  Mise en italique
  
  Mise en italique.

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  Gestionnaire de fichier xlsx.

<comment>Return:</comment>
  <info>unknown</info>  Une ressource de mise en italique.


id: Vtiful\Kernel\Format::underline
type: function
doc:
<comment>Description:</comment>
  Mise en souligné
  
  Mise en souligné.

<comment>Param:</comment>
  <info>resource</info>  <strong>$handle</strong>  Gestionnaire de fichier xlsx
  <info>int</info>       <strong>$style</strong>   Une constante <class>Vtiful\Kernel\Format</class>

<comment>Return:</comment>
  <info>unknown</info>  Une ressource de mise en souligné.


id: WIN32_ABOVE_NORMAL_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Processus ayant une priorité supérieure WIN32_NORMAL_PRIORITY_CLASS  mais inférieure à
  WIN32_HIGH_PRIORITY_CLASS.


id: WIN32_BELOW_NORMAL_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Processsus ayant une priorité supperieur à WIN32_IDLE_PRIORITY_CLASS mais inférieure à
  WIN32_NORMAL_PRIORITY_CLASS.


id: WIN32_ERROR_ACCESS_DENIED
type: constant
doc:
<comment>Description:</comment>
  Le gestionnaire de la base de données SMC ne dispose pas des droits d'accès appropriés.


id: WIN32_ERROR_DEPENDENT_SERVICES_RUNNING
type: constant
doc:
<comment>Description:</comment>
  0x0000041B
  
  Le service ne peut être stoppé car d'autres services en cours d'exécution dépendent de lui.


id: WIN32_ERROR_DUPLICATE_SERVICE_NAME
type: constant
doc:
<comment>Description:</comment>
  Le nom d'affichage existe déjà dans la base de données du gestionnaire de service en tant que nom
  de service ou que nom d'affichage.


id: WIN32_ERROR_FAILED_SERVICE_CONTROLLER_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Cette erreur est retournée si le programme est exécuté en application console  plutôt qu'en tant
  que service. Si le programme est exécuté en tant qu'application console à des fins de débogage, il
  devrat être structuré afin que le code spécifique au service ne sois jamais appelé.


id: WIN32_ERROR_INSUFFICIENT_BUFFER
type: constant
doc:
<comment>Description:</comment>
  0x0000007A
  
  Le tampon est trop petit pour la structure d'état de service.  Rien n'a été écrit à la structure.


id: WIN32_ERROR_INVALID_DATA
type: constant
doc:
<comment>Description:</comment>
  0x0000000D
  
  Le structure d'état de service indiquée n'est pas valide.


id: WIN32_ERROR_INVALID_HANDLE
type: constant
doc:
<comment>Description:</comment>
  Le handle pour le gestionnaire de service de control spécifié est invalide.


id: WIN32_ERROR_INVALID_LEVEL
type: constant
doc:
<comment>Description:</comment>
  0x0000007C
  
  Le paramètre InfoLevel contient une valeur non prise en charge.


id: WIN32_ERROR_INVALID_SERVICE_ACCOUNT
type: constant
doc:
<comment>Description:</comment>
  Le nom d'utilisateur spécifié dans le paramètre <strong>$user</strong> n'existe pas. Voir <strong>win32_create_service()</strong>.


id: WIN32_ERROR_INVALID_SERVICE_CONTROL
type: constant
doc:
<comment>Description:</comment>
  0x0000041C
  
  Le code de control demandé n'est pas valide, ou il est inacceptable pour le service.


id: WIN32_ERROR_SERVICE_CANNOT_ACCEPT_CTRL
type: constant
doc:
<comment>Description:</comment>
  Le code de control demandé ne peut être envoyé au service car l'état du service  est
  <info>WIN32_SERVICE_STOPPED</info>,  <info>WIN32_SERVICE_START_PENDING</info> ou  <info>WIN32_SERVICE_STOP_PENDING</info>.


id: WIN32_ERROR_SERVICE_DEPENDENCY_DELETED
type: constant
doc:
<comment>Description:</comment>
  Le service dépend d'un service qui n'existe pas ou qui a été marqué pour suppression.


id: WIN32_ERROR_SERVICE_DEPENDENCY_FAIL
type: constant
doc:
<comment>Description:</comment>
  0x0000042C
  
  Ce service dépend d'un autre service qui n'a pas pu démarrer.


id: WIN32_ERROR_SERVICE_LOGON_FAILED
type: constant
doc:
<comment>Description:</comment>
  0x0000042D
  
  Le service n'a pas démarré en raison d'un échec de connexion. Cette erreur se produit si le
  service est configuré pour s'exécuter sous un compte qui n'a pas les droits "connecter en tant que
  service".


id: WIN32_ERROR_SERVICE_REQUEST_TIMEOUT
type: constant
doc:
<comment>Description:</comment>
  0x0000041D
  
  Le processus du service a été démarré, mais il n'a pas appelé  StartServiceCtrlDispatcher, ou le
  thread qui a appelé StartServiceCtrlDispatcher peut être bloqué dans une fonction du gestionnaire
  de contrôle.


id: WIN32_ERROR_SERVICE_SPECIFIC_ERROR
type: constant
doc:
<comment>Description:</comment>
  0x0000042A
  
  Le service a retourné un code d'erreur spécifique au service.


id: WIN32_ERROR_SHUTDOWN_IN_PROGRESS
type: constant
doc:
<comment>Description:</comment>
  0x0000045B
  
  Le système s'arrête, cette fonction ne peut pas être appelée.


id: WIN32_HIGH_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Processus qui exécute des tâches critiques dans le temps qui doivent être exécutées immédiatement.
  Le thread du processus devance les  threads de priorité normale ou au repos. Un exemple est la
  liste des  tâches, qui doit répondre rapidement quand elle est appelée par  l'utilisateur quel que
  sois la charge du système. Soyez extrêmement  prudent lorsque vous utilisez la classe de haute
  priorité, car une application de classe de haute priorité peut utiliser presque tout le temps CPU
  disponible.


id: WIN32_IDLE_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Processus dont les threads ne s'exécutent que lorsque le système est  inactif. Les threads du
  processus sont devancés par les threads de tout processus en cours ayant une classe de plus grande
  priorité.  Un exemple est un économiseur d'écran. Cette classe est héritée par les processus
  enfants.


id: WIN32_REALTIME_PRIORITY_CLASS
type: constant
doc:
<comment>Description:</comment>
  Processus ayant la plus haute priorité possible. Les threads du processus  devance les threads de
  tout autre processus, y compris les processus du  système d'exploitation exécutant des tâches
  importantes. Par exemple, un processus en temps réel qui s'exécute un peu trop lentement peut
  causer  des pertes d'ecriture du tampon sur le disque ou empecher à la souris de répondre.


id: WIN32_SERVICE_ACCEPT_HARDWAREPROFILECHANGE
type: constant
doc:
<comment>Description:</comment>
  Le service est notifié lorsque le profil matériel de l'ordinateur a changé. Cela permet au système
  d'envoyer des notifications  <info>WIN32_SERVICE_CONTROL_HARDWAREPROFILECHANGE</info> au service.


id: WIN32_SERVICE_ACCEPT_NETBINDCHANGE
type: constant
doc:
<comment>Description:</comment>
  Le service est un composant réseau qui peut accepter les modifications de  sa liaison sans être
  arrêté et redémarré. Ce code de contrôle permet au  service de recevoir les notifications
  <info>WIN32_SERVICE_CONTROL_NETBINDADD</info>,  <info>WIN32_SERVICE_CONTROL_NETBINDREMOVE</info>,
  <info>WIN32_SERVICE_CONTROL_NETBINDENABLE</info>, et  <info>WIN32_SERVICE_CONTROL_NETBINDDISABLE</info>.


id: WIN32_SERVICE_ACCEPT_PARAMCHANGE
type: constant
doc:
<comment>Description:</comment>
  Le service peut relire ses paramètres de démarrage sans être arrêté et redémarré. Ce code de
  contrôle permet au service de recevoir des notifications <info>WIN32_SERVICE_CONTROL_PARAMCHANGE</info>.


id: WIN32_SERVICE_ACCEPT_PAUSE_CONTINUE
type: constant
doc:
<comment>Description:</comment>
  Le service peut être mis en pause et continué. Ce code de control permet au  service de recevoir
  les notifications <info>WIN32_SERVICE_CONTROL_PAUSE</info> et <info>WIN32_SERVICE_CONTROL_CONTINUE</info>.


id: WIN32_SERVICE_ACCEPT_POWEREVENT
type: constant
doc:
<comment>Description:</comment>
  Le service est notifié lorsque l'état d'alimentation de l'ordinateur a changé. Cela permet au
  système d'envoyer des notifications  <info>WIN32_SERVICE_CONTROL_POWEREVENT</info> au service.


id: WIN32_SERVICE_ACCEPT_PRESHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  Le service peut effectuer des tâche d'avant arrêt. Ce code de control permet au service de
  recevoir la notification <info>WIN32_SERVICE_CONTROL_PRESHUTDOWN</info>. Cette valeur n'est pas pris en charge
  par Windows Server 2003 et Windows XP/2000.


id: WIN32_SERVICE_ACCEPT_SESSIONCHANGE
type: constant
doc:
<comment>Description:</comment>
  Le service est notifié lorsque l'état de session de l'ordinateur a changé. Cela permet au système
  d'envoyer des notifications  <info>WIN32_SERVICE_CONTROL_SESSIONCHANGE</info> au service.         Windows 2000:
  cette valeur n'est pas prise en charge.


id: WIN32_SERVICE_ACCEPT_SHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  Le service est informé lorsque l'arrêt du système se produit. Ce code de control permet au service
  de recevoir la notification <info>WIN32_SERVICE_CONTROL_SHUTDOWN</info>.


id: WIN32_SERVICE_ACCEPT_STOP
type: constant
doc:
<comment>Description:</comment>
  Le service peut être stoppé. Ce control permet au service de recevoir la  notification
  <info>WIN32_SERVICE_CONTROL_STOP</info>.


id: WIN32_SERVICE_ACCEPT_TIMECHANGE
type: constant
doc:
<comment>Description:</comment>
  Le service est notifié lorsque l'heure système a changé. Cela permet au système d'envoyer des
  notifications  <info>WIN32_SERVICE_CONTROL_TIMECHANGE</info> au service. Windows Server 2008, Windows Vista,
  Windows Server 2003 et Windows XP/2000:  ce code de contrôle n'est pas pris en charge.


id: WIN32_SERVICE_ACCEPT_TRIGGEREVENT
type: constant
doc:
<comment>Description:</comment>
  Le service est notifié lorsqu'un événement pour lequel le service s'est  enregistré se produit.
  Cela permet au système d'envoyer des notifications  <info>WIN32_SERVICE_CONTROL_TRIGGEREVENT</info> au service.
  Windows Server 2008, Windows Vista, Windows Server 2003 et Windows XP/2000:  ce code de contrôle
  n'est pas pris en charge.


id: WIN32_SERVICE_AUTO_START
type: constant
doc:
<comment>Description:</comment>
  Un service lancé automatiquement par le gestionnaire de contrôle de service au  démarrage du
  système.


id: WIN32_SERVICE_BOOT_START
type: constant
doc:
<comment>Description:</comment>
  Un pilote de périphérique Démarré par le chargeur système. Cette valeur est valide uniquement pour
  les services de pilote.


id: WIN32_SERVICE_CONTROL_INTERROGATE
type: constant
doc:
<comment>Description:</comment>
  Avertit un service qu'il doit rendre compte de informations sur son état actuel au gestionnaire de
  contrôle de service.


id: WIN32_SERVICE_CONTROL_NETBINDADD
type: constant
doc:
<comment>Description:</comment>
  Avertit un service réseau qu'il existe un nouveau composant pour la liaison.


id: WIN32_SERVICE_CONTROL_NETBINDDISABLE
type: constant
doc:
<comment>Description:</comment>
  0x0000000A
  
  Avertit un service réseau que l'une de ses liaisons a été désactivée.


id: WIN32_SERVICE_CONTROL_NETBINDENABLE
type: constant
doc:
<comment>Description:</comment>
  Avertit un service réseau qu'une liaison désactivée a été activée.


id: WIN32_SERVICE_CONTROL_NETBINDREMOVE
type: constant
doc:
<comment>Description:</comment>
  Avertit un service réseau qu'un composant pour la liaison a été supprimé.


id: WIN32_SERVICE_CONTROL_PRESHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  0x0000000F
  
  Avertit un service que le système va s'arrêter. Un service qui gère cette notification bloque
  l'arrêt du système jusqu'à l'arrêt du service ou jusqu'à ce que le délai preshutdown expire. Cette
  valeur n'est pas pris en charge par Windows Server 2003 et Windows XP/2000.


id: WIN32_SERVICE_CONTROL_SHUTDOWN
type: constant
doc:
<comment>Description:</comment>
  Avertit un service que le système s'arrête et que le service peut donc effectuer des tâches de
  nettoyage. Si un service accepte ce code de  contrôle, il doit s'arrêter dès qu'il s'acquitte de
  ses tâches de nettoyage. Après l'envoie ce code de contrôle par l'ACM, aucun autre code de
  contrôle  ne sera envoyé au service.


id: WIN32_SERVICE_DEMAND_START
type: constant
doc:
<comment>Description:</comment>
  Un service a démarré par le gestionnaire de contrôle de service quand un  processus appel la
  fonction StartService.


id: WIN32_SERVICE_DISABLED
type: constant
doc:
<comment>Description:</comment>
  Un service qui ne peut pas être démarré. Les tentatives pour démarrer  retourne un code d'erreur
  <info>WIN32_ERROR_SERVICE_DISABLED </info>.


id: WIN32_SERVICE_ERROR_CRITICAL
type: constant
doc:
<comment>Description:</comment>
  Le programme de démarrage consigne l'erreur dans le journal des événements,  si possible. Si la
  dernière configuration connue est lancée, l'opération de démarrage  échoue. Sinon, le système est
  redémarré avec la dernière bonne configuration  connue.


id: WIN32_SERVICE_ERROR_IGNORE
type: constant
doc:
<comment>Description:</comment>
  Le programme de démarrage ignore l'erreur et continue l'opération de démarrage.


id: WIN32_SERVICE_ERROR_NORMAL
type: constant
doc:
<comment>Description:</comment>
  Le programme de démarrage enregistre l'erreur dans le journal des événements,  mais il continue
  l'opération de démarrage.


id: WIN32_SERVICE_ERROR_SEVERE
type: constant
doc:
<comment>Description:</comment>
  Le programme de démarrage consigne l'erreur dans le journal des événements.  Si la dernière
  configuration connue est lancée, l'opération de démarrage se poursuit. Sinon, le système est
  redémarré avec la dernière configuration  connue-bonne.


id: WIN32_SERVICE_INTERACTIVE_PROCESS
type: constant
doc:
<comment>Description:</comment>
  Le service peut interagir avec le bureau. Cette option n'est pas disponible sur Windows Vista ou
  version ultérieure.


id: WIN32_SERVICE_RUNS_IN_SYSTEM_PROCESS
type: constant
doc:
<comment>Description:</comment>
  Le service s'exécute dans un processus système qui doit toujours  être en cours d'exécution.


id: WIN32_SERVICE_SYSTEM_START
type: constant
doc:
<comment>Description:</comment>
  Un pilote de périphérique Démarré par la fonction IoInitSystem. Cette valeur est valide uniquement
  pour les services de pilote.


id: WIN32_SERVICE_WIN32_OWN_PROCESS_INTERACTIVE
type: constant
doc:
<comment>Description:</comment>
  Le service s'exécute dans son propre processus et peut interagir avec le bureau. Cette option
  n'est pas disponible sous Windows Vista et suivant.


id: WSDL_CACHE_BOTH
type: constant
doc:
<comment>Description:</comment>
  Spécifie l'utilisation des caches WSDL en mémoire et sur disque lorsqu'elle est utilisée dans
  l'option de configuration soap.wsdl_cache ou l'option <return>wsdl_cache</return> de SoapClient::__construct et
  SoapServer::__construct.


id: WSDL_CACHE_DISK
type: constant
doc:
<comment>Description:</comment>
  Indique l'utilisation du cache WSDL en mémoire uniquement lorsqu'il est utilisé dans l'option de
  configuration soap.wsdl_cache ou l'option <return>wsdl_cache</return> de SoapClient::__construct et
  SoapServer::__construct.


id: WSDL_CACHE_MEMORY
type: constant
doc:
<comment>Description:</comment>
  Spécifie l'utilisation du cache WSDL en mémoire vive uniquement lorsqu'il est utilisé dans
  l'option de configuration soap.wsdl_cache ou l'option <return>wsdl_cache</return> de SoapClient::__construct et
  SoapServer::__construct.


id: WSDL_CACHE_NONE
type: constant
doc:
<comment>Description:</comment>
  Désactive le cache WSDL lorsqu'il est utilisé dans l'option de configuration soap.wsdl_cache ou
  dans l'option <return>wsdl_cache</return> de SoapClient::__construct et SoapServer::__construct.


id: Warning::__construct
type: function
doc:
<comment>Description:</comment>
  Warning constructor
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.


id: WeakMap
type: class
doc:
<comment>Description:</comment>
  Un <class>WeakMap</class> est un tableau associatif (ou dictionnaire) qui accepte des objets comme clés.
  Cependant, contrairement  au autrement similaire <class>SplObjectStorage</class>, un objet dans une clé de
  <class>WeakMap</class> ne contribue pas au nombre de références de l'objet. En d'autres termes, si, à un moment
  donné, la seule référence restante à un objet est la clé d'un <class>WeakMap</class>, l'objet sera ramassé et
  supprimé du <class>WeakMap</class>. Son principal cas d'utilisation est la construction de caches de données
  dérivées d'un objet qui n'ont pas besoin d'être conservées plus longtemps que l'objet.
  
  <class>WeakMap</class> implemente ArrayAccess, Iterator, et Countable, de sorte que, dans la plupart des cas, il
  peut être utilisé de la même manière qu'un tableau associatif.


id: WeakMap::count
type: function
doc:
<comment>Description:</comment>
  Compte le nombre d'entrées actives dans le dictionnaire
  
  Compte le nombre d'entrées actives dans le dictionnaire.

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre d'entrées actives dans le dictionnaire.


id: WeakMap::getIterator
type: function
doc:
<comment>Description:</comment>
  Récupére un itérateur externe
  
  Retourne un itérateur externe.

<comment>Return:</comment>
  <info>Iterator</info>  Une instance d'un objet implémentant <class>Iterator</class> ou <class>Traversable</class>


id: WeakMap::offsetExists
type: function
doc:
<comment>Description:</comment>
  Vérifie si un certain objet se trouve dans le dictionnaire
  
  Vérifie si l'objet transmis est référencé dans le dictionnaire.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Objet à vérifier.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si l'objet est contenu dans le dictionnaire, <info>false</info> sinon.


id: WeakMap::offsetGet
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur indiquée par un certain objet
  
  Retourne la valeur indiquée par un certain objet.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  Un objet contenu comme clé dans le dictionnaire.

<comment>Return:</comment>
  <info>mixed</info>  Renvoie la valeur associée à l'objet passé en argument, sinon <info>null</info>.


id: WeakMap::offsetSet
type: function
doc:
<comment>Description:</comment>
  Met à jour le dictionnaire avec une nouvelle paire clé-valeur
  
  Met à jour le dictionnaire avec une nouvelle paire clé-valeur. Si la clé existait déjà, l'ancienne
  valeur est remplacée par la nouvelle.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet servant de clé à la paire clé-valeur.
  <info>mixed</info>   <strong>$value</strong>   Les données arbitraires servant de valeur à la paire clé-valeur.

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


id: WeakMap::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Supprime une entrée du dictionnaire
  
  Supprime une entrée du dictionnaire.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet clé à supprimer du dictionnaire.

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


id: WeakReference
type: class
doc:
<comment>Description:</comment>
  Les références faibles permettent au programmeur de conserver une référence à un objet sans en
  empêcher sa destruction. Ils sont utiles pour implémenter des structures tel que des caches.
  
  Les <class>WeakReference</class>s ne peuvent pas être sérialisées.


id: WeakReference::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur qui interdit l'initialisation
  
  Cette méthode existe seulement pour interdire l'initialisation de la classe <class>WeakReference</class>. Les
  références faibles doivent être initialisées avec la méthode usine (factory)
  WeakReference::create.

<comment>See Also:</comment>
   * WeakReference::create


id: WeakReference::create
type: function
doc:
<comment>Description:</comment>
  Créer une nouvelle référence faible
  
  Crée une nouvelle <class>WeakReference</class>.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet à référencer faiblement

<comment>Return:</comment>
  <info>WeakReference</info>  Retourne l'objet nouvellement instancié.


id: WeakReference::get
type: function
doc:
<comment>Description:</comment>
  Récupère un objet faiblement référencé
  
  Récupère un objet faiblement référencé. Si l'objet a déjà été détruit, <info>null</info> est retourné.

<comment>Return:</comment>
  <info>object|null</info>  Retourne l'objet référencé, ou <info>null</info> si l'objet a été détruit.


id: Worker
type: class
doc:
<comment>Description:</comment>
  Les Threads Worker ont un contexte persistent, aussi,  ils peuvent être utilisés via Threads dans
  la plupart des cas.
  
  Quand un Worker est démarré, la méthode run sera  exécuté, mais le <class>Thread</class> ne      s'arrêtera pas
  tant qu'une des conditions suivantes n'est pas atteinte :
  
  le Worker est hors de portée (aucune référence restante) ;
  
  le développeur appelle shutdown ;
  
  le script meurt.
  
  Ce qui signifie que le développeur peut réutiliser le contexte tout au long  de l'exécution ;
  placer des objets sur la pile du  <class>Worker</class> va entrainer le <class>Worker</class>  à exécuter la méthode run sur les
  objets empilés.


id: Worker::collect
type: function
doc:
<comment>Description:</comment>
  Collect references to completed tasks
  
  Allows the worker to collect references determined to be garbage by the optionally given
  collector.

<comment>Param:</comment>
  <info>Callable</info>  <strong>$collector</strong>  A Callable collector that returns a boolean on whether the task can be
                        collected or not. Only in rare cases should a custom collector need to be
                        used.

<comment>Return:</comment>
  <info>int</info>  The number of remaining tasks on the worker's stack to be collected.


id: Worker::getStacked
type: function
doc:
<comment>Description:</comment>
  Obtient la taille de pile restante
  
  Retourne le nombre de tâches laissées sur la pile

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de tâches actuellement en attente d'être exécutées par le worker


id: Worker::isShutdown
type: function
doc:
<comment>Description:</comment>
  Détection de statut
  
  Indique si le Worker a été arrêté ou non.

<comment>Return:</comment>
  <info>bool</info>  Retourne si le Worker a été arrêté ou non.


id: Worker::shutdown
type: function
doc:
<comment>Description:</comment>
  Arrêter le worker
  
  Arrête le Worker après l'exécution de toutes les tâches empilées.

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


id: Worker::stack
type: function
doc:
<comment>Description:</comment>
  Empile la tâche
  
  Ajoute la nouvelle tâche à la pile du worker référencé.

<comment>Param:</comment>
  <info>Threaded</info>  <strong>$work</strong>  Objet <class>Threaded</class> à exécuter par le worker.

<comment>Return:</comment>
  <info>int</info>  La nouvelle taille de la pile.


id: Worker::unstack
type: function
doc:
<comment>Description:</comment>
  Dépile une tâche
  
  Supprime la première tâche (la plus ancienne) de la pile.

<comment>Return:</comment>
  <info>int</info>  La nouvelle taille de la pile.


id: XATTR_DONTFOLLOW
type: constant
doc:
<comment>Description:</comment>
  Ne pas suivre un lien symbolique mais opérer directement sur le lien symbolique.


id: XATTR_ROOT
type: constant
doc:
<comment>Description:</comment>
  Définit un attribut dans l'espace de noms racine. Nécessite les privilèges d'administrateur.


id: XDIFF_PATCH_NORMAL
type: constant
doc:
<comment>Description:</comment>
  Cette option indique que les fonctions <strong>xdiff_string_patch()</strong> et <strong>xdiff_file_patch()</strong> doivent créer un
  résultat en appliquant le patch  au contenu original, et créer ainsi une nouvelle version du
  fichier. C'est le mode d'opération par défaut.


id: XDIFF_PATCH_REVERSE
type: constant
doc:
<comment>Description:</comment>
  Cette option indique que les fonctions <strong>xdiff_string_patch()</strong> et <strong>xdiff_file_patch()</strong> doivent créer un
  résultat en annulant un patch depuis une version de fichier pour retrouver la version originale.


id: XHPROF_FLAGS_CPU
type: constant
doc:
<comment>Description:</comment>
  Utilisée pour ajouter les informations de profilage CPU dans la sortie.


id: XHPROF_FLAGS_MEMORY
type: constant
doc:
<comment>Description:</comment>
  Utilisée pour ajouter les informations de profilage de la mémoire dans la sortie.


id: XHPROF_FLAGS_NO_BUILTINS
type: constant
doc:
<comment>Description:</comment>
  Utilisée pour ne pas tenir compte de toutes les fonctions internes.


id: XMLDiff\Base
type: class
doc:
<comment>Description:</comment>
  Classe abstraite de base pour toutes les classes de comparaison de cette extension.


id: XMLDiff\Base::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur
  
  Constructeur de base pour toutes les classes de l'extension xmldiff.

<comment>Param:</comment>
  <info>string</info>  <strong>$nsname</strong>  Espace de noms personnalisé pour le document de différence. L'espace de noms par
                   défaut est http://www.locus.cz/diffmark et est suffisant pour éviter les conflits
                   d'espaces de noms. Utilisez ce paramètre si vous voulez changer d'espace de noms.


id: XMLDiff\Base::diff
type: function
doc:
<comment>Description:</comment>
  Produit la différence de deux documents XML
  
  Méthode abstraire de création de différence à implémenter par héritage de la classe.
  
  Le but premier de cette méthode est de produire la différence de deux documents. L'ordre des
  paramètres est important, et va produire une sortie différente.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$from</strong>  Document XML source.
  <info>mixed</info>  <strong>$to</strong>    Document XML cible.

<comment>Return:</comment>
  <info>mixed</info>  Dépend de l'implémentation.


id: XMLDiff\Base::merge
type: function
doc:
<comment>Description:</comment>
  Produit un nouveau document XML basé sur une différence
  
  Méthode abstraite de fusion à implémenter par héritage de la classe.
  
  Basiquement, le but de cette méthode est de produire un nouveau document XML basé sur les
  informations de différence.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$src</strong>   Document XML source.
  <info>mixed</info>  <strong>$diff</strong>  Document produit par la méthode de création de différence.

<comment>Return:</comment>
  <info>mixed</info>  Dépend de l'implémentation.


id: XMLDiff\DOM::diff
type: function
doc:
<comment>Description:</comment>
  Trouve la différence de deux objets DOMDocument
  
  Trouve la différence de deux instances DOMDocument et produit un nouvel objet DOMDocument
  contenant les informations de différence.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$from</strong>  Objet source DOMDocument.
  <info>DOMDocument</info>  <strong>$to</strong>    Objet cible DOMDocument.

<comment>Return:</comment>
  <info>DOMDocument</info>  Un nouvel objet DOMDocument contenant les informations de différence ou NULL.


id: XMLDiff\DOM::merge
type: function
doc:
<comment>Description:</comment>
  Produit un DOMDocument fusionné
  
  Crée un nouveau DOMDocument basé sur une différence.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$src</strong>   Objet DOMDocument source.
  <info>DOMDocument</info>  <strong>$diff</strong>  L'objet DOMDocument contenant les informations de différence.

<comment>Return:</comment>
  <info>DOMDocument</info>  DOMDocument fusionné ou NULL.


id: XMLDiff\File::diff
type: function
doc:
<comment>Description:</comment>
  Effectue la différence entre deux documents XML
  
  Effectue la différence entre deux documents XML locaux, et produit une chaîne contenant les
  informations de différence.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  Chemin vers le document source.
  <info>string</info>  <strong>$to</strong>    Chemin vers le document cible.

<comment>Return:</comment>
  <info>string</info>  Une chaîne contenant la différence des deux documents XML ou NULL.


id: XMLDiff\File::merge
type: function
doc:
<comment>Description:</comment>
  Fusionne un document XML
  
  Crée un document XML basé sur des différences et sur le document source.

<comment>Param:</comment>
  <info>string</info>  <strong>$src</strong>   Chemin vers le document XML source.
  <info>string</info>  <strong>$diff</strong>  Chemin vers le document XML contenant les informations de différence.

<comment>Return:</comment>
  <info>string</info>  Une chaîne de caractères représentant le nouveau document XML ou NULL.


id: XMLDiff\Memory::diff
type: function
doc:
<comment>Description:</comment>
  Différence entre deux documents XML
  
  Effectue la différence de deux chaînes contenant des documents XML et produit les informations de
  différence.

<comment>Param:</comment>
  <info>string</info>  <strong>$from</strong>  Document XML source.
  <info>string</info>  <strong>$to</strong>    Document XML cible.

<comment>Return:</comment>
  <info>string</info>  Une chaîne contenant la différence entre les deux documents XML ou NULL.


id: XMLDiff\Memory::merge
type: function
doc:
<comment>Description:</comment>
  Fusionne un document XML
  
  Crée un nouveau document XML basé sur les différences et le document source.

<comment>Param:</comment>
  <info>string</info>  <strong>$src</strong>   Document XML source.
  <info>string</info>  <strong>$diff</strong>  Document XML contenant les informations de différence.

<comment>Return:</comment>
  <info>string</info>  Une chaîne contenant le nouveau document XML ou NULL.


id: XMLParser
type: class
doc:
<comment>Description:</comment>
  Une classe totalement opaque qui remplace les ressources <return>xml</return> à partir de PHP 8.0.0.


id: XMLReader
type: class
doc:
<comment>Description:</comment>
  L'extension XMLReader est un analyseur XML. L'analyseur fonctionne comme un curseur qui parcourt
  le document et s'arrête sur chaque nœud.


id: XMLReader::XML
type: function
doc:
<comment>Description:</comment>
  Fixe les données contenant le XML à analyser
  
  Fixe les données contenant le XML à analyser.

<comment>Param:</comment>
  <info>string</info>       <strong>$source</strong>    Chaîne de caractères contenant le XML à analyser.
  <info>string|null</info>  <strong>$encoding</strong>  L'encodage du document, ou <info>null</info>.
  <info>int</info>          <strong>$flags</strong>     Un masque de constantes LIBXML_*.

<comment>Return:</comment>
  <info>bool|XMLReader</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient. Si
                  appelée statiquement, retourne un objet <class>XMLReader</class> ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * XMLReader::open
   * XMLReader::close


id: XMLReader::close
type: function
doc:
<comment>Description:</comment>
  Ferme l'entrée XMLReader
  
  Ferme l'entrée de l'objet XMLReader qui est en train d'être analysé.

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

<comment>See Also:</comment>
   * XMLReader::open
   * XMLReader::xml


id: XMLReader::expand
type: function
doc:
<comment>Description:</comment>
  Retourne une copie du nœud courant comme un nœud d'objet DOM
  
  Cette méthode copie le nœud courant et retourne l'objet approprié DOM.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$baseNode</strong>  Un <class>DOMNode</class> définissant la cible <class>DOMDocument</class> pour l'objet DOM créé.

<comment>Return:</comment>
  <info>DOMNode|false</info>  L'objet <class>DOMNode</class> résultant ou <info>false</info> en cas d'erreur.


id: XMLReader::getAttribute
type: function
doc:
<comment>Description:</comment>
  Récupère la valeur d'un attribut par nom
  
  Retourne la valeur d'un attribut par nom ou <info>null</info> si l'attribut n'existe pas ou n'est pas
  positionné sur le nœud.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Le nom de l'attribut.

<comment>Return:</comment>
  <info>string|null</info>  La valeur de l'attribut ou <info>null</info> si l'attribut avec le <strong>$name</strong> donné n'existe pas ou
               n'est pas positionné sur le nœud d'un élément.

<comment>See Also:</comment>
   * XMLReader::getAttributeNo
   * XMLReader::getAttributeNs


id: XMLReader::getAttributeNo
type: function
doc:
<comment>Description:</comment>
  Récupère la valeur d'un attribut par index
  
  Retourne la valeur d'un attribut basé sur sa position ou d'une chaîne de caractères vide si
  l'attribut n'existe pas ou n'est pas positionné sur le nœud.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  La position de l'attribut.

<comment>Return:</comment>
  <info>string|null</info>  La valeur de l'attribut, ou <info>null</info> si aucun attribut n'existe à <strong>$index</strong> ou n'est pas
               positionné sur l'élément.

<comment>See Also:</comment>
   * XMLReader::getAttribute
   * XMLReader::getAttributeNs


id: XMLReader::getAttributeNs
type: function
doc:
<comment>Description:</comment>
  Récupère la valeur d'un attribut par nom local et URI
  
  Retourne la valeur d'un attribut par nom et espace de nom URI ou une chaîne de caractères vide si
  l'attribut n'existe pas ou n'est pas positionné sur le nœud.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       Le nom local.
  <info>string</info>  <strong>$namespace</strong>  L'espace de nom URI.

<comment>Return:</comment>
  <info>string|null</info>  La valeur de l'attribut, ou <info>null</info> si aucun attribut avec le <strong>$name</strong> et  <strong>$namespace</strong>
               donnés n'est trouvé ou positionné sur l'élément.

<comment>See Also:</comment>
   * XMLReader::getAttribute
   * XMLReader::getAttributeNo


id: XMLReader::getParserProperty
type: function
doc:
<comment>Description:</comment>
  Indique si la propriété spécifiée a été fixée
  
  Indique si la propriété spécifiée a été fixée.

<comment>Param:</comment>
  <info>int</info>  <strong>$property</strong>  Une des constantes d'analyseur.

<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>
   * XMLReader::setParserProperty


id: XMLReader::isValid
type: function
doc:
<comment>Description:</comment>
  Indique si le document analysé est valide
  
  Retourne un booléen indiquant si le document qui est en train d'être analysé est valide.

<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>
   * XMLReader::setParserProperty
   * XMLReader::setRelaxNGSchema
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::setSchema


id: XMLReader::lookupNamespace
type: function
doc:
<comment>Description:</comment>
  Consulte l'espace de nom pour un préfixe
  
  Consulte dans la portée de l'espace de nom pour un préfixe donné.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>  Chaînes de caractères contenant le préfixe.

<comment>Return:</comment>
  <info>string|null</info>  La valeur de l'espace de nom, ou <info>null</info> si aucun espace de nom existe.


id: XMLReader::moveToAttribute
type: function
doc:
<comment>Description:</comment>
  Déplace un curseur à un attribut nommé
  
  Positionne le curseur sur l'attribut nommé.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Le nom de l'attribut.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToAttributeNo
type: function
doc:
<comment>Description:</comment>
  Déplace le curseur à un attribut par index
  
  Positionne le curseur sur l'attribut basé sur sa position.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  La position de l'attribut.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToAttributeNs
type: function
doc:
<comment>Description:</comment>
  Déplace le curseur à un attribut d'espace de nom
  
  Positionne le curseur sur le nom de l'attribut dans l'espace de nom spécifié.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>       Le nom local.
  <info>string</info>  <strong>$namespace</strong>  L'espace de nom URI.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToElement
type: function
doc:
<comment>Description:</comment>
  Positionne le curseur sur l'élément parent de l'attribut courant
  
  Déplace le curseur de l'élément parent de l'attribut courant.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès et <info>false</info> en cas d'échec ou non positionné sur un attribut
        lorsque cette méthode est appelée.

<comment>See Also:</comment>
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::moveToFirstAttribute
type: function
doc:
<comment>Description:</comment>
  Positionne le curseur sur le premier attribut
  
  Déplace le curseur sur le premier attribut.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToNextAttribute


id: XMLReader::moveToNextAttribute
type: function
doc:
<comment>Description:</comment>
  Positionne le curseur sur le prochain attribut
  
  Déplace le curseur sur le prochain attribut si positionné sur un attribut ou déplace sur le
  premier attribut si positionné sur un élément.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::moveToAttributeNo
   * XMLReader::moveToAttributeNs
   * XMLReader::moveToFirstAttribute


id: XMLReader::next
type: function
doc:
<comment>Description:</comment>
  Déplace le curseur au prochain nœud en sautant tous les sous arbres
  
  Positionne le curseur sur le prochain nœud en sautant tous les sous arbres. Si aucun nœud existe,
  le curseur est déplacé à la fin du document.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$name</strong>  Le nom du prochaine nœud à se déplacer.

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

<comment>See Also:</comment>
   * XMLReader::moveToNextAttribute
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute


id: XMLReader::open
type: function
doc:
<comment>Description:</comment>
  Fixe le URI contenant le XML à analyser
  
  Fixe le URI contenant le document XML à être analysé.

<comment>Param:</comment>
  <info>string</info>       <strong>$uri</strong>       URI pointant vers le document.
  <info>string|null</info>  <strong>$encoding</strong>  L'encodage du document, ou <info>null</info>.
  <info>int</info>          <strong>$flags</strong>     Un masque de constante LIBXML_*.

<comment>Return:</comment>
  <info>bool|XMLReader</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient. Si
                  appelée statiquement, retourne un objet <class>XMLReader</class> ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * XMLReader::xml
   * XMLReader::close


id: XMLReader::read
type: function
doc:
<comment>Description:</comment>
  Déplace le curseur sur le prochain nœud du document
  
  Déplace le curseur au prochain nœud texte du document.

<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>
   * XMLReader::moveToElement
   * XMLReader::moveToAttribute
   * XMLReader::next


id: XMLReader::readInnerXml
type: function
doc:
<comment>Description:</comment>
  Lit le code XML du nœud courant
  
  Lit le contenu du nœud courant, incluant les enfants et le balisage.

<comment>Return:</comment>
  <info>string</info>  Retourne le contenu du nœud courant sous forme de chaîne. Retourne une chaîne vide en cas
          d'échec.

<comment>See Also:</comment>
   * <strong>XMLReader::readString()</strong>
   * <strong>XMLReader::readOuterXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::readOuterXml
type: function
doc:
<comment>Description:</comment>
  Lit le code XML du nœud courant, y compris lui-même
  
  Lit le code XML du nœud courant, y compris lui-même.

<comment>Return:</comment>
  <info>string</info>  Lit le code XML du nœud courant, y compris lui-même, sous forme de chaîne. Retourne une
          chaîne vide en cas d'erreur.

<comment>See Also:</comment>
   * <strong>XMLReader::readString()</strong>
   * <strong>XMLReader::readInnerXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::readString
type: function
doc:
<comment>Description:</comment>
  Lit le contenu du nœud courant sous forme de chaîne
  
  Lit le contenu du nœud courant sous forme de chaîne.

<comment>Return:</comment>
  <info>string</info>  Retourne le contenu du nœud courant sous forme de chaîne ou une chaîne vide si une erreur
          survient.

<comment>See Also:</comment>
   * <strong>XMLReader::readOuterXml()</strong>
   * <strong>XMLReader::readInnerXml()</strong>
   * <strong>XMLReader::expand()</strong>


id: XMLReader::setParserProperty
type: function
doc:
<comment>Description:</comment>
  Fixe des options pour l'analyseur
  
  Fixe des options pour l'analyseur. Les options doivent être fixées après l'appel de
  XMLReader::open ou XMLReader::xml et avant le premier appel de XMLReader::read.

<comment>Param:</comment>
  <info>int</info>   <strong>$property</strong>  Une des constantes d'analyseur.
  <info>bool</info>  <strong>$value</strong>     Si fixée à <info>true</info>, l'option sera activée sinon elle sera désactivée.

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


id: XMLReader::setRelaxNGSchema
type: function
doc:
<comment>Description:</comment>
  Fixe le nom du fichier ou l'URI pour le Schéma RelaxNG
  
  Fixe le nom du fichier ou l'URI pour le Schéma RelaxNG à utiliser pour validation.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Nom du fichier ou URI pointant vers le Schéma RelaxNG.

<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>
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::setSchema
   * XMLReader::isValid


id: XMLReader::setRelaxNGSchemaSource
type: function
doc:
<comment>Description:</comment>
  Spécifie le schéma RelaxNG
  
  Spécifie le schéma RelaxNG à utiliser pour validation.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$source</strong>  Chaîne de caractères contenant le schéma RelaxNG.

<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>
   * XMLReader::setRelaxNGSchema
   * XMLReader::setSchema
   * XMLReader::isValid


id: XMLReader::setSchema
type: function
doc:
<comment>Description:</comment>
  Valide le document avec XSD
  
  Utilise le schéma XSD W3C pour valider le contenu, tel qu'il est traité. L'activation n'est
  possible qu'avant le premier Read().

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Le nom du fichier de schéma XSD.

<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>
   * XMLReader::setRelaxNGSchema
   * XMLReader::setRelaxNGSchemaSource
   * XMLReader::isValid


id: XMLWriter::endAttribute
type: function
doc:
<comment>Description:</comment>
  Termine un attribut
  
  Style orienté objet
  
  Style procédural
  
  Termine l'attribut courant.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::endCdata
type: function
doc:
<comment>Description:</comment>
  Termine un bloc CDATA
  
  Style orienté objet
  
  Style procédural
  
  Termine la section CDATA courante.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::startCdata
   * XMLWriter::writeCdata


id: XMLWriter::endComment
type: function
doc:
<comment>Description:</comment>
  Termine un commentaire
  
  Style orienté objet
  
  Style procédural
  
  Termine le commentaire courant.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::startComment
   * XMLWriter::writeComment


id: XMLWriter::endDocument
type: function
doc:
<comment>Description:</comment>
  Termine le document courant
  
  Style orienté objet
  
  Style procédural
  
  Termine le document courant.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::startDocument


id: XMLWriter::endDtd
type: function
doc:
<comment>Description:</comment>
  Termine la DTD courante
  
  Style orienté objet
  
  Style procédural
  
  Termine la DTD courante du document.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::startDtd
   * XMLWriter::writeDtd


id: XMLWriter::endDtdAttlist
type: function
doc:
<comment>Description:</comment>
  Termine la liste des attributs de la DTD courante
  
  Style orienté objet
  
  Style procédural
  
  Termine la liste des attributs de la DTD courante.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::startDtdAttlist
   * XMLWriter::writeDtdAttlist


id: XMLWriter::endDtdElement
type: function
doc:
<comment>Description:</comment>
  Termine l'élément de la DTD courante
  
  Style orienté objet
  
  Style procédural
  
  Termine l'élément de la DTD courante.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::startDtdElement
   * XMLWriter::writeDtdElement


id: XMLWriter::endDtdEntity
type: function
doc:
<comment>Description:</comment>
  Termine l'entité de la DTD courante
  
  Style orienté objet
  
  Style procédural
  
  Termine l'entité de la DTD courante.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::startDtdEntity
   * XMLWriter::writeDtdEntity


id: XMLWriter::endElement
type: function
doc:
<comment>Description:</comment>
  Termine l'élément courant
  
  Style orienté objet
  
  Style procédural
  
  Termine l'élément courant.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::startElement
   * XMLWriter::writeElement


id: XMLWriter::endPi
type: function
doc:
<comment>Description:</comment>
  Termine le PI courant
  
  Style orienté objet
  
  Style procédural
  
  Termine l'instruction courante.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::startPi
   * XMLWriter::writePi


id: XMLWriter::flush
type: function
doc:
<comment>Description:</comment>
  Affiche le buffer courant
  
  Style orienté objet
  
  Style procédural
  
  Affiche le buffer courant.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>       <strong>$empty</strong>   Si l'on doit vider le buffer ou non. Par défaut, ce paramètre vaut <info>true</info>.

<comment>Return:</comment>
  <info>string|int</info>  Si vous aviez ouvert le gestionnaire d'écriture en mémoire, cette fonction retourne le
              buffer XML généré. Si vous utilisez une URI, cette fonction écrira le buffer et
              retournera le nombre d'octets écrits.


id: XMLWriter::fullEndElement
type: function
doc:
<comment>Description:</comment>
  Termine l'élément courant
  
  Style orienté objet
  
  Style procédural
  
  Termine l'élément XML courant. Écrit une balise de fin même si l'élément est vide.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::endElement


id: XMLWriter::openMemory
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau xmlwriter en utilisant la mémoire pour l'affichage des chaînes
  
  Style orienté objet
  
  Style procédural
  
  Crée un nouvel objet <class>XMLWriter</class>,  en utilisant la mémoire pour l'affichage des chaînes.

<comment>Return:</comment>
  <info>bool</info>  Style orienté objet : Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur
        survient.
        
        Style procédural : Retourne une nouvelle instance de <class>XMLWriter</class> pour une utilisation future
        avec les fonctions xmlwriter en cas de succès,  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * XMLWriter::openUri


id: XMLWriter::openUri
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau xmlwriter, en utilisant l'URI source pour l'affichage
  
  Style orienté objet
  
  Style procédural
  
  Crée un nouveau XMLWriter, en utilisant l'<strong>$uri</strong> pour l'affichage.

<comment>Param:</comment>
  <info>string</info>  <strong>$uri</strong>  L'URI de la ressource pour l'affichage.

<comment>Return:</comment>
  <info>bool</info>  Style orienté objet : Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur
        survient.
        
        Style procédural : Retourne une nouvelle instance de <class>XMLWriter</class> pour une utilisation future
        avec les fonctions xmlwriter en cas de succès,  ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * XMLWriter::openMemory


id: XMLWriter::outputMemory
type: function
doc:
<comment>Description:</comment>
  Retourne le buffer courant
  
  Style orienté objet
  
  Style procédural
  
  Retourne le buffer courant.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>       <strong>$flush</strong>   Si l'on doit afficher le buffer ou non. Par défaut, ce paramètre vaut <info>true</info>.

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

<comment>See Also:</comment>
   * XMLWriter::flush


id: XMLWriter::setIndent
type: function
doc:
<comment>Description:</comment>
  Active ou non l'indentation
  
  Style orienté objet
  
  Style procédural
  
  Active ou non l'indentation.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</strong>.
  <info>bool</info>       <strong>$enable</strong>  Si l'on doit activer l'indentation ou non.

<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>
   * XMLWriter::setIndentString


id: XMLWriter::setIndentString
type: function
doc:
<comment>Description:</comment>
  Définit la chaîne à utiliser pour l'indentation
  
  Style orienté objet
  
  Style procédural
  
  Définit la chaîne qui sera utilisée pour indenter chaque élément/attribut d'un document XML.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>       Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                           modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                           <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$indentation</strong>  La chaîne pour l'indentation.

<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>
   * XMLWriter::setIndent


id: XMLWriter::startAttribute
type: function
doc:
<comment>Description:</comment>
  Crée un attribut
  
  Style orienté objet
  
  Style procédural
  
  Commence un attribut.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    Le nom de l'attribut.

<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>
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::startAttributeNs
type: function
doc:
<comment>Description:</comment>
  Crée un attribut pour l'espace de noms
  
  Style orienté objet
  
  Style procédural
  
  Crée un attribut pour l'espace de noms.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                           modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                           <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$prefix</strong>     Le préfixe pour l'espace de noms.
  <info>string</info>       <strong>$name</strong>       Le nom de l'attribut.
  <info>string|null</info>  <strong>$namespace</strong>  L'URI de l'espace de noms. Si le <strong>$namespace</strong> vaut <info>null</info>, la déclaration de
                           l'espace de noms sera omise.

<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>
   * XMLWriter::startAttribute
   * XMLWriter::endAttribute
   * XMLWriter::writeAttribute
   * XMLWriter::writeAttributeNs


id: XMLWriter::startCdata
type: function
doc:
<comment>Description:</comment>
  Crée une balise CDATA
  
  Style orienté objet
  
  Style procédural
  
  Commence un bloc CDATA.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::endCdata
   * XMLWriter::writeCdata


id: XMLWriter::startComment
type: function
doc:
<comment>Description:</comment>
  Crée un commentaire
  
  Style orienté objet
  
  Style procédural
  
  Commence un commentaire.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</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>
   * XMLWriter::endComment
   * XMLWriter::writeComment


id: XMLWriter::startDocument
type: function
doc:
<comment>Description:</comment>
  Crée un document
  
  Style orienté objet
  
  Style procédural
  
  Commence un document.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>      Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                            modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                            <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$version</strong>     Le numéro de version du document dans la déclaration XML.
  <info>string|null</info>  <strong>$encoding</strong>    L'encodage du document dans la déclaration XML.
  <info>string|null</info>  <strong>$standalone</strong>  <return>yes</return> ou <return>no</return>.

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

<comment>See Also:</comment>
   * XMLWriter::endDocument


id: XMLWriter::startDtd
type: function
doc:
<comment>Description:</comment>
  Crée une DTD
  
  Style orienté objet
  
  Style procédural
  
  Commence une DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>         Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                               modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                               <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>       <strong>$qualifiedName</strong>  Le nom qualifié du type de document à créer.
  <info>string|null</info>  <strong>$publicId</strong>       L'identifiant publique externe.
  <info>string|null</info>  <strong>$systemId</strong>       L'identifiant système externe.

<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>
   * XMLWriter::endDtd
   * XMLWriter::writeDtd


id: XMLWriter::startDtdAttlist
type: function
doc:
<comment>Description:</comment>
  Crée une liste d'attributs pour la DTD
  
  Style orienté objet
  
  Style procédural
  
  Crée une liste d'attributs pour la DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    Le nom de la liste d'attributs.

<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>
   * XMLWriter::endDtdAttlist
   * XMLWriter::writeDtdAttlist


id: XMLWriter::startDtdElement
type: function
doc:
<comment>Description:</comment>
  Crée un élément DTD
  
  Style orienté objet
  
  Style procédural
  
  Commence un élément DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>         Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                             modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                             <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$qualifiedName</strong>  Le nom qualifié du type de document à créer.

<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>
   * XMLWriter::endDtdElement
   * XMLWriter::writeDtdElement


id: XMLWriter::startDtdEntity
type: function
doc:
<comment>Description:</comment>
  Crée une entité DTD
  
  Style orienté objet
  
  Style procédural
  
  Commence une entité DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                       modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                       <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>     Le nom de l'entité.
  <info>bool</info>       <strong>$isParam</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>
   * XMLWriter::endDtdEntity
   * XMLWriter::writeDtdEntity


id: XMLWriter::startElement
type: function
doc:
<comment>Description:</comment>
  Crée un élément
  
  Style orienté objet
  
  Style procédural
  
  Commence un élément.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    Le nom de l'élément.

<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>
   * XMLWriter::endElement
   * XMLWriter::writeElement


id: XMLWriter::startElementNs
type: function
doc:
<comment>Description:</comment>
  Crée un élément d'un espace de noms
  
  Style orienté objet
  
  Style procédural
  
  Crée un élément d'un espace de noms.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                           modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                           <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$prefix</strong>     Le préfixe de l'espace de noms. Si le paramètre <strong>$prefix</strong> vaut <info>null</info>,
                           l'espace de noms sera omis.
  <info>string</info>       <strong>$name</strong>       Le nom de l'élément.
  <info>string|null</info>  <strong>$namespace</strong>  L'URI de l'espace de noms. Si le <strong>$namespace</strong> vaut <info>null</info>, la déclaration de
                           l'espace de noms sera omise.

<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>
   * XMLWriter::endElement
   * XMLWriter::writeElementNs


id: XMLWriter::startPi
type: function
doc:
<comment>Description:</comment>
  Crée une balise PI
  
  Style orienté objet
  
  Style procédural
  
  Commence une balise d'instruction.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$target</strong>  La cible de l'instruction.

<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>
   * XMLWriter::endPi
   * XMLWriter::writePi


id: XMLWriter::text
type: function
doc:
<comment>Description:</comment>
  Écrit du texte
  
  Style orienté objet
  
  Style procédural
  
  Écrit du texte.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                       modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                       <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$content</strong>  Le contenu du texte. Les caractères <return>\<</return>, <return>&gt;</return>, <return>&</return> et <return>"</return> sont écrit en tant que références d'entités (c.à.d. , ,  et , respectivement). Tous les autres caractères <return>'</return> inclus sont écrit littéralement. Pour écrire les caractères XML spéciaux littéralement, ou pour écrire des références d'entités litérales, <strong>xmlwriter_write_raw()</strong> doit ê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.


id: XMLWriter::writeAttribute
type: function
doc:
<comment>Description:</comment>
  Écrit un attribut
  
  Style orienté objet
  
  Style procédural
  
  Écrit un attribut.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>  Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est modifiée.
                      Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                      <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>    Le nom de l'attribut.
  <info>string</info>     <strong>$value</strong>   La valeur de l'attribut.

<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>
   * XMLWriter::writeAttributeNs
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute


id: XMLWriter::writeAttributeNs
type: function
doc:
<comment>Description:</comment>
  Écrit un attribut d'un espace de noms
  
  Style orienté objet
  
  Style procédural
  
  Écrit un attribut d'un espace de noms.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>     Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                           modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                           <strong>xmlwriter_open_memory()</strong>.
  <info>string|null</info>  <strong>$prefix</strong>     Le préfixe de l'espace de noms. Si le paramètre <strong>$prefix</strong> vaut <info>null</info>,
                           l'espace de noms sera omis.
  <info>string</info>       <strong>$name</strong>       Le nom de l'attribut.
  <info>string|null</info>  <strong>$namespace</strong>  L'URI de l'espace de noms. Si le <strong>$namespace</strong> vaut <info>null</info>, la déclaration de
                           l'espace de noms sera omise.
  <info>string</info>       <strong>$value</strong>      La valeur de l'attribut.

<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>
   * XMLWriter::writeAttribute
   * XMLWriter::startAttribute
   * XMLWriter::startAttributeNs
   * XMLWriter::endAttribute


id: XMLWriter::writeCdata
type: function
doc:
<comment>Description:</comment>
  Écrit un bloc CDATA
  
  Style orienté objet
  
  Style procédural
  
  Écrit un bloc CDATA.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                       modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                       <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$content</strong>  Le contenu du bloc CDATA.

<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>
   * XMLWriter::startCdata
   * XMLWriter::endCdata


id: XMLWriter::writeComment
type: function
doc:
<comment>Description:</comment>
  Écrit un commentaire
  
  Style orienté objet
  
  Style procédural
  
  Écrit un commentaire.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                       modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                       <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$content</strong>  Le contenu du commentaire.

<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>
   * XMLWriter::startComment
   * XMLWriter::endComment


id: XMLWriter::writeDtd
type: function
doc:
<comment>Description:</comment>
  Écrit une DTD
  
  Style orienté objet
  
  Style procédural
  
  Écrit une DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>    <strong>$writer</strong>    Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                          modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                          <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>       <strong>$name</strong>      Le nom de la DTD.
  <info>string|null</info>  <strong>$publicId</strong>  L'identifiant publique externe.
  <info>string|null</info>  <strong>$systemId</strong>  L'identifiant système externe.
  <info>string|null</info>  <strong>$content</strong>   Le contenu de la DTD.

<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>
   * XMLWriter::startDtd
   * XMLWriter::endDtd


id: XMLWriter::writeDtdAttlist
type: function
doc:
<comment>Description:</comment>
  Écrit une liste d'attributs DTD
  
  Style orienté objet
  
  Style procédural
  
  Écrit une liste d'attribut DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                       modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                       <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>     Le nom de la liste d'attributs DTD.
  <info>string</info>     <strong>$content</strong>  Le contenu de la liste d'attributs DTD.

<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>
   * XMLWriter::startDtdAttlist
   * XMLWriter::endDtdAttlist


id: XMLWriter::writeDtdElement
type: function
doc:
<comment>Description:</comment>
  Écrit un élément DTD
  
  Style orienté objet
  
  Style procédural
  
  Écrit un élément DTD.

<comment>Param:</comment>
  <info>XMLWriter</info>  <strong>$writer</strong>   Uniquement pour les appels procéduraux. L'instance <class>XMLWriter</class> qui est
                       modifiée. Cet objet provient d'un appel à <strong>xmlwriter_open_uri()</strong> ou
                       <strong>xmlwriter_open_memory()</strong>.
  <info>string</info>     <strong>$name</strong>     Le nom de l'élément DTD.
  <info>string</info>     <strong>$content</strong>  Le contenu de l'élément.

<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>
   * XMLWriter::startDtdElement
   * XMLWriter::endDtdElement


