# php_manual

id: AL_CONE_INNER_ANGLE
type: constant
doc:
<comment>Description:</comment>
  Configuration de la source/de l'écoute (Nombre à virgule flottante)


id: AL_DIRECTION
type: constant
doc:
<comment>Description:</comment>
  Configuration de la source/de l'écoute (Nombre vectoriel à virgule flottante)


id: APCUIterator
type: class
doc:
<comment>Description:</comment>
  La classe <class>APCUIterator</class> facilite le parcours des   caches APCu de grandes tailles. Cela est utile
  car il permet de les parcourir par étapes, tout en récupérant un nombre défini d'entrées par
  instance de  verrouillage. Ainsi cela libère les verrous de cache pour d'autres activités au lieu
  de bloquer tout le cache pour récupérer 100 entrées (par défaut).  D'autre part, le filtrage par
  expressions régulières est plus efficace  car leur manipulation a été déplacée au niveau du C.


id: APCUIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un objet itérateur de la classe APCUIterator
  
  Construit un <info>objet</info> de la classe <class>APCUIterator</class>.

<comment>Param:</comment>
  <info>array|string|null</info>  <strong>$search</strong>      Soit une expression régulière PCRE qui filtre le nom des clés
                                  APCu, donnée sous la forme d'une chaîne de caractères. Soit un
                                  tableau de chaîne de caractères contenant des noms de clés APCu.
                                  Ou, bien éventuellement, la valeur <info>null</info>, pour sauter l'étape de
                                  recherche.
  <info>int</info>                <strong>$format</strong>      Le format souhaité, configuré avec une ou plusieurs des constantes
                                  prédéfinies APC_ITER_*.
  <info>int</info>                <strong>$chunk_size</strong>  La taille d'un tronçon. La valeur de ce paramètre doit être plus
                                  grand que 0. La valeur par défaut est 100.
  <info>int</info>                <strong>$list</strong>        Le type de liste. Le paramètre peut prendre soit la valeur
                                  <info>APC_LIST_ACTIVE</info> ou bien la valeur <info>APC_LIST_DELETED</info>.

<comment>See Also:</comment>
   * <strong>apcu_exists()</strong>
   * <strong>apcu_cache_info()</strong>


id: APCUIterator::current
type: function
doc:
<comment>Description:</comment>
  Retourne l'élément courant
  
  Retourne l'élément courant de la liste de <class>APCUIterator</class>.

<comment>Return:</comment>
  <info>mixed</info>  Retourne l'élément courant en cas de succès ou bien la valeur <info>false</info> si l'un des  trois cas
         suivants se produit: le pointeur a dépassé le dernier élément, il n'y  a pas d'élément dans
         la liste ou la fonction a échouée.

<comment>See Also:</comment>
   * APCUIterator::next
   * Iterator::current


id: APCUIterator::getTotalCount
type: function
doc:
<comment>Description:</comment>
  Retourne le compte total
  
  Retourne le compte total.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int</info>  Le compte total.

<comment>See Also:</comment>
   * APCUIterator::getTotalHits
   * APCUIterator::getTotalSize
   * <strong>apcu_cache_info()</strong>


id: APCUIterator::getTotalHits
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre total d'accès au cache
  
  Retourne le nombre total d'accès au cache.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre total d'accès au cache en cas de succès ou <info>false</info> en cas d'échec.

<comment>See Also:</comment>
   * APCUIterator::getTotalCount
   * APCUIterator::getTotalSize
   * <strong>apcu_cache_info()</strong>


id: APCUIterator::getTotalSize
type: function
doc:
<comment>Description:</comment>
  Retourne la taille totale du cache
  
  Retourne la taille totale du cache.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int</info>  La taille totale du cache.

<comment>See Also:</comment>
   * APCUIterator::getTotalCount
   * APCUIterator::getTotalHits
   * <strong>apc_cache_info()</strong>


id: APCUIterator::key
type: function
doc:
<comment>Description:</comment>
  Retourne la clé de l'élément courant
  
  Retourne la clé de l'élément courant.

<comment>Return:</comment>
  <info>string</info>  Retourne la clé en cas de succès ou <info>false</info> en cas d'échec.

<comment>See Also:</comment>
   * APCUIterator::current
   * Iterator::key


id: APCUIterator::next
type: function
doc:
<comment>Description:</comment>
  Déplace le pointeur sur l'élément suivant
  
  Déplace le pointeur de l'itérateur sur l'élément suivant.

<comment>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>
   * APCUIterator::current
   * APCUIterator::rewind
   * Iterator::next


id: APCUIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Replace l'itérateur sur le premier élément
  
  Replace l'itérateur sur le premier élément.

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

<comment>See Also:</comment>
   * APCUIterator::next
   * Iterator::next


id: APCUIterator::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si la position courante est valide
  
  Vérifie si la position courante de l'itérateur est valide.

<comment>Return:</comment>
  <info>bool</info>  Retourne la valeur <info>true</info> si la position courante de l'itérateur est valide, sinon retourne
        <info>false</info>.

<comment>See Also:</comment>
   * APCUIterator::current
   * Iterator::valid


id: ARRAY_FILTER_USE_BOTH
type: constant
doc:
<comment>Description:</comment>
  <info>ARRAY_FILTER_USE_BOTH</info> est utilisé avec <strong>array_filter()</strong> pour passer la valeur et la clé à la
  fonction de rappel fournie.


id: ARRAY_FILTER_USE_KEY
type: constant
doc:
<comment>Description:</comment>
  <info>ARRAY_FILTER_USE_KEY</info> est utilisé avec <strong>array_filter()</strong> pour passer chaque clé comme premier argument
  à la fonction de rappel fournie.


id: ASSERT_ACTIVE
type: constant
doc:
<comment>Description:</comment>
  assert.active
  
  Active l'évaluation <strong>assert()</strong>.  Cette fonctionnalité est OBSOLÈTE à partir de PHP 8.3.0.  Dépendre
  de cette fonctionnalité est fortement déconseillé.
  


id: ASSERT_BAIL
type: constant
doc:
<comment>Description:</comment>
  assert.bail
  
  Termine l'exécution des assertions échouées.  Cette fonctionnalité est OBSOLÈTE à partir de PHP
  8.3.0.  Dépendre de cette fonctionnalité est fortement déconseillé.
  


id: ASSERT_CALLBACK
type: constant
doc:
<comment>Description:</comment>
  assert.callback
  
  Fonction de rappel des assertions échouées.  Cette fonctionnalité est OBSOLÈTE à partir de PHP
  8.3.0.  Dépendre de cette fonctionnalité est fortement déconseillé.
  


id: ASSERT_EXCEPTION
type: constant
doc:
<comment>Description:</comment>
  assert.exception
  
  Émet une exception PHP pour chaque assertion échouée.  Cette fonctionnalité est OBSOLÈTE à partir
  de PHP 8.3.0.  Dépendre de cette fonctionnalité est fortement déconseillé.
  


id: ASSERT_QUIET_EVAL
type: constant
doc:
<comment>Description:</comment>
  assert.quiet_eval
  
  Désactive le <return>error_reporting</return> durant l'évaluation des expressions d'assertion. Cette fonctionnalité
  a été SUPPRIMÉE à partir de PHP 8.0.0.


id: ASSERT_WARNING
type: constant
doc:
<comment>Description:</comment>
  assert.warning
  
  Émet une alerte PHP pour chaque assertion échouée.  Cette fonctionnalité est OBSOLÈTE à partir de
  PHP 8.3.0.  Dépendre de cette fonctionnalité est fortement déconseillé.
  


id: AddressInfo
type: class
doc:
<comment>Description:</comment>
  Une classe entièrement opaque qui remplace les ressources <return>AddressInfo</return>  à partir de PHP 8.0.0.


id: AllowDynamicProperties
type: class
doc:
<comment>Description:</comment>
  Cet attribut est utilisé pour marquer les classes qui autorisent les propriétés dynamiques.


id: AllowDynamicProperties::__construct
type: function
doc:
<comment>Description:</comment>
  Construit une nouvelle instance d'attribut AllowDynamicProperties
  
  Construit une nouvelle instance de <class>AllowDynamicProperties</class>.


id: AppendIterator
type: class
doc:
<comment>Description:</comment>
  Un itérateur qui itère sur plusieurs itérateurs les uns après les autres.


id: AppendIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un objet AppendIterator
  
  Construit un objet <class>AppendIterator</class>.

<comment>See Also:</comment>
   * AppendIterator::append


id: AppendIterator::append
type: function
doc:
<comment>Description:</comment>
  Ajoute un itérateur à la fin
  
  Ajoute un itérateur à la fin.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  L'itérateur à ajouter.

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

<comment>See Also:</comment>
   * AppendIterator::__construct


id: AppendIterator::current
type: function
doc:
<comment>Description:</comment>
  Lit la valeur courante
  
  Lit la valeur courante.

<comment>Return:</comment>
  <info>mixed</info>  La valeur courante si elle est valide, et <info>null</info> sinon.

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


id: AppendIterator::getArrayIterator
type: function
doc:
<comment>Description:</comment>
  Récupère le ArrayIterator
  
  Cette méthode récupère l'intance de la classe <class>ArrayIterator</class> qui est utilisé pour stocker les
  itérateurs ajoutés avec la méthode AppendIterator::append.

<comment>Return:</comment>
  <info>ArrayIterator</info>  Retourne un <class>ArrayIterator</class> contenant les itérateurs ajoutés.

<comment>See Also:</comment>
   * AppendIterator::getInnerIterator


id: AppendIterator::getIteratorIndex
type: function
doc:
<comment>Description:</comment>
  Lit l'index d'un itérateur
  
  Lit l'index de l'itérateur courant interne.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int|null</info>  Retourne l'index entier, partant de 0, de l'itérateur interne s'il existe, <info>null</info> sinon.

<comment>See Also:</comment>
   * AppendIterator::getInnerIterator
   * AppendIterator::getArrayIterator


id: AppendIterator::key
type: function
doc:
<comment>Description:</comment>
  Lit la clé courante
  
  Lit la clé courante.

<comment>Return:</comment>
  <info>scalar</info>  La clé courante si c'est possible, et <info>null</info> sinon.

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


id: AppendIterator::next
type: function
doc:
<comment>Description:</comment>
  Passe à l'élément suivant
  
  Passe à l'élément suivant. Si le prochain élément est un  autre itérateur, alors il remet cet
  itérateur à zéro.

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

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


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

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

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


id: AppendIterator::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie la validité de l'élément courant
  
  Vérifie la validité de l'élément courant.

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

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


id: ArrayAccess
type: class
doc:
<comment>Description:</comment>
  Interface permettant d'accéder aux objets de la même façon que pour les tableaux.


id: ArrayAccess::offsetExists
type: function
doc:
<comment>Description:</comment>
  Indique si une position existe dans un tableau
  
  Indique si une position existe.
  
  Cette méthode est exécutée lorsque la fonction <strong>isset()</strong> ou <strong>empty()</strong> est appliquée à un objet qui
  implémente  l'interface <class>ArrayAccess</class>.
  
  Lors de l'utilisation de <strong>empty()</strong>, <strong>ArrayAccess::offsetGet()</strong> est appelé et vérifie si  la valeur est
  vide, uniquement si <strong>ArrayAccess::offsetExists()</strong> retourne <info>true</info>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  Une position à vérifier.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient.
        
        La valeur retournée sera transtypée en booléen si une valeur non booléenne  est retournée.


id: ArrayAccess::offsetGet
type: function
doc:
<comment>Description:</comment>
  Position à lire
  
  Retourne la valeur à la position donnée.
  
  Cette méthode est exécutée lorsque l'on vérifie si une position est <strong>empty()</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  La position à lire.

<comment>Return:</comment>
  <info>mixed</info>  Peut retourner n'importe quel type de valeur.

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


id: ArrayAccess::offsetSet
type: function
doc:
<comment>Description:</comment>
  Assigne une valeur à une position donnée
  
  Assigne une valeur à une position donnée.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  La position à laquelle assigner une valeur.
  <info>mixed</info>  <strong>$value</strong>   La valeur à assigner.

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


id: ArrayAccess::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Supprime un élément à une position donnée
  
  Supprime un élément à une position donnée.
  
  Cette méthode ne sera pas appelée lors du transtypage en (unset).

<comment>Param:</comment>
  <info>mixed</info>  <strong>$offset</strong>  La position à supprimer.

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


id: ArrayIterator
type: class
doc:
<comment>Description:</comment>
  Permet la suppression d'éléments, et la modification de clés ou valeurs lors de l'itération de
  tableaux ou d'objets
  
  Lorsque vous voulez passer en revue le même tableau plusieurs fois, vous devez instancier
  <class>ArrayObject</class> et le laisser créer les objets <class>ArrayIterator</class> qui s'y réfèrent, soit en utilisant
  l'instruction foreach, soit en appelant la méthode <strong>getIterator()</strong>  manuellement.


id: ArrayIterator::ARRAY_AS_PROPS
type: constant
doc:
<comment>Description:</comment>
  Les entrées peuvent être accédé comme des propriétés (lecture et écriture).


id: ArrayIterator::STD_PROP_LIST
type: constant
doc:
<comment>Description:</comment>
  Les propriétés de l'object conservent leurs fonctionnalités normales lorsqu'ils sont accédés en
  tant que liste (var_dump, foreach, etc.).


id: ArrayIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un ArrayIterator
  
  Construit un objet <class>ArrayIterator</class>.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  Le tableau ou l'objet à itérer.
  <info>int</info>           <strong>$flags</strong>  Drapeaux permettant de contrôler le comportement de l'objet <class>ArrayIterator</class>.
                        Voir la documentation de la méthode ArrayIterator::setFlags.

<comment>See Also:</comment>
   * ArrayIterator::getArrayCopy


id: ArrayIterator::append
type: function
doc:
<comment>Description:</comment>
  Ajoute un élément
  
  Ajoute une valeur comme dernier élément.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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

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

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


id: ArrayIterator::asort
type: function
doc:
<comment>Description:</comment>
  Trie les entrées par les valeurs
  
  Trie les entrées par les valeurs.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

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

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

<comment>See Also:</comment>
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>asort()</strong>


id: ArrayIterator::count
type: function
doc:
<comment>Description:</comment>
  Compte les éléments
  
  Récupère le nombre d'éléments d'un tableau ou le nombre de propriétés publiques d'un objet..
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int</info>  Le nombre d'éléments ou d'attributs publics du <info>array</info> associatif ou de l'<info>object</info>,
       respectivement.

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


id: ArrayIterator::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>  L'entrée courante du tableau.


id: ArrayIterator::getArrayCopy
type: function
doc:
<comment>Description:</comment>
  Récupère la copie d'un tableau
  
  Récupère la copie d'un tableau.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>array</info>  Une copie d'un tableau, ou un tableau de propriétés publiques si ArrayIterator se réfère à
         un objet.

<comment>See Also:</comment>
   * ArrayIterator::valid


id: ArrayIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  Récupère les drapaux de comportement
  
  Récupère les drapaux de comportement de <class>ArrayIterator</class>. Voir la méthode ArrayIterator::setFlags
  pour une liste des drapeaux disponible.

<comment>Return:</comment>
  <info>int</info>  Retourne les drapeaux de comportement de ArrayIterator.

<comment>See Also:</comment>
   * ArrayIterator::setFlags
   * ArrayIterator::valid


id: ArrayIterator::key
type: function
doc:
<comment>Description:</comment>
  Retourne la clé courante du tableau
  
  Retourne la clé courante du tableau.

<comment>Return:</comment>
  <info>string|int|null</info>  La clé courante du tableau.


id: ArrayIterator::ksort
type: function
doc:
<comment>Description:</comment>
  Trie les entrées par les clés
  
  Trie les entrées par les clés.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

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

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>ksort()</strong>


id: ArrayIterator::natcasesort
type: function
doc:
<comment>Description:</comment>
  Trie naturellement les entrées, en ne tenant pas compte de la casse
  
  Trie les entrées par les valeurs, en utilisant un algorithme insensible à la casse d'ordre
  naturel.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>natcasesort()</strong>


id: ArrayIterator::natsort
type: function
doc:
<comment>Description:</comment>
  Trie naturellement les entrées
  
  Trie les entrées par les valeurs, en utilisant l'algorithme d'ordre naturel.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natsort
   * ArrayIterator::uasort
   * ArrayIterator::uksort
   * <strong>natsort()</strong>


id: ArrayIterator::next
type: function
doc:
<comment>Description:</comment>
  Se déplace vers la prochaine entrée
  
  Se déplace vers la prochaine entrée.

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


id: ArrayIterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  Vérifie si une position existe
  
  Vérifie si une position existe.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  La position à vérifier.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si la position existe, <info>false</info> sinon.

<comment>See Also:</comment>
   * ArrayIterator::valid


id: ArrayIterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  Récupère la valeur pour une position
  
  Récupère la valeur pour une position donnée.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  La position dont on doit récupérer la valeur.

<comment>Return:</comment>
  <info>mixed</info>  La valeur à la position <strong>$key</strong>.

<comment>See Also:</comment>
   * ArrayIterator::offsetSet
   * ArrayIterator::offsetUnSet


id: ArrayIterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  Définit la valeur d'une position
  
  Définit la valeur pour une position donnée.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>    L'index à définir.
  <info>mixed</info>  <strong>$value</strong>  La nouvelle valeur à stocker à l'index donné.

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

<comment>See Also:</comment>
   * ArrayIterator::offsetGet
   * ArrayIterator::offsetUnset


id: ArrayIterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Efface la valeur d'une position
  
  Efface la valeur d'une position.
  
  Si une itération est en cours, et que ArrayIterator::offsetUnset est utilisé pour unset l'index
  actuel de l'itération, la position de l'itération sera avancé au prochain index. Comme la position
  de l'itération est aussi avancée à la fin de la déclaration de boucle foreach, l'utilisation de
  ArrayIterator::offsetUnset à l'intérieur d'une boucle <return>foreach</return> peut résulter en des index qui
  seront omit.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  La position à effacer.

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

<comment>See Also:</comment>
   * ArrayIterator::offsetGet
   * ArrayIterator::offsetSet


id: ArrayIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Revient à la position initiale
  
  Revient à la position initiale.

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


id: ArrayIterator::seek
type: function
doc:
<comment>Description:</comment>
  Avance à une position donnée
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  La position désirée.

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


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

<comment>Return:</comment>
  <info>string</info>  Un <class>ArrayIterator</class>, Sérialisé.

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


id: ArrayIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  Définie les drapeaux de comportements
  
  Définit les drapaux qui modifie le comportement de ArrayIterator.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Le nouveau comportement de ArrayIterator. Il prend soit un bit-masque, soit des
               constantes nommés. Utiliser une constante nommé est vivement encouragé pour assurer
               une compabilité avec des futures versions.
               
               Les drapaux de comportement disponible sont énumérés ci-dessous. Le comportement réel
               de ces drapaux est décrit dans les constantes prédéfinies  predefined constants. Les
               drapaux de comportement
               ArrayIteratorvalueconstant1ArrayIterator::STD_PROP_LIST2ArrayIterator::ARRAY_AS_PROPS

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

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


id: ArrayIterator::uasort
type: function
doc:
<comment>Description:</comment>
  Trier avec une fonction de comparaison définie par l'utilisateur et maintient l'association de
  l'index
  
  Cette méthode trie les éléments de telle sorte que les indices maintiennent  leur corrélation avec
  les valeurs auxquelles ils sont associés, à l'aide d'une  fonction de comparaison définie par
  l'utilisateur.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  La fonction de comparaison doit retourner un entier inférieur à, égal à, ou
                       supérieur
                       à 0 si le premier argument est considéré comme, respectivement, inférieur à,
                       égal à, ou supérieur au second.
                       
                       Retourner des valeurs non-entières à partir de la fonction
                       de comparaison, telles que <info>float</info>, entraînera une conversion interne
                       de la valeur de retour du rappel en <info>int</info>. Ainsi, des valeurs telles que
                       <return>0.99</return> et <return>0.1</return> seront toutes deux converties en une
                       valeur entière de <return>0</return>, ce qui comparera de telles valeurs comme égales.

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uksort
   * <strong>uasort()</strong>


id: ArrayIterator::uksort
type: function
doc:
<comment>Description:</comment>
  Trier par clés à l'aide d'une fonction de comparaison définie par l'utilisateur
  
  Cette méthode trie les éléments par des clés à l'aide d'une fonction de comparaison fournie par
  l'utilisateur.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  La fonction de comparaison doit retourner un entier inférieur à, égal à, ou
                       supérieur
                       à 0 si le premier argument est considéré comme, respectivement, inférieur à,
                       égal à, ou supérieur au second.
                       
                       Retourner des valeurs non-entières à partir de la fonction
                       de comparaison, telles que <info>float</info>, entraînera une conversion interne
                       de la valeur de retour du rappel en <info>int</info>. Ainsi, des valeurs telles que
                       <return>0.99</return> et <return>0.1</return> seront toutes deux converties en une
                       valeur entière de <return>0</return>, ce qui comparera de telles valeurs comme égales.

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

<comment>See Also:</comment>
   * ArrayIterator::asort
   * ArrayIterator::ksort
   * ArrayIterator::natcasesort
   * ArrayIterator::natsort
   * ArrayIterator::uksort
   * <strong>uksort()</strong>


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

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  L'objet ArrayIterator sérialisé.

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

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


id: ArrayIterator::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si un tableau contient d'autres entrées
  
  Vérifie si un tableau contient d'autres entrées.

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


id: ArrayObject
type: class
doc:
<comment>Description:</comment>
  Cette classe permet aux objets de fonctionner comme des tableaux.


id: ArrayObject::ARRAY_AS_PROPS
type: constant
doc:
<comment>Description:</comment>
  Les éléments peuvent être accédé comme des propriétés (lecture et écriture). La classe <class>ArrayObject</class>
  utilise so propre logique pour accéder aux propriétés, ainsi aucun avertissement ou erreur est
  émise lors d'une tentative de lecture ou écriture de propriétés dynamique.


id: ArrayObject::STD_PROP_LIST
type: constant
doc:
<comment>Description:</comment>
  Les propriétés de l'objet ont leur fonctionnement normal lorsqu'on y accède depuis la liste
  (<strong>var_dump()</strong>, foreach, etc.).


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

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>          Le paramètre <strong>$array</strong> accepte un tableau ou un autre objet.
  <info>int</info>           <strong>$flags</strong>          Option de contrôle du comportement de  l'objet <class>ArrayObject</class>. Voir la
                                méthode ArrayObject::setFlags.
  <info>string</info>        <strong>$iteratorClass</strong>  Spécifie la classe qui sera utilisée pour les itérations de l'objet
                                <class>ArrayObject</class>. La classe doit implémenter ArrayIterator.

<comment>See Also:</comment>
   * ArrayObject::setflags


id: ArrayObject::append
type: function
doc:
<comment>Description:</comment>
  Ajoute la valeur à la fin d'un tableau
  
  Ajoute un élément en dernier dans le tableau.
  
  Cette méthode ne peut pas être appelée lorsque l'objet <class>ArrayObject</class> a été construit à partir d'un
  autre objet. Utilisez alors la méthode ArrayObject::offsetSet.

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

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

<comment>See Also:</comment>
   * ArrayObject::offsetSet


id: ArrayObject::asort
type: function
doc:
<comment>Description:</comment>
  Trie les éléments par valeur
  
  Trie les entrées en ordre croissant, de telle manière que la corrélation entre les clés et les
  valeurs soit conservée.
  
  L'usage principal est lors de tri de tableaux associatifs où l'ordre des éléments est important.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

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

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

<comment>See Also:</comment>
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>asort()</strong>


id: ArrayObject::count
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de propriétés publiques dans l'objet ArrayObject
  
  Lit le nombre de propriétés publiques dans l'objet  <class>ArrayObject</class>

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de propriétés publiques dans l'objet  <class>ArrayObject</class>.
       
       Lorsque l'objet <class>ArrayObject</class> est construit à partir d'un tableau, toutes les propriétés sont
       publiques.


id: ArrayObject::exchangeArray
type: function
doc:
<comment>Description:</comment>
  Remplace un tableau par un autre
  
  Remplace le tableau courant par un autre tableau ou un objet.

<comment>Param:</comment>
  <info>array|object</info>  <strong>$array</strong>  Le nouveau tableau ou objet à utiliser.

<comment>Return:</comment>
  <info>array</info>  Retourne l'ancien tableau.


id: ArrayObject::getArrayCopy
type: function
doc:
<comment>Description:</comment>
  Crée une copie de l'objet ArrayObject
  
  Exporte l'objet <class>ArrayObject</class> vers un tableau.

<comment>Return:</comment>
  <info>array</info>  Retourne une copie du tableau. Lorsque l'objet  <class>ArrayObject</class> est un objet, le tableau
         retourné contient les propriétés de cet objet.


id: ArrayObject::getFlags
type: function
doc:
<comment>Description:</comment>
  Lit les options de comportement
  
  Lit les options de comportement de l'objet <class>ArrayObject</class>. Voyez la méthode ArrayObject::setFlags
  pour obtenir une liste d'options disponibles.

<comment>Return:</comment>
  <info>int</info>  Retourne les options de comportement de l'objet <class>ArrayObject</class>.

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


id: ArrayObject::getIterator
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel itérateur à partir d'un objet ArrayObject
  
  Crée un nouvel itérateur à partir d'un objet <class>ArrayObject</class>.

<comment>Return:</comment>
  <info>Iterator</info>  Un itérateur depuis un <class>ArrayObject</class>.


id: ArrayObject::getIteratorClass
type: function
doc:
<comment>Description:</comment>
  Lit le nom de la classe de ArrayObject
  
  Lit le nom de la classe utilisé par l'itérateur de tableau utilisé par ArrayObject::getIterator().

<comment>Return:</comment>
  <info>string</info>  Retourne le nom de la classe d'itérateur utilisé par cet objet.

<comment>See Also:</comment>
   * La méthode ArrayObject::setIteratorClass


id: ArrayObject::ksort
type: function
doc:
<comment>Description:</comment>
  Trie un tableau par clé
  
  Trie les éléments par clé, en conservant la relation avec les éléments. C'est le tri classique sur
  les tableaux associatifs.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

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

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>ksort()</strong>


id: ArrayObject::natcasesort
type: function
doc:
<comment>Description:</comment>
  Trie un tableau en utilisant le tri naturel sans la casse
  
  Cette méthode est la version insensible à la casse de  ArrayObject::natsort.
  
  Cette méthode implémente un algorithme de tri qui ordonne les  chaînes alpha-numérique de la même
  façon qu'un humain le ferait. Ceci est décrit comme un tri naturel.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>natcasesort()</strong>


id: ArrayObject::natsort
type: function
doc:
<comment>Description:</comment>
  Trie les éléments avec un tri naturel
  
  Cette méthode implémente un algorithme de tri qui place les chaînes alphanumériques dans le même
  ordre que celui qu'un humain utiliserait, tout en conservant la corrélation entre les clé et les
  valeurs. Ceci porte le nom de tri naturel. Par exemple, le tri naturel se distingue du tri
  informatique, tel qu'utilisé dans  ArrayObject::asort, comme illustré ci-dessous.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * ArrayObject::uksort
   * <strong>natsort()</strong>


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

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

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the requested index exists, otherwise <info>false</info>


id: ArrayObject::offsetGet
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur de l'index spécifié

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>  L'index demandé.

<comment>Return:</comment>
  <info>mixed</info>  La valeur à l'index ou <info>null</info>.


id: ArrayObject::offsetSet
type: function
doc:
<comment>Description:</comment>
  Définie $newval comme valeur à l'$index spécifié
  
  Définit <strong>$value</strong> comme valeur à l'index <strong>$key</strong> spécifié.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$key</strong>    L'index à définir.
  <info>mixed</info>  <strong>$value</strong>  La nouvelle valeur de l'index <strong>$key</strong>.

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

<comment>See Also:</comment>
   * ArrayObject::append


id: ArrayObject::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Efface la valeur à l'$index spécifié
  
  Efface la valeur à l'$index spécifié.

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

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


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

<comment>Return:</comment>
  <info>string</info>  La représentation sérialisée d'un objet <class>ArrayObject</class>.

<comment>See Also:</comment>
   * ArrayObject::unserialize
   * <strong>serialize()</strong>
   * Sérialisation d'objets


id: ArrayObject::setFlags
type: function
doc:
<comment>Description:</comment>
  Configure les options de comportement
  
  Configure les options qui changent le comportement des objets  <class>ArrayObject</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Le nouveau comportement <class>ArrayObject</class>.  Cela peut être un champ de bits ou des
               constantes nommées. L'utilisation des constantes est fortement encouragée, pour
               assurer la compatibilité avec les futures versions.
               
               Les options de comportement disponibles sont listées ci-dessous. Leur  signification
               est décrite dans les  constantes prédéfinies. Options de comportement de
               <class>ArrayObject</class>ValeurConstante1ArrayObject::STD_PROP_LIST2ArrayObject::ARRAY_AS_PROPS

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


id: ArrayObject::setIteratorClass
type: function
doc:
<comment>Description:</comment>
  Définit le nom de la classe de l'itérateur pour l'objet ArrayObject
  
  Définit le nom de la classe de l'itérateur du tableau, utilisé par ArrayObject::getIterator().

<comment>Param:</comment>
  <info>string</info>  <strong>$iteratorClass</strong>  Le nom de la classe de l'itérateur à utiliser pour itérer sur cet objet.

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


id: ArrayObject::uasort
type: function
doc:
<comment>Description:</comment>
  Trie les éléments avec une fonction utilisateur
  
  Cette fonction trie les éléments tout en conservant leur correlation avec la clé associée, en
  utilisant une fonction de comparaison utilisateur.
  
  Cette fonction sert lors du tri de tableaux associatifs, où l'ordre des éléments est important.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  La fonction de comparaison doit retourner un entier inférieur à, égal à, ou
                       supérieur
                       à 0 si le premier argument est considéré comme, respectivement, inférieur à,
                       égal à, ou supérieur au second.
                       
                       Retourner des valeurs non-entières à partir de la fonction
                       de comparaison, telles que <info>float</info>, entraînera une conversion interne
                       de la valeur de retour du rappel en <info>int</info>. Ainsi, des valeurs telles que
                       <return>0.99</return> et <return>0.1</return> seront toutes deux converties en une
                       valeur entière de <return>0</return>, ce qui comparera de telles valeurs comme égales.

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uksort
   * <strong>uasort()</strong>


id: ArrayObject::uksort
type: function
doc:
<comment>Description:</comment>
  Trie les éléments par clé avec une fonction utilisateur
  
  Cette fonction trie les clés des éléments en utilisant une fonction utilisateur de comparaison. La
  correlation entre les clés et les  éléments est conservée.
  
  Si deux membres se comparent comme égaux, ils maintiennent leur ordre original. Antérieur à PHP
  8.0.0, leur ordre relatif dans le tableau trié n'est pas défini.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  La fonction de comparaison doit retourner un entier inférieur à, égal à, ou
                       supérieur
                       à 0 si le premier argument est considéré comme, respectivement, inférieur à,
                       égal à, ou supérieur au second.
                       
                       Retourner des valeurs non-entières à partir de la fonction
                       de comparaison, telles que <info>float</info>, entraînera une conversion interne
                       de la valeur de retour du rappel en <info>int</info>. Ainsi, des valeurs telles que
                       <return>0.99</return> et <return>0.1</return> seront toutes deux converties en une
                       valeur entière de <return>0</return>, ce qui comparera de telles valeurs comme égales.

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

<comment>See Also:</comment>
   * ArrayObject::asort
   * ArrayObject::ksort
   * ArrayObject::natsort
   * ArrayObject::natcasesort
   * ArrayObject::uasort
   * <strong>uksort()</strong>


id: ArrayObject::unserialize
type: function
doc:
<comment>Description:</comment>
  Désérialisation d'un ArrayObject
  
  Désérialise d'un objet <class>ArrayObject</class> sérialisé.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  L'objet <class>ArrayObject</class> sérialisé.

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

<comment>See Also:</comment>
   * ArrayIterator::serialize
   * <strong>unserialize()</strong>
   * Sérialisation d'objets


id: Attribute
type: class
doc:
<comment>Description:</comment>
  Les attributs permettent d'ajouter des informations de métadonnées structurées et lisibles par la
  machine sur les déclarations dans le code: les classes, les méthodes, les fonctions, les
  paramètres, les propriétés et les constantes de classe peuvent être la cible d'un attribut. Les
  métadonnées définies par les attributs peuvent ensuite être inspectées au moment de l'exécution à
  l'aide de l'API de Réflexion. Les attributs peuvent donc être considérés comme un langage de
  configuration intégré directement dans le


id: Attribute::__construct
type: function
doc:
<comment>Description:</comment>
  Construit une nouvelle instance de Attribute
  
  Construit une nouvelle instance de <class>Attribute</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  


id: BackedEnum
type: class
doc:
<comment>Description:</comment>
  L'interface <class>BackedEnum</class> est automatiquement appliquée aux énumérations soutenues 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: BackedEnum::from
type: function
doc:
<comment>Description:</comment>
  Convertit un scalaire en une instance d'enum
  
  La méthode from traduit une <info>string</info> ou un <info>int</info> en un cas Enum correspondant, s'il y en a un. S'il
  n'y a pas de cas correspondant défini, elle lancera une erreur <class>ValueError</class>.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  La valeur scalaire à faire correspondre à un cas d'énumération.

<comment>Return:</comment>
  <info>static</info>  Une instance de cas de cette énumération.

<comment>See Also:</comment>
   * UnitEnum::cases
   * BackedEnum::tryFrom


id: BackedEnum::tryFrom
type: function
doc:
<comment>Description:</comment>
  Associe un scalaire à une instance d'enum ou à null
  
  La méthode tryFrom traduit une <info>string</info> ou un <info>int</info> en cas Enum correspondant, s'il y en a un.  S'il
  n'y a pas de cas correspondant défini, elle retournera null.

<comment>Param:</comment>
  <info>int|string</info>  <strong>$value</strong>  La valeur scalaire à faire correspondre à un cas d'énumération.

<comment>Return:</comment>
  <info>static|null</info>  Une instance de cas de cette énumération, ou <info>null</info> si elle n'a pas été trouvée.

<comment>See Also:</comment>
   * UnitEnum::cases
   * BackedEnum::from


id: BaseResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Fetch warnings from last operation
  
  Fetches warnings generated by MySQL server's last operation.

<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: BaseResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  Fetch warning count from last operation
  
  Returns the number of warnings raised by the last operation. Specifically,  these warnings are
  raised by the MySQL server.

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


id: CAL_DOW_DAYNO
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>jddayofweek()</strong> : le jour de la semaine en tant que <info>int</info>, où <return>0</return> signifie Dimanche et <return>6</return> signifie
  Samedi.


id: CAL_DOW_LONG
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>jddayofweek()</strong> : le nom anglais du jour de la semaine.


id: CAL_DOW_SHORT
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>jddayofweek()</strong> : le nom anglais abrégé du jour de la semaine.


id: CAL_EASTER_ALWAYS_GREGORIAN
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>easter_days()</strong> : calcule Pâques selon le calendrier grégorien proleptique.


id: CAL_EASTER_ALWAYS_JULIAN
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>easter_days()</strong> : calcule Pâques selon le calendrier julien.


id: CAL_EASTER_DEFAULT
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>easter_days()</strong> : calcule Pâques pour les années avant 1753 selon le calendrier julien, et pour
  les années ultérieures selon le calendrier grégorien.


id: CAL_EASTER_ROMAN
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>easter_days()</strong> : calcule Pâques pour les années avant 1583 selon le calendrier julien, et pour
  les années ultérieures selon le calendrier grégorien.


id: CAL_FRENCH
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> et <strong>cal_to_jd()</strong> : utilise le calendrier
  républicain.


id: CAL_GREGORIAN
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> et <strong>cal_to_jd()</strong> : utilise le calendrier
  grégorien proleptique.


id: CAL_JEWISH
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> et <strong>cal_to_jd()</strong> : utilise le calendrier
  hébraïque.


id: CAL_JEWISH_ADD_ALAFIM
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>jdtojewish()</strong> : ajoute le mot alafim en tant que séparateur de milliers au numéro de l'année.


id: CAL_JEWISH_ADD_ALAFIM_GERESH
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>jdtojewish()</strong> : ajoute un symbole geresh (qui ressemble à une apostrophe) en tant que
  séparateur de milliers au numéro de l'année.


id: CAL_JEWISH_ADD_GERESHAYIM
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>jdtojewish()</strong> : ajoute un symbole gershayim (qui ressemble à un guillemet) avant la lettre
  finale des nombre de jour et d'année.


id: CAL_JULIAN
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>cal_days_in_month()</strong>, <strong>cal_from_jd()</strong>, <strong>cal_info()</strong> et <strong>cal_to_jd()</strong> : utilise le calendrier julien.


id: CAL_MONTH_FRENCH
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>jdmonthname()</strong> : le nom de mois républicain.


id: CAL_MONTH_GREGORIAN_SHORT
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>jdmonthname()</strong> : le nom de mois grégorien abrégé.


id: CAL_MONTH_JULIAN_SHORT
type: constant
doc:
<comment>Description:</comment>
  Pour <strong>jdmonthname()</strong> : le nom de mois julien abrégé.


id: CASE_LOWER
type: constant
doc:
<comment>Description:</comment>
  <info>CASE_LOWER</info> est utilisée avec <strong>array_change_key_case()</strong> et sert à convertir tous les index d'un
  tableau en minuscules. C'est aussi le comportement par défaut de <strong>array_change_key_case()</strong>. En ce
  qui concerne PHP 8.2.0, seuls les caractéres ASCII seront convertis.


id: CASE_UPPER
type: constant
doc:
<comment>Description:</comment>
  <info>CASE_UPPER</info> est utilisée avec <strong>array_change_key_case()</strong> et sert à convertir tous les index d'un
  tableau en majuscules. En ce qui concerne PHP 8.2.0, seuls les caractéres ASCII seront convertis.


id: CLSCTX_ALL
type: constant
doc:
<comment>Description:</comment>
  Indique tous les contextes de la classe. Correspond aux constantes <info>CLSCTX_INPROC_HANDLER</info> et
  <info>CLSCTX_SERVER</info>.


id: CLSCTX_INPROC_HANDLER
type: constant
doc:
<comment>Description:</comment>
  Le code qui gère les objets de cette classe est un gestionnaire du processus. C'est une
  bibliothèque DLL qui s'exécute dans le processus client et implémente les structures côté client
  de cette classe lorsque l'on accède à ses instances à distance.


id: CLSCTX_INPROC_SERVER
type: constant
doc:
<comment>Description:</comment>
  Le code qui crée et gère les objets de cette classe est une bibliothèque DLL qui est exécutée dans
  le même processus que l'appelant de la fonction, spécifiant ainsi le contexte de la classe.


id: CLSCTX_LOCAL_SERVER
type: constant
doc:
<comment>Description:</comment>
  Le code d'exécution qui crée et gère les objets de cette classe s'exécute sur la même machine mais
  est chargé dans un espace séparé du processus.


id: CLSCTX_REMOTE_SERVER
type: constant
doc:
<comment>Description:</comment>
  Le contexte distant. Le code qui crée et gère les objets de cette classe s'exécute sur une machine
  différente.


id: CLSCTX_SERVER
type: constant
doc:
<comment>Description:</comment>
  Indique le code serveur, et si le processus est local ou distant. Correspond aux constantes
  <info>CLSCTX_INPROC_SERVER</info>, <info>CLSCTX_LOCAL_SERVER</info> et <info>CLSCTX_REMOTE_SERVER</info>.


id: CL_EXPUNGE
type: constant
doc:
<comment>Description:</comment>
  purger automatiquement la boîte aux lettres lors de l'appel de <strong>imap_close()</strong>


id: COMPersistHelper
type: class
doc:
<comment>Description:</comment>
  <class>COMPersistHelper</class> improves the interoperability of COM and PHP with regard to the php.ini directive
  open_basedir, and stream ressources.


id: COMPersistHelper::GetCurFileName
type: function
doc:
<comment>Description:</comment>
  Get current filename
  
  Retrieves the current name of the file associated with the object.

<comment>Return:</comment>
  <info>string|false</info>  Returns the current name of the file associated with the object.


id: COMPersistHelper::GetMaxStreamSize
type: function
doc:
<comment>Description:</comment>
  Get maximum stream size
  
  Retrieves the size of the stream (in bytes) needed to save the object.

<comment>Return:</comment>
  <info>int</info>  Returns the size of the stream (in bytes) needed to save the object.


id: COMPersistHelper::InitNew
type: function
doc:
<comment>Description:</comment>
  Initialize object to default state
  
  Initializes an object to a default state.

<comment>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: COMPersistHelper::LoadFromFile
type: function
doc:
<comment>Description:</comment>
  Load object from file
  
  Opens the specified file and initializes an object from the file contents.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  The name of the file from which to load the object.
  <info>int</info>     <strong>$flags</strong>     The access mode to be used when opening the file. Possible values are taken
                     from the STGM enumeration. The method can treat this value as a suggestion,
                     adding more restrictive permissions if necessary. If <strong>$flags</strong> is <return>0</return>, the
                     implementation is supposed to open the file using whatever default permissions
                     are used when a user opens the file.

<comment>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: COMPersistHelper::LoadFromStream
type: function
doc:
<comment>Description:</comment>
  Load object from stream
  
  Initializes an object from the stream where it was saved previously.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The stream ressource from which to load the 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.


id: COMPersistHelper::SaveToFile
type: function
doc:
<comment>Description:</comment>
  Save object to file
  
  Saves a copy of the object to the specified file.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  The name of the file to which to save the object.
  <info>bool</info>         <strong>$remember</strong>  Indicates whether the <strong>$filename</strong> parameter is to be used as the current
                          working file. If <info>true</info>, <strong>$filename</strong> becomes the current file and the object
                          is supposed to clear its dirty flag after the save. If <info>false</info>, this save
                          operation is a "Save A Copy As ..." operation. In this case, the current
                          file is unchanged and the object is not supposed to clear its dirty flag.

<comment>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: COMPersistHelper::SaveToStream
type: function
doc:
<comment>Description:</comment>
  Save object to stream
  
  Saves an object to the specified stream.

<comment>Param:</comment>
  <info>resource</info>  <strong>$stream</strong>  The stream ressource to which to save the 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.


id: COMPersistHelper::__construct
type: function
doc:
<comment>Description:</comment>
  Construct a COMPersistHelper object
  
  Constructs a persistence helper object, usually associated with a <strong>$variant</strong>.

<comment>Param:</comment>
  <info>variant|null</info>  <strong>$variant</strong>  A COM object which implements IDispatch. To be able to successfully call
                          any of <class>COMPersistHelper</class>'s methods, the object has to implement
                          IPersistFile, IPersistStream and/or IPersistStreamInit.
                          
                          Passing <info>null</info> as <strong>$variant</strong> is only useful if the object is to be loaded from
                          a stream by calling COMPersistHelper::LoadFromStream.


id: CP_MOVE
type: constant
doc:
<comment>Description:</comment>
  Efface les messages après copie avec  <strong>imap_mail_copy()</strong>


id: CREDITS_ALL
type: constant
doc:
<comment>Description:</comment>
  -1
  
  Tous les crédits. C'est l'équivalent de : <return>CREDITS_DOCS + CREDITS_GENERAL + CREDITS_GROUP +
  CREDITS_MODULES + CREDITS_QA CREDITS_FULLPAGE</return>. Elle génère une page HTML complète et autonome.
  C'est la valeur par défaut.


id: CREDITS_FULLPAGE
type: constant
doc:
<comment>Description:</comment>
  Généralement utilisé combiné avec d'autres options. Cette option indique qu'une page HTML complète
  doit être générée.


id: CREDITS_GENERAL
type: constant
doc:
<comment>Description:</comment>
  Crédits généraux. Design du langage, concepts, auteurs de PHP et module SAPI.


id: CRYPT_BLOWFISH
type: constant
doc:
<comment>Description:</comment>
  Indique si les hachage Blowfish sont supportés dans <strong>crypt()</strong>. Toujours <return>1</return>.


id: CRYPT_EXT_DES
type: constant
doc:
<comment>Description:</comment>
  Indique si les hachage basé sur DES étendu sont supportés dans <strong>crypt()</strong>. Toujours <return>1</return>.


id: CRYPT_MD5
type: constant
doc:
<comment>Description:</comment>
  Indique si les hachage MD5 sont supportés dans <strong>crypt()</strong>. Toujours <return>1</return>.


id: CRYPT_SHA256
type: constant
doc:
<comment>Description:</comment>
  Indique si les hachage SHA-256 sont supportés dans <strong>crypt()</strong>. Toujours <return>1</return>.


id: CRYPT_SHA512
type: constant
doc:
<comment>Description:</comment>
  Indique si les hachage SHA-512 sont supportés dans <strong>crypt()</strong>. Toujours <return>1</return>.


id: CRYPT_STD_DES
type: constant
doc:
<comment>Description:</comment>
  Indique si les hachage basé sur DES standard sont supportés dans <strong>crypt()</strong>. Toujours <return>1</return>.


id: CURLFile
type: class
doc:
<comment>Description:</comment>
  Cette classe ou <class>CURLStringFile</class> doit être utilisé pour transférer un fichier avec des constantes
  <info>CURLOPT_POSTFIELDS</info>.
  
  La désérialisation des instances <class>CURLFile</class> n'est pas permit. À partir de PHP 7.4.0, la
  sérialisation est interdite en premier lieu.


id: CURLFile::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un objet CURLFile
  
  Style orienté objet
  
  Style procédural
  
  Crée un objet <class>CURLFile</class>, utilisé pour télécharger un fichier avec <info>CURLOPT_POSTFIELDS</info>.

<comment>Param:</comment>
  <info>string</info>       <strong>$filename</strong>         Chemin vers le fichier à télécharger.
  <info>string|null</info>  <strong>$mime_type</strong>        Type MIME du fichier.
  <info>string|null</info>  <strong>$posted_filename</strong>  Nom du fichier à utiliser dans les données téléchargées.

<comment>Return:</comment>
  <info>CURLFile</info>  Retourne un objet <class>CURLFile</class>.

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


id: CURLFile::getFilename
type: function
doc:
<comment>Description:</comment>
  Récupère le nom du fichier

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


id: CURLFile::getMimeType
type: function
doc:
<comment>Description:</comment>
  Récupère le type MIME

<comment>Return:</comment>
  <info>string</info>  Retourne le type MIME.


id: CURLFile::getPostFilename
type: function
doc:
<comment>Description:</comment>
  Récupère le nom de fichier pour POST

<comment>Return:</comment>
  <info>string</info>  Retourne le nom du fichier pour POST.


id: CURLFile::setMimeType
type: function
doc:
<comment>Description:</comment>
  Définit le type MIME

<comment>Param:</comment>
  <info>string</info>  <strong>$mime_type</strong>  Type MIME à utiliser dans les données POST.

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


id: CURLFile::setPostFilename
type: function
doc:
<comment>Description:</comment>
  Définit le nom du fichier pour POST

<comment>Param:</comment>
  <info>string</info>  <strong>$posted_filename</strong>  Nom du fichier à utiliser pour les données POST.

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


id: CURLINFO_HTTP_CODE
type: constant
doc:
<comment>Description:</comment>
  À partir de cURL 7.10.8, il s'agit d'un alias hérité de <info>CURLINFO_RESPONSE_CODE</info>


id: CURLOPT_DOH_SSL_VERIFYHOST
type: constant
doc:
<comment>Description:</comment>
  Vérifie le nom du certificat SSL du serveur DNS-over-HTTPS avec le nom d'hôte. Disponible à partir
  de PHP 8.2.0 et cURL 7.76.0.


id: CURLOPT_DOH_SSL_VERIFYPEER
type: constant
doc:
<comment>Description:</comment>
  Vérifie l'authenticité du certificat SSL du serveur DNS-over-HTTPS. Disponible à partir de PHP
  8.2.0 et cURL 7.76.0.


id: CURLOPT_DOH_SSL_VERIFYSTATUS
type: constant
doc:
<comment>Description:</comment>
  Indique à cURL de vérifier l'état du certificat du serveur DNS-over-HTTPS en utilisant l'extension
  "Certificate Status Request" de TLS (Agrafage OCSP). Disponible à partir de PHP 8.2.0 et cURL
  7.76.0.


id: CURLOPT_DOH_URL
type: constant
doc:
<comment>Description:</comment>
  Fournit l'URL du DNS-over-HTTPS. Disponible à partir de PHP 8.1.0 et cURL 7.62.0.


id: CURLOPT_FOLLOWLOCATION
type: constant
doc:
<comment>Description:</comment>
  Cette constante n'est pas disponible lorsque open_basedir est actif.


id: CURLOPT_HTTP09_ALLOWED
type: constant
doc:
<comment>Description:</comment>
  Disponible respectivement à partir de PHP 7.3.15 and 7.4.3 et cURL 7.64.0


id: CURLOPT_ISSUERCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  Certificat SSL de l'émetteur à partir du blob de mémoire. Disponible à partir de PHP 8.1.0 et cURL
  7.71.0.


id: CURLOPT_MUTE
type: constant
doc:
<comment>Description:</comment>
  Supprimée à partir de cURL 7.15.5; utiliser <info>CURLOPT_RETURNTRANSFER</info> à la place.


id: CURLOPT_PROXY_ISSUERCERT
type: constant
doc:
<comment>Description:</comment>
  Nom de fichier du certificat SSL de l'émetteur du proxy. Disponible à partir de PHP 8.1.0 et cURL
  7.71.0.


id: CURLOPT_PROXY_ISSUERCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  Certificat SSL de l'émetteur du proxy à partir d'un blob de mémoire. Disponible à partir de PHP
  8.1.0 et cURL 7.71.0.


id: CURLOPT_PROXY_SSLCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  Certificat client du proxy SSL à partir d'un blob de mémoire. Disponible à partir de PHP 8.1.0 et
  cURL 7.71.0.


id: CURLOPT_PROXY_SSLKEY_BLOB
type: constant
doc:
<comment>Description:</comment>
  Clé privée pour le certificat du proxy à partir du blob de mémoire. Disponible à partir de PHP
  8.1.0 et cURL 7.71.0.


id: CURLOPT_SSLCERT_BLOB
type: constant
doc:
<comment>Description:</comment>
  Certificat client SSL à partir d'un blob de mémoire. Disponible à partir de PHP 8.1.0 et cURL
  7.71.0.


id: CURLOPT_SSLKEY_BLOB
type: constant
doc:
<comment>Description:</comment>
  Clé privée pour le certificat du client à partir du blob de mémoire. Disponible à partir de PHP
  8.1.0 et cURL 7.71.0.


id: CURLStringFile
type: class
doc:
<comment>Description:</comment>
  <class>CURLStringFile</class> permet de télécharger un fichier directement à partir d'une variable. Ceci est
  similaire à <class>CURLFile</class>, mais fonctionne avec le contenu du fichier, et non avec le nom du fichier.
  Cette classe ou <class>CURLFile</class> doit être utilisée pour télécharger le contenu du fichier avec
  <info>CURLOPT_POSTFIELDS</info>.


id: CURLStringFile::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un objet CURLStringFile
  
  Crée un objet <class>CURLStringFile</class>, utilisé pour télécharger un fichier avec <info>CURLOPT_POSTFIELDS</info>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>      Le contenu à télécharger.
  <info>string</info>  <strong>$postname</strong>  Le nom du fichier à utiliser dans les données à télécharger.
  <info>string</info>  <strong>$mime</strong>      Le type MIME du fichier (par défaut : <return>application/octet-stream</return>).

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


id: CURL_VERSION_ASYNCHDNS
type: constant
doc:
<comment>Description:</comment>
  Résout le DNS de façon asynchrone. Disponible à partir de PHP 7.3.0 et cURL 7.10.7


id: CURL_VERSION_CONV
type: constant
doc:
<comment>Description:</comment>
  La conversion de caractères est supportée. Disponible à partir de PHP 7.3.0 et cURL 7.15.4


id: CURL_VERSION_CURLDEBUG
type: constant
doc:
<comment>Description:</comment>
  Le traçage du débogage mémoire est supporté. Disponible à partir de PHP 7.3.6 et cURL 7.19.6


id: CURL_VERSION_DEBUG
type: constant
doc:
<comment>Description:</comment>
  Compilé avec les capacités de débogage. Disponible à partir de PHP 7.3.0 et cURL 7.10.6


id: CURL_VERSION_GSSAPI
type: constant
doc:
<comment>Description:</comment>
  Compilé contre une bibliothèque GSS-API. Disponible à partir de PHP 7.3.0 et cURL 7.38.0


id: CURL_VERSION_GSSNEGOTIATE
type: constant
doc:
<comment>Description:</comment>
  L'authentification negotiate est supportée. Disponible à partir de PHP 7.3.0 et cURL 7.10.6
  (obsolète à partir de 7.38.0)


id: CURL_VERSION_IDN
type: constant
doc:
<comment>Description:</comment>
  Les Internationized Domain Names sont supportés. Disponible à partir de PHP 7.3.0 et cURL 7.12.0


id: CURL_VERSION_KERBEROS5
type: constant
doc:
<comment>Description:</comment>
  L'authentification Kerberos V5 est supportée. Disponible à partir de PHP 7.0.7 et cURL 7.40.0


id: CURL_VERSION_LARGEFILE
type: constant
doc:
<comment>Description:</comment>
  Supporte les fichiers plus large que 2 Go Disponible à partir de cURL 7.33.0


id: CURL_VERSION_NTLM
type: constant
doc:
<comment>Description:</comment>
  L'authentification NTLM est supportée. Disponible à partir de PHP 7.3.0 et cURL 7.10.6


id: CURL_VERSION_PSL
type: constant
doc:
<comment>Description:</comment>
  Le Public Suffix List de Mozilla, utilisé pour la vérification de domaine de cookie Disponible à
  partir de PHP 7.3.6 et cURL 7.47.0


id: CURL_VERSION_SPNEGO
type: constant
doc:
<comment>Description:</comment>
  L'authentification SPNEGO est supportée. Disponible à partir de PHP 7.3.0 et cURL 7.10.8


id: CURL_VERSION_SSPI
type: constant
doc:
<comment>Description:</comment>
  Compilé contre Windows SSPI. Disponible à partir de PHP 7.3.0 et cURL 7.13.2


id: CURL_VERSION_TLSAUTH_SRP
type: constant
doc:
<comment>Description:</comment>
  L'authentification TLS-SRP est supportée. Disponible à partir de PHP 7.3.0 et cURL 7.21.4


id: CURL_VERSION_UNIX_SOCKETS
type: constant
doc:
<comment>Description:</comment>
  Support des sockets de domaine Unix. Disponible à partir de PHP 7.0.7 et cURL 7.40.0


id: CachingIterator
type: class
doc:
<comment>Description:</comment>
  Cet objet supporte les itérations en cache sur un autre itérateur.


id: CachingIterator::CATCH_GET_CHILD
type: constant
doc:
<comment>Description:</comment>
  N'envoie aucune exception lors de la tentative d'accéder à un enfant.


id: CachingIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet CachingIterator pour l'itérateur
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  Iterator à mettre en cache
  <info>int</info>       <strong>$flags</strong>     Champ d'options.


id: CachingIterator::__toString
type: function
doc:
<comment>Description:</comment>
  Retourne la représentation de l'élément courant sous forme de chaîne
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  Retourne la représentation de l'élément courant sous forme de chaîne.

<comment>Return:</comment>
  <info>string</info>  La représentation de l'élément courant.


id: CachingIterator::count
type: function
doc:
<comment>Description:</comment>
  Le nombre d'éléments de l'itérateur
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  Retourne le nombre d'éléments de l'itérateur.

<comment>Return:</comment>
  <info>int</info>  Le nombre d'éléments sur lequel travaille l'itérateur.


id: CachingIterator::current
type: function
doc:
<comment>Description:</comment>
  Retourne l'élément courant
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  Retourne l'élément courant de l'itération.

<comment>Return:</comment>
  <info>mixed</info>  Suivant le type de l'élément courant.

<comment>See Also:</comment>
   * Iterator::current


id: CachingIterator::getCache
type: function
doc:
<comment>Description:</comment>
  Lit le contenu du cache
  
  Lit le contenu du cache.
  
  Le drapeau <info>CachingIterator::FULL_CACHE</info> doit être utilisé.

<comment>Return:</comment>
  <info>array</info>  Un tableau contenant les éléments du cache.


id: CachingIterator::getFlags
type: function
doc:
<comment>Description:</comment>
  Lit les options utilisées
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  Lit le champ d'options utilisé par cet objet CachingIterator.

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


id: CachingIterator::hasNext
type: function
doc:
<comment>Description:</comment>
  Vérifie si l'itérateur interne a un élément suivant valide
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: CachingIterator::key
type: function
doc:
<comment>Description:</comment>
  Retourne l'index de l'élément courant
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  Cette méthode retourne l'index de l'élément courant.

<comment>Return:</comment>
  <info>scalar</info>  


id: CachingIterator::next
type: function
doc:
<comment>Description:</comment>
  Déplace l'itérateur à la position suivante
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  Déplace l'itérateur à la position suivante.

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


id: CachingIterator::offsetExists
type: function
doc:
<comment>Description:</comment>
  Vérifie l'existence d'un offset
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  L'index qui est étudié.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si un élément existe à la position indiquée, et <info>false</info> sinon.


id: CachingIterator::offsetGet
type: function
doc:
<comment>Description:</comment>
  L'élément à lire à la position donnée
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  L'index de l'élément à lire

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


id: CachingIterator::offsetSet
type: function
doc:
<comment>Description:</comment>
  Affecte un nouvel élément à la position donnée
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>    L'index de l'élément à affecter.
  <info>mixed</info>   <strong>$value</strong>  La nouvelle valeur de <strong>$key</strong>.

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


id: CachingIterator::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Détruit un élément à l'offset indiqué
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$key</strong>  L'index de l'élément qui sera détruit.

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


id: CachingIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Replace l'itérateur au début
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  Replace l'itérateur au début.

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


id: CachingIterator::setFlags
type: function
doc:
<comment>Description:</comment>
  Modifie les options du CachingIterator
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  Modifie les options de l'itérateur CachingIterator.

<comment>Param:</comment>
  <info>int</info>  <strong>$flags</strong>  Champ d'option à configurer.

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


id: CachingIterator::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si l'élément courant est valide
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.
  
  Vérifie si l'élément courant 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.


id: CallbackFilterIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un itérateur filtré depuis un autre itérateur
  
  Crée un itérateur filtré en utilisant la fonction de rappel <strong>$callback</strong> pour déterminer quels
  éléments sont acceptés ou rejetés.

<comment>Param:</comment>
  <info>Iterator</info>  <strong>$iterator</strong>  L'itérateur à filtrer.
  <info>callable</info>  <strong>$callback</strong>  La fonction de rappel, qui doit retourner <info>true</info> pour accepter l'élément
                       courant, <info>false</info> sinon. Voir aussi les exemples.
                       
                       Peut être n'importe quelle valeur vaide de type <info>callable</info>.

<comment>See Also:</comment>
   * Exemples avec CallbackFilterIterator
   * CallbackFilterIterator::accept


id: CallbackFilterIterator::accept
type: function
doc:
<comment>Description:</comment>
  Appel la fonction de rappel avec la valeur courante, la clé courante,
     et l'itérateur interne comme arguments
  
  Cette méthode appelle la fonction de rappel avec la valeur courante, la clé courante et
  l'itérateur interne.
  
  La fonction de rappel doit retourner <info>true</info> si l'élément courant est accepté, <info>false</info> sinon.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> pour accepter l'élément courant, <info>false</info> sinon.

<comment>See Also:</comment>
   * Exemple avec CallbackFilterIterator
   * CallbackFilterIterator::__construct


id: Client::getClient
type: function
doc:
<comment>Description:</comment>
  Get client session
  
  Get session associated with the client.

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  A Session object.


id: Closure
type: class
doc:
<comment>Description:</comment>
  Classe utilisée pour représenter les fonctions anonymes.
  
  Les fonctions anonymes produisent des objets de ce type. Cette classe a des méthodes qui
  permettent un contrôle supplémentaire de la fonction anonyme après sa création.
  
  En plus des méthodes précisées ici, cette classe possède aussi une méthode <return>__invoke</return>. Ceci pour des
  raisons de logique avec l'implémentation de la méthode magique d'appel.


id: Closure::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur empêchant l'instanciation
  
  Cette méthode n'existe que pour interdire l'instanciation directe de la classe <class>Closure</class>. Des objets
  d'une telle classe sont crées au moyen des fonctions anonymes.

<comment>See Also:</comment>
   * Fonctions anonymes


id: Closure::bind
type: function
doc:
<comment>Description:</comment>
  Duplique une fermeture avec un nouvel objet lié et un nouveau contexte de classe.
    
  
  Cette méthode est une version statique de Closure::bindTo. Voir sa documentation pour plus
  d'informations.

<comment>Param:</comment>
  <info>Closure</info>             <strong>$closure</strong>   La fonction anonyme à lier.
  <info>object|null</info>         <strong>$newThis</strong>   L'objet auquel lier la fonction anonyme ou <info>null</info> pour délier
  <info>object|string|null</info>  <strong>$newScope</strong>  Le contexte de classe à associer à la fermeture, ou 'static' pour
                                 conserver le contexte actuel. Si un objet est utilisé, son type
                                 sera utilisé. Ceci détermine les accès protégés et privés de
                                 l'objet lié. Il n'est pas autorisé de passer (un objet d') une
                                 classe interne pour  ce paramètre.

<comment>Return:</comment>
  <info>Closure|null</info>  Retourne un nouvel objet <class>Closure</class>, ou <info>null</info> en cas d'échec.

<comment>See Also:</comment>
   * fonctions anonymes
   * Closure::bindTo


id: Closure::bindTo
type: function
doc:
<comment>Description:</comment>
  Duplique la fermeture avec un nouvel objet lié et un nouveau contexte de classe.
    
  
  Crée et retourne une nouvelle fonction anonyme  avec le même corps et les même variables liées que
  l'originale, mais avec un objet lié qui peut être différent, et un nouveau contexte de classe.
  
  L'objet lié détermine la valeur que <return>$this</return> aura dans le corps de la fonction, et le contexte de
  classe représente une classe qui détermine à quels membres privés et protégés la fonction anonyme
  aura accès. Autrement dit, les propriétés qui seront visibles seront les mêmes que si la fonction
  anonyme était une méthode de la classe passée via le paramètre <strong>$newScope</strong>.
  
  Les fermetures statiques ne peuvent pas avoir d'objet lié (la valeur du paramètre <strong>$newThis</strong> devrait
  être <info>null</info>), mais le contexte de classe peut, lui, être changé.
  
  Cette fonction va vérifier qu'une fermeture non-statique à laquelle on passe un contexte d'objet
  deviendra liée à cet objet (et ne sera donc plus non-statique), et vice-versa. Dans ce but, les
  fermetures non-statiques auxquelles on passe un contexte de classe mais <info>null</info> comme contexte objet
  seront rendues statiques, et inversement.
  
  Si vous voulez seulement dupliquer la fonction anonyme, vous pouvez utiliser le clonage à la
  place.

<comment>Param:</comment>
  <info>object|null</info>         <strong>$newThis</strong>   L'objet auquel lier la fonction anonyme, ou <info>null</info> pour une fermeture
                                 statique.
  <info>object|string|null</info>  <strong>$newScope</strong>  Le contexte de classe à associer à la fermeture, ou 'static' pour
                                 conserver le contexte actuel. Si un objet est passé, son type sera
                                 utilisé. Ceci determine la visibilité des méthodes protégées et
                                 privées de l'objet lié. Il n'est pas autorisé de passer (un objet
                                 d') une classe interne pour  ce paramètre.

<comment>Return:</comment>
  <info>Closure|null</info>  Retourne la nouvelle fermeture sous la forme d'un objet <class>Closure</class>, ou <info>null</info> en cas
                d'erreur.

<comment>See Also:</comment>
   * Fonctions anonymes
   * Closure::bind


id: Closure::call
type: function
doc:
<comment>Description:</comment>
  Lie et appelle la fermeture
  
  Lie temporairement la fermeture (closure) à <strong>$newThis</strong>, et l'appelle avec les paramètres donné.

<comment>Param:</comment>
  <info>object</info>  <strong>$newThis</strong>  L'objet auquel lier la fermeture pour la durée de l'appel.
  <info>mixed</info>   <strong>$args</strong>     Zéro ou plusieurs paramètres, qui seront donnés en tant que paramètres à la
                    fermeture.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur de retour de la fermeture.


id: Closure::fromCallable
type: function
doc:
<comment>Description:</comment>
  Convertis un callable en une fermeture
  
  Crée et retourne une nouvelle fonction anonyme à partir du <strong>$callback</strong> donnée en utilisant la portée
  courante. Cette méthode vérifie que <strong>$callback</strong> est appelable dans la portée courante et émet un
  <class>TypeError</class> si ce n'est pas le cas.
  
  À partir de PHP 8.1.0, la syntaxe callable de première classe à les mêmes sémantiques que cette
  méthode.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  Le callable à convertir.

<comment>Return:</comment>
  <info>Closure</info>  Retourne la nouvelle <class>Closure</class> créée ou émet une <class>TypeError</class> si <strong>$callback</strong> n'est pas appelable
           dans la portée courante.

<comment>See Also:</comment>
   * Fonctions anonymes
   * Syntaxe callable de première classe


id: Collator
type: class
doc:
<comment>Description:</comment>
  Fournit des outils de comparaisons de chaînes, avec le support des conventions locales pour les
  tris.


id: Collator::ALTERNATE_HANDLING
type: constant
doc:
<comment>Description:</comment>
  L'attribut alterné est utilisé pour contrôler la gestion des caractères variables de UCA : les
  espaces blancs, la ponctuation et les symboles. Si Alternate est configuré à NonIgnorable (N),
  alors les différences entre ces caractères sont de la même  importance que les différences entre
  les lettres. Si Alternate est configuré à Shifted (S), alors ces caractères seront d'importance
  mineur. La valeur Shifted  est souvent utilisée conjointement avec Quaternary qui vaut Strength.
  Dans ce cas, les espaces blancs, la ponctuation et les symboles sont considérés lors de la
  comparaison, mais uniquement  si les autres aspects de la chaînes (lettres de base, accents et
  casse) sont tous identiques. Si Alternate n'est pas configuré à Shifted, il n'y a alors pas de
  différence entre une Strength de 3 et une Strength de 4.  Pour plus d'information et d'exemples,
  voyez Variable_Weighting dans  UCA. La raison qui fait que les  valeurs de Alternate ne sont pas
  seulement On et Off est que des valeurs supplémentaires pour  Alternate pourraient être ajoutées à
  l'avenir. L'option UCA Blanked est exprimée avec une valeur de Strength à 3, et Alternate
  configuré à Shifted. La valeur par défaut pour la majorité des locales est  NonIgnorable. Si
  Shifted est sélectionné, il peut être plus lent s'il y a  de nombreuses chaînes qui sont
  identiques, sauf pour la ponctuation : la taille de la clé de tri sera inchangée, à mois que le
  niveau de Strength ne soit élevé.
  
  Les valeurs possibles sont :  <info>Collator::NON_IGNORABLE</info>(par
  défaut)<info>Collator::SHIFTED</info><info>Collator::DEFAULT_VALUE</info>
  
  Règles ALTERNATE_HANDLING S=3, A=N di Silva
  \< Di Silva \< diSilva \< U.S.A. \< USA  S=3, A=S di Silva = diSilva \< Di Silva \< U.S.A. = USA  S=4, A=S di Silva \< diSilva \< Di Silva \< U.S.A. \< USA
  
   S=3, A=N di Silva
  \< Di Silva \< diSilva \< U.S.A. \< USA  S=3, A=S di Silva = diSilva \< Di Silva \< U.S.A. = USA  S=4, A=S di Silva \< diSilva \< Di Silva \< U.S.A. \< USA


id: Collator::CASE_FIRST
type: constant
doc:
<comment>Description:</comment>
  L'attribut Case_First est utilisé pour contrôler le fait que les majuscules doivent être
  considérées comme avant les minuscules, et vice-versa, en  l'absence d'autres discriminant. Les
  valeurs possibles sont  Uppercase_First (U) et Lowercase_First (L), plus les valeurs standards
  Default et Off. Il n'y a presque pas de différence entre Off et Lowercase_First en termes de
  résultats, ce qui fait que les utilisateurs typiques n'utiliseront pas Lowercase_First :
  uniquement Off ou Uppercase_First.  (ceux qui sont intéressés par les différences entre X et L
  devront consulter la section <return>Collation Customization</return>).  Spécifier L ou U ne va pas changer les
  performances de comparaison, mais va affecter la taille de la clé de tri.
  
  Les valeurs possibles sont :  <info>Collator::OFF</info>(par
  défaut)<info>Collator::LOWER_FIRST</info><info>Collator::UPPER_FIRST</info><info>Collator:DEFAULT</info>
  
  Règles CASE_FIRSTC=X or C=L "china"
  \< "China" \< "denmark" \< "Denmark"C=U "China" \< "china" \< "Denmark" \< "denmark"
  
  C=X or C=L "china"
  \< "China" \< "denmark" \< "Denmark"C=U "China" \< "china" \< "Denmark" \< "denmark"


id: Collator::CASE_LEVEL
type: constant
doc:
<comment>Description:</comment>
  L'attribut Case_Level est utilisé pour ignorer les accents, mais pas la casse. Dans ces
  situations, mettez l'attribut Strength à Primary, et Case_Level à On. Dans la plupart des locales,
  cet attribut est à Off par défaut. Il y a un petit coût de performances pour la comparaison des
  chaînes, un un impact sur la taille des index de tri si cet attribut est à On.
  
  Les valeurs possibles sont :  <info>Collator::OFF</info>(par défaut)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>
  
  Règles CASE_LEVELS=1, E=X role = Role = rôleS=1, E=O role = rôle \< Role
  
  S=1, E=X role = Role = rôleS=1, E=O role = rôle \< Role


id: Collator::FRENCH_COLLATION
type: constant
doc:
<comment>Description:</comment>
  Trie les chaînes avec différents accents, sur la fin de la chaîne. Cet attribut est
  automatiquement configuré à On pour les locales françaises, et quelques autres. Les utilisateurs
  n'ont pas besoin de configurer explicitement cet attribut. Il y a un coût de performances lors de
  la comparaison des chaînes quand cet attribut est à On, mais la taille des clés de tris est
  inchangée. Les valeurs possibles sont : <info>Collator::ON</info><info>Collator::OFF</info>(par
  défaut)<info>Collator::DEFAULT_VALUE</info>
  
  Règles de FRENCH_COLLATIONF=OFF cote \< coté \< côte \< côté F=ON cote \< côte \< coté \< côté
  
  F=OFF cote \< coté \< côte \< côté F=ON cote \< côte \< coté \< côté


id: Collator::HIRAGANA_QUATERNARY_MODE
type: constant
doc:
<comment>Description:</comment>
  La compatibilité avec JIS x 4061 requiert l'introduction d'un niveau supplémentaire pour
  distinguer les caractères Hiragana et Katakana.  Si la compatibilité avec le standard est
  nécessaire, alors cet attribut doit être utilisé à On, et la Strength doit prendre la valeur de
  Quaternary. Cela va affecter la taille des index de tri, et les performances de comparaisons des
  chaînes.
  
  Les valeurs possibles sont :  <info>Collator::OFF</info>(par défaut)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::NORMALIZATION_MODE
type: constant
doc:
<comment>Description:</comment>
  L'attribut Normalization détermine s'il faut normaliser totalement le texte ou non, pour la
  comparaison. Même si cet attribut à Off (ce qui set le cas par défaut pour de nombreuses locales),
  les textes comparés pour un usage ordinaire seront corrects (pour des détails, voyez UTN #5). Il
  n'y aura un problème que si les marques d'accent ne sont pas canoniques. Si cet attribut est à On,
  alors les meilleurs résultats sont garantis pour tous les textes. Il y a un coût de comparaison
  moyen si cet attribut vaut On, en fonction de la fréquence des séquences qui requièrent de la
  normalisation. Il n'y a pas d'effet significatif sur la taille des index de tri. Si le texte est
  réputé dans les formes de normalisation NFD ou NFKD, il n'y a pas besoin d'activer l'option de
  Normalization.
  
  Les valeurs possibles sont :  <info>Collator::OFF</info>(par défaut)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::NUMERIC_COLLATION
type: constant
doc:
<comment>Description:</comment>
  Lorsqu'activé, cet attribut génère une clé de collation pour les valeurs numériques de
  sous-chaînes. C'est une méthode pour que '100' soit trié après '2'.
  
  Les valeurs possibles sont :  <info>Collator::OFF</info>(par défaut)<info>Collator::ON</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::STRENGTH
type: constant
doc:
<comment>Description:</comment>
  Le service de collation ICU supporte de nombreux niveaux de comparaison (appelés "Levels", mais
  aussi connus sous le nom de "Strengths").  Avec ces catégories, ICU peut trier les chaînes avec
  précision, en fonction des conventions locales. Cependant, en permettant l'utilisation sélective
  des niveaux, la recherche d'une chaîne dans un texte peut être réalisées, à partir de différentes
  conditions. Pour plus  d'informations, voyez le chapitre <strong>collator_set_strength()</strong>.
  
  Les valeurs possibles sont :  <info>Collator::PRIMARY</info><info>Collator::SECONDARY</info><info>Collator::TERTIARY</info>(par
  défaut)<info>Collator::QUATERNARY</info><info>Collator::IDENTICAL</info><info>Collator::DEFAULT_VALUE</info>


id: Collator::__construct
type: function
doc:
<comment>Description:</comment>
  Création d'un collator
  
  Création d'une nouvelle instance de <class>Collator</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  La locale dont les règles de collation doivent être respectés.  Des valeurs
                   spéciales peuvent être passées dans cet argument :  si une chaîne de caractères
                   vide est passé, la locale par défaut sera utilisée. Si le mot clé <return>"root"</return> est
                   passé, les règles UCA seront utilisées.
                   
                   L'attribut Locale est généralement l'attribut le plus important pour assurer des
                   tris et comparaisons valides, en fonction des attentes des utilisateurs. L'ordre
                   par défaut UCA va trier uniquement quelques langues, telles que hollandais ou
                   portugais (correctement signifie que le résultat sera conforme aux attentes  des
                   utilisateurs de ces langues). Autrement, vous devez fournir une  locale adaptée à
                   vos utilisateurs. Par conséquent, une valeur spécifique de locale doit être
                   fournie pour assurer un service correct. Le choix de la locale va configurer les
                   valeurs de tous ses attributs qui sont les plus pertinentes pour une locale. Par
                   conséquent, la plupart du temps, les attributs n'ont pas besoin d'être d'être
                   explicitement attribués. Dans le même temps, le choix de la locale aura un impact
                   sur les  performances de comparaison et de tris.

<comment>See Also:</comment>
   * <strong>Collator::create()</strong>
   * <strong>collator_create()</strong>


id: Collator::asort
type: function
doc:
<comment>Description:</comment>
  Tri un tableau en conservant les clés, avec une collation
  
  Style orienté objet
  
  Style procédural
  
  Cette fonction trie un tableau en maintenant l'association entre les  clés et les valeurs. Elle
  sert surtout à trier des tableaux associatifs, où l'ordre des éléments est important. Les éléments
  seront triés en fonction des conventions locales.
  
  Équivalent de la fonction PHP standard <strong>asort()</strong>.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Objet <class>Collator</class>.
  <info>array</info>     <strong>$array</strong>   tableau de chaînes à trier.
  <info>int</info>       <strong>$flags</strong>   Type de tri, optionnel, choisi parmi les constantes suivantes :
                     
                     <info>Collator::SORT_REGULAR</info> : compare les éléments normalement (pas de changement de
                     type). <info>Collator::SORT_NUMERIC</info> : compare les éléments numériquement.
                     <info>Collator::SORT_STRING</info> : compare les éléments littéralement.  La valeur par
                     défaut de <strong>$flags</strong> est <info>Collator::SORT_REGULAR</info>. Cette valeur est aussi utilisé si
                     une valeur invalide de <strong>$flags</strong> a été fournit.
                     
                     <info>Collator::SORT_REGULAR</info> : compare les éléments normalement (pas de changement de
                     type).
                     
                     <info>Collator::SORT_NUMERIC</info> : compare les éléments numériquement.
                     
                     <info>Collator::SORT_STRING</info> : compare les éléments littéralement.

<comment>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>
   * Constantes <class>Collator</class>
   * <strong>collator_sort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::compare
type: function
doc:
<comment>Description:</comment>
  Compare deux chaînes Unicode
  
  Style orienté objet
  
  Style procédural
  
  Compare deux chaînes Unicode en fonction des règles de collation.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>   Objet <class>Collator</class>.
  <info>string</info>    <strong>$string1</strong>  La première chaîne à comparer.
  <info>string</info>    <strong>$string2</strong>  La deuxième chaîne à comparer.

<comment>Return:</comment>
  <info>int|false</info>  Résultats de comparaison
             
              1 si <strong>$string1</strong> est plus grand que <strong>$string2</strong> ;  0 si <strong>$string1</strong> est égal à <strong>$string2</strong>;  -1 si
             <strong>$string1</strong> est plus petit que <strong>$string2</strong> .  Retourne <info>false</info> en cas d'échec.
             
             1 si <strong>$string1</strong> est plus grand que <strong>$string2</strong> ;
             
             0 si <strong>$string1</strong> est égal à <strong>$string2</strong>;
             
             -1 si <strong>$string1</strong> est plus petit que <strong>$string2</strong> .
             
             Cette fonction peut retourner <info>false</info>, mais elle peut aussi retourner une valeur
             équivalent à <info>false</info>. Veuillez lire la section sur les booléens pour plus d'informations.
             Utilisez l'opérateur === pour tester la valeur de retour exacte de cette fonction.

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


id: Collator::create
type: function
doc:
<comment>Description:</comment>
  Création d'un collator
  
  Style orienté objet
  
  Style procédural
  
  Les chaînes seront comparées et triées avec des conventions locales.

<comment>Param:</comment>
  <info>string</info>  <strong>$locale</strong>  La locale dont les règles de collation doivent être respectés.  Des valeurs
                   spéciales peuvent être passées dans cet argument :  si une chaîne de caractères
                   vide est passé, la locale par défaut sera utilisée. Si le mot clé <return>"root"</return> est
                   passé, les règles  UCA seront utilisées.

<comment>Return:</comment>
  <info>Collator|null</info>  Retourne une nouvelle instance de la classe <class>Collator</class>,  ou <info>null</info> en cas d'erreur.

<comment>See Also:</comment>
   * <strong>Collator::__construct()</strong>


id: Collator::getAttribute
type: function
doc:
<comment>Description:</comment>
  Lit un attribut de collation
  
  Style orienté objet
  
  Style procédural
  
  Lit un attribut de collation.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>     Objet <class>Collator</class>.
  <info>int</info>       <strong>$attribute</strong>  L'attribut à lire.

<comment>Return:</comment>
  <info>int|false</info>  La valeur de l'attribut, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <class>Collator</class> constants
   * <strong>collator_set_attribute()</strong>
   * <strong>collator_get_strength()</strong>


id: Collator::getErrorCode
type: function
doc:
<comment>Description:</comment>
  Lit la dernière erreur du collator
  
  Style orienté objet
  
  Style procédural
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Objet <class>Collator</class>.

<comment>Return:</comment>
  <info>int|false</info>  Le code d'erreur retourné par le dernier appel à un objet de l'API <class>Collator</class>, ou <info>false</info>
             si une erreur survient.

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


id: Collator::getErrorMessage
type: function
doc:
<comment>Description:</comment>
  Lit le dernier message d'erreur du collator
  
  Style orienté objet
  
  Style procédural
  
  Lit le dernier message d'erreur.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Object <class>Collator</class>.

<comment>Return:</comment>
  <info>string|false</info>  La description d'une erreur survenue lors du dernier appel à une méthode de l'API
                <class>Collator</class>, ou <info>false</info> si une erreur survient.

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


id: Collator::getLocale
type: function
doc:
<comment>Description:</comment>
  Lit le nom de la locale d'un collator
  
  Style orienté objet
  
  Style procédural
  
  Lit le nom de la locale d'un collator

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Objet <class>Collator</class>.
  <info>int</info>       <strong>$type</strong>    Vous pouvez choisir entre une valeur valide ou une valeur littérale de la
                     locale (à l'aide des constantes  <info>Locale::VALID_LOCALE</info> et <info>Locale::ACTUAL_LOCALE</info>,
                     respectivement).

<comment>Return:</comment>
  <info>string|false</info>  Le nom de la locale pour laquelle le collator est configuré. Si le collator a été
                configuré à partir de règles, ou si une erreur est survenue retourne <info>false</info>.

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


id: Collator::getSortKey
type: function
doc:
<comment>Description:</comment>
  Récupère la clé de tri pour une chaine
  
  Style orienté objet
  
  Style procédural
  
  Retourne la clé de la collation pour une chaîne. Les clés de collation peuvent être comparées
  directement au lieu de chaînes, néanmoins elles sont spécifique à l'implémentation et peuvent
  changer entre les versions de la bibliothèque ICU. Les clés de tries sont généralement seulement
  utile dans les bases de données ou autres circonstances où les appels de fonctions sont
  extrêmement cher.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Objet <class>Collator</class>.
  <info>string</info>    <strong>$string</strong>  La chaine depuis laquelle produire la clé.

<comment>Return:</comment>
  <info>string|false</info>  Retourne la clé de collation pour la chaîne,  ou <info>false</info> si une erreur survient.
                
                Cette fonction peut retourner <info>false</info>, mais elle peut aussi retourner une valeur
                équivalent à <info>false</info>. Veuillez lire la section sur les booléens pour plus
                d'informations. Utilisez l'opérateur === pour tester la valeur de retour exacte de
                cette fonction.

<comment>See Also:</comment>
   * <strong>collator_sort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::getStrength
type: function
doc:
<comment>Description:</comment>
  Récupère la dureté de classement utilisé
  
  Style orienté objet
  
  Style procédural

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Objet <class>Collator</class>.

<comment>Return:</comment>
  <info>int</info>  Retourne la dureté du classement, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <class>Collator</class> constants
   * <strong>collator_set_strength()</strong>
   * <strong>collator_get_attribute()</strong>


id: Collator::setAttribute
type: function
doc:
<comment>Description:</comment>
  Configure l'attribut de collation
  
  Style orienté objet
  
  Style procédural
  
  

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>     Objet <class>Collator</class>.
  <info>int</info>       <strong>$attribute</strong>  L'attribut.
  <info>int</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>
   * <class>Collator</class> constants
   * <strong>collator_get_attribute()</strong>
   * <strong>collator_set_strength()</strong>


id: Collator::setStrength
type: function
doc:
<comment>Description:</comment>
  Set collation strength
  
  Style orienté objet
  
  Style procédural
  
  Le service de collation ICU supporte de nombreux niveaux de comparaison (appelés "Levels", mais
  aussi connus sous le nom de "Strengths"). Avec ces categories, ICU peut trier les chaînes avec
  précision, en fonction des conventions locales. Cependant, en permettant l'utilisation selective
  des niveaux, la recherche d'une chaîne dans un texte peut être réalisées, à partir de différentes
  conditions. Pour plus d'informations, voyez le chapitre <strong>collator_set_strength()</strong>.
  
  Niveau primaire : Typiquement, ceci est utilisé pour faire la différence entre des caractères de
  bases, comme "a"
  \< "b"). C'est la différence la plus importante. Par exemple, les dictionnaires sont divisées en sections avec les caractères de base. Ceci est aussi appelé le <return>level
  1</return> de dureté. Niveau secondaire : Les accents sur les caractères sont considérés comme des
  différences secondaires. Par exemple, "as"
  \< "às" \< "at". D'autres différences entre les caractères peuvent être considérées comme secondaires, en fonction des langues. Une différence secondaire sont toujours ignorées quand  une différence primaire est présente. Ceci est aussi appelé le <return>level
  2</return> de dureté.  Note : dans certaines langues, comme le danois, certains caractères accentués sont
  considérés comme des caractères de bases. Dans la plupart des langues, un caractère accentué est
  simplement une différence secondaire avec les versions simple de la lettre.  Niveau tertiaire :
  les majuscules et les minuscules sont distinguées au niveau tertiaire.  par exemple, "ao"
  \< "Ao" \< "aò". De plus, une variante d'une lettre est différente de la forme de base, au niveau ternaire. Par exemple,  "A" et " ". Un autre exemple de différente tertiaire est le grand et le  petit Kana. Une différence tertiaire est ignorée quand une différence primaire ou secondaire est présente. Ceci est aussi appelé le <return>level
  3</return> de dureté. Niveau quaternaire : Lorsque le ponctuation est ignorée, au niveaux 1-3, un niveau
  supplémentaire peut être utilisé pour distinguer des mots avec ou sans ponctuation. Par exemple,
  "ab"
  \< "a-b" \< "aB". Cette différence est ignorée lorsqu'il y a une différence de niveau primaire, secondaire ou tertiaire. Ceci est aussi appelé le <return>level
  4</return> de dureté. Le niveau quaternaire ne doit être utilisé que lorsqu'il faut ignorer la ponctuation
  ou traiter du texte japonais (traitement Hiragana). Niveau identique : Lorsque tous les autres
  niveaux sont égaux, le niveau identique est utilisé pour départager les caractères. Le code
  Unicode point sur une forme NFD de chaque caractère, et sont comparés à ce niveau, au cas où il
  n'y aurait pas de différence au niveaux 1-4. Par exemple, les cantillation hébraïque ne sont
  distingués qu'à ce niveau. Ce niveau ne doit être utilisé  qu'avec beaucoup de parcimonie, car il
  fait substantiellement décroitre les performances. Ceci est aussi appelé le <return>level 5</return> de dureté.
  
  Niveau primaire : Typiquement, ceci est utilisé pour faire la différence entre des caractères de
  bases, comme "a"
  \< "b"). C'est la différence la plus importante. Par exemple, les dictionnaires sont divisées en sections avec les caractères de base. Ceci est aussi appelé le <return>level
  1</return> de dureté.
  
  Niveau secondaire : Les accents sur les caractères sont considérés comme des différences
  secondaires. Par exemple, "as"
  \< "às" \< "at". D'autres différences entre les caractères peuvent être considérées comme secondaires, en fonction des langues. Une différence secondaire sont toujours ignorées quand  une différence primaire est présente. Ceci est aussi appelé le <return>level
  2</return> de dureté.  Note : dans certaines langues, comme le danois, certains caractères accentués sont
  considérés comme des caractères de bases. Dans la plupart des langues, un caractère accentué est
  simplement une différence secondaire avec les versions simple de la lettre.
  
  Note : dans certaines langues, comme le danois, certains caractères accentués sont considérés
  comme des caractères de bases. Dans la plupart des langues, un caractère accentué est simplement
  une différence secondaire avec les versions simple de la lettre.
  
  Niveau tertiaire : les majuscules et les minuscules sont distinguées au niveau tertiaire.  par
  exemple, "ao"
  \< "Ao" \< "aò". De plus, une variante d'une lettre est différente de la forme de base, au niveau ternaire. Par exemple,  "A" et " ". Un autre exemple de différente tertiaire est le grand et le  petit Kana. Une différence tertiaire est ignorée quand une différence primaire ou secondaire est présente. Ceci est aussi appelé le <return>level
  3</return> de dureté.
  
  Niveau quaternaire : Lorsque le ponctuation est ignorée, au niveaux 1-3, un niveau supplémentaire
  peut être utilisé pour distinguer des mots avec ou sans ponctuation. Par exemple, "ab"
  \< "a-b" \< "aB". Cette différence est ignorée lorsqu'il y a une différence de niveau primaire, secondaire ou tertiaire. Ceci est aussi appelé le <return>level
  4</return> de dureté. Le niveau quaternaire ne doit être utilisé que lorsqu'il faut ignorer la ponctuation
  ou traiter du texte japonais (traitement Hiragana).
  
  Niveau identique : Lorsque tous les autres niveaux sont égaux, le niveau identique est utilisé
  pour départager les caractères. Le code Unicode point sur une forme NFD de chaque caractère, et
  sont comparés à ce niveau, au cas où il n'y aurait pas de différence au niveaux 1-4. Par exemple,
  les cantillation hébraïque ne sont distingués qu'à ce niveau. Ce niveau ne doit être utilisé
  qu'avec beaucoup de parcimonie, car il fait substantiellement décroitre les performances. Ceci est
  aussi appelé le <return>level 5</return> de dureté.
  
  Par exemple, on peut choisir d'ignorer les accents, les accents et les  majuscules dans un texte.
  Presque tous les caractères sont distingués par les trois premiers niveaux, et la plupart des
  locales s'arrêtent au niveau trois. Cependant, si l'attribut Alternate prend la valeur de Shifted,
  alors le quatrième niveau sert à départager les égalités entre les espaces, la ponctuation et  les
  symboles, qui seraient ignorés autrement. Si des différentes très subtiles sont nécessaires entre
  les caractères, le niveau identique peut être utilisée (par exemple, le niveau identique fait la
  différence entre un A mathématique petit et gras avec un A mathématique italique et petit.
  Cependant, utiliser ces niveaux implique une dégradation significative des performances lors de la
  comparaison et le tri des chaînes proches ou égales.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>    Objet <class>Collator</class>.
  <info>int</info>       <strong>$strength</strong>  Le niveau à choisir.
                       
                       Les valeurs possibles sont :
                       <info>Collator::PRIMARY</info><info>Collator::SECONDARY</info><info>Collator::TERTIARY</info><info>Collator::QUATERNARY</info><info>Collator::IDENTICAL</info><info>Collator::DEFAULT_STRENGTH</info>
                       
                       <info>Collator::PRIMARY</info>
                       
                       <info>Collator::SECONDARY</info>
                       
                       <info>Collator::TERTIARY</info>
                       
                       <info>Collator::QUATERNARY</info>
                       
                       <info>Collator::IDENTICAL</info>
                       
                       <info>Collator::DEFAULT_STRENGTH</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>
   * Constantes <class>Collator</class>
   * <strong>collator_get_strength()</strong>


id: Collator::sort
type: function
doc:
<comment>Description:</comment>
  Trie un tableau avec une collation
  
  Style orienté objet
  
  Style procédural
  
  Cette fonction trie un tableau en fonction des conventions locales.
  
  Équivalent à la fonction standard PHP <strong>sort()</strong>.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Objet <class>Collator</class>.
  <info>array</info>     <strong>$array</strong>   tableau de chaînes à trier.
  <info>int</info>       <strong>$flags</strong>   Type de tri, optionnel, choisi parmi les constantes suivantes :
                     
                     <info>Collator::SORT_REGULAR</info> : compare les éléments normalement (pas de changement de
                     type). <info>Collator::SORT_NUMERIC</info> : compare les éléments numériquement.
                     <info>Collator::SORT_STRING</info> : compare les éléments littéralement.  Le type de tri par
                     défaut est <info>Collator::SORT_REGULAR</info>. Il est également utilisé si une valeur
                     invalide du paramètre <strong>$flags</strong> est utilisée.
                     
                     <info>Collator::SORT_REGULAR</info> : compare les éléments normalement (pas de changement de
                     type).
                     
                     <info>Collator::SORT_NUMERIC</info> : compare les éléments numériquement.
                     
                     <info>Collator::SORT_STRING</info> : compare les éléments littéralement.

<comment>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>
   * Constantes <class>Collator</class>
   * <strong>collator_asort()</strong>
   * <strong>collator_sort_with_sort_keys()</strong>


id: Collator::sortWithSortKeys
type: function
doc:
<comment>Description:</comment>
  Tri un tableau et ses clés avec une collation
  
  Style orienté objet
  
  Style procédural
  
  Similaire à <strong>collator_sort()</strong>, mais utilise le tri de clé ICU de <strong>ucol_getSortKey()</strong> pour obtenir plus
  de vitesse sur les grands tableaux.

<comment>Param:</comment>
  <info>Collator</info>  <strong>$object</strong>  Objet <class>Collator</class>.
  <info>array</info>     <strong>$array</strong>   tableau de chaîne à trier

<comment>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>
   * Constantes <class>Collator</class>
   * <strong>collator_sort()</strong>
   * <strong>collator_asort()</strong>


id: Collectable::isGarbage
type: function
doc:
<comment>Description:</comment>
  Détermine si un objet a été marqué comme obsolète
  
  Peut être appelé dans Pool::collect pour déterminer si cet objet est obsolète.

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

<comment>See Also:</comment>
   * Pool::collect


id: Collection::add
type: function
doc:
<comment>Description:</comment>
  Add collection document
  
  Triggers the insertion of the given document(s) into the collection, and  multiple variants of
  this method are supported. Options include:
  
  Add a single document as a JSON string.
  
  Add a single document as an array as:  <return>[ 'field' =&gt; 'value', 'field2' =&gt; 'value2' ... ]</return>
  
  A mix of both, and multiple documents can be added in the same operation.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$document</strong>  One or multiple documents, and this can be either JSON or an array of fields
                    with  their associated values. This cannot be an empty array.
                    
                    The MySQL server automatically generates unique <return>_id</return> values for each document
                    (recommended), although this can be manually added as well. This value must be
                    unique as otherwise the add operation will fail.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionAdd</info>  A CollectionAdd object. Use execute() to return a Result that can be
                               used to query the number  of affected items, the number warnings
                               generated by the operation, or to fetch a list of  generated IDs for
                               the inserted documents.


id: Collection::addOrReplaceOne
type: function
doc:
<comment>Description:</comment>
  Add or replace collection document
  
  Add a new document, or replace a document if it already exists.
  
  Here are several scenarios for this method:
  
  If neither the id or any unique key values conflict with any document in the collection,  then the
  document is added.
  
  If the id does not match any document but one or more unique key values conflict with a  document
  in the collection, then an error is raised.
  
  If id matches an existing document and no unique keys are defined for the collection,  then the
  document is replaced.
  
  If id matches an existing document, and either all unique keys in the replacement document  match
  that same document or they don't conflict with any other documents in the collection,  then the
  document is replaced.
  
  If id matches an existing document and one or more unique keys match a different document  from
  the collection, then an error is raised.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>   This is the filter id. If this id or any other field that has a unique index already
                exists in the collection, then it will update the matching document instead.
                
                By default, this id is automatically generated by MySQL Server when the record was
                added, and is referenced as a field named '_id'.
  <info>string</info>  <strong>$doc</strong>  This is the document to add or replace, which is a JSON string.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object.


id: Collection::count
type: function
doc:
<comment>Description:</comment>
  Get document count
  
  This functionality is similar to a <return>SELECT COUNT(*)</return> SQL  operation against the MySQL server for the
  current schema and collection. In other words, it counts the number of documents in the
  collection.

<comment>Return:</comment>
  <info>int</info>  The number of documents in the collection.


id: Collection::createIndex
type: function
doc:
<comment>Description:</comment>
  Create collection index
  
  Creates an index on the collection.
  
  An exception is thrown if an index with the same name already exists, or if index definition is
  not correctly formed.

<comment>Param:</comment>
  <info>string</info>  <strong>$index_name</strong>       The name of the index that to create. This name must be a valid index
                            name as  accepted by the <return>CREATE INDEX</return> SQL query.
  <info>string</info>  <strong>$index_desc_json</strong>  Definition of the index to create. It contains an array of IndexField
                            objects, and each object describes a single document member to include
                            in the index,  and an optional string for the type of index that might
                            be INDEX (default) or SPATIAL.
                            
                            A single IndexField description consists of the following fields:
                            
                            field: string, the full document path to the document member or field to
                            be indexed.
                            
                            type: string, one of the supported SQL column types to map the field
                            into. For numeric types, the optional UNSIGNED keyword may follow. For
                            the TEXT type, the length to consider for indexing may be added.
                            
                            required: bool, (optional) true if the field is required to exist in the
                            document.  Defaults to <info>false</info>, except for <return>GEOJSON</return> where it defaults to
                            <info>true</info>.
                            
                            options: integer, (optional) special option flags for use  when decoding
                            <return>GEOJSON</return> data.
                            
                            srid: integer, (optional) srid value for use when  decoding <return>GEOJSON</return>
                            data.
                            
                            It is an error to include other fields not described above in
                            IndexDefinition or IndexField documents.

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


id: Collection::dropIndex
type: function
doc:
<comment>Description:</comment>
  Drop collection index
  
  Drop a collection index.
  
  This operation does not yield an error if the index does not exist, but <info>false</info> is returned in that
  case.

<comment>Param:</comment>
  <info>string</info>  <strong>$index_name</strong>  Name of collection index to drop.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the DROP INDEX operation succeeded, otherwise <info>false</info>.


id: Collection::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Check if collection exists in database
  
  Checks if the Collection object refers to a collection in the database (schema).

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if collection exists in the database, else <info>false</info> if it does not.
        
        A table defined with two columns (doc and _id) is considered a collection,  and a third
        _json_schema column as of MySQL 8.0.21.  Adding an additional column means
        existsInDatabase() will no longer see it as a collection.


id: Collection::find
type: function
doc:
<comment>Description:</comment>
  Search for document
  
  Search a database collection for a document or set of documents. The found documents are returned
  as a CollectionFind object is to further modify or fetch results from.

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  Although optional, normally a condition is defined to limit the results
                             to a subset of documents.
                             
                             Multiple elements might build the condition and the syntax supports
                             parameter binding.  The expression used as search condition must be a
                             valid SQL expression. If no search condition is provided (field empty)
                             then find('true') is assumed.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object to verify the operation, or fetch the found
                                documents.


id: Collection::getName
type: function
doc:
<comment>Description:</comment>
  Get collection name
  
  Retrieve the collection's name.

<comment>Return:</comment>
  <info>string</info>  The collection name, as a string.


id: Collection::getOne
type: function
doc:
<comment>Description:</comment>
  Get one document
  
  Fetches one document from the collection.
  
  This is a shortcut for: Collection.find("_id = :id").bind("id", id).execute().fetchOne();

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The document _id in the collection.

<comment>Return:</comment>
  <info>Document</info>  The collection object, or <info>null</info> if the _id does not match a document.


id: Collection::getSchema
type: function
doc:
<comment>Description:</comment>
  Get schema object
  
  Retrieve the schema object that contains the collection.

<comment>Return:</comment>
  <info>Schema Object</info>  The schema object on success, or <info>null</info> if the object cannot be retrieved for the
                 given collection.


id: Collection::getSession
type: function
doc:
<comment>Description:</comment>
  Get session object
  
  Get a new Session object from the Collection object.

<comment>Return:</comment>
  <info>Session</info>  A Session object.


id: Collection::modify
type: function
doc:
<comment>Description:</comment>
  Modify collection documents
  
  Modify the documents of a collection that meet specific search conditions. Multiple operations are
  allowed, and parameter binding is supported.

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  Must be a valid SQL expression used to match the documents to modify.
                             This expression might be as simple as <info>true</info>, which matches all
                             documents, or it might use functions and operators such as  'CAST(_id
                             AS SIGNED) &gt;= 10',  'age MOD 2 = 0 OR age MOD 3 = 0', or '_id IN
                             ["2","5","7","10"]'.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  If the operation is not executed, then the function will return  a
                                  Modify object that can be used to add additional modify
                                  operations.
                                  
                                  If the modify operation is executed, then the returned object will
                                  contain the result of the operation.


id: Collection::remove
type: function
doc:
<comment>Description:</comment>
  Remove collection documents
  
  Removes documents of a collection that meet specific search conditions. Multiple operations are
  allowed, and parameter binding is supported.

<comment>Param:</comment>
  <info>string</info>  <strong>$search_condition</strong>  Must be a valid SQL expression used to match the documents to remove.
                             This expression might be as simple as <info>true</info>, which matches all
                             documents, or it might use functions and operators such as  'CAST(_id
                             AS SIGNED) &gt;= 10',  'age MOD 2 = 0 OR age MOD 3 = 0', or '_id IN
                             ["2","5","7","10"]'.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  If the operation is not executed, then the function will return  a
                                  Remove object that can be used to add additional remove
                                  operations.
                                  
                                  If the remove operation is executed, then the returned object will
                                  contain the result of the operation.


id: Collection::removeOne
type: function
doc:
<comment>Description:</comment>
  Remove one collection document
  
  Remove one document from the collection with the correspending ID.  This is a shortcut for
  Collection.remove("_id = :id").bind("id", id).execute().

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  The ID of the collection document to remove. Typically this is the _id that was
               generated by MySQL Server when the record was added.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object that can be used to query the number of affected items or
                        the number warnings generated by the operation.


id: Collection::replaceOne
type: function
doc:
<comment>Description:</comment>
  Replace one collection document
  
  Updates (or replaces) the document identified by ID, if it exists.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>   ID of the document to replace or update. Typically this is the _id that was
                generated by MySQL Server when the record was added.
  <info>string</info>  <strong>$doc</strong>  Collection document to update or replace the document matching the id parameter.
                
                This document can be either a document object or a valid JSON string  describing the
                new document.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object that can be used to query the number of affected items and
                        the number warnings generated by the operation.


id: CollectionAdd::__construct
type: function
doc:
<comment>Description:</comment>
  CollectionAdd constructor
  
  Use to add a document to a collection; called from a Collection object.


id: CollectionAdd::execute
type: function
doc:
<comment>Description:</comment>
  Execute the statement
  
  The execute method is required to send the CRUD operation request to the MySQL server.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object that can be used to verify the status of the operation, such
                        as the number of affected rows.


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


id: CollectionFind::bind
type: function
doc:
<comment>Description:</comment>
  Bind value to query placeholder
  
  It allows the user to bind a parameter to the placeholder in the search condition of the find
  operation. The placeholder has the form of :NAME where ':' is a common prefix that must always
  exists before any NAME, NAME is the actual name of the placeholder. The bind function accepts a
  list of placeholders if multiple entities have to be substituted in the search condition.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Values to substitute in the search condition; multiple values are
                              allowed and are passed as an array where "PLACEHOLDER_NAME =&gt;
                              PLACEHOLDER_VALUE".

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object,  or chain with execute() to return a Result
                                object.


id: CollectionFind::execute
type: function
doc:
<comment>Description:</comment>
  Execute the statement
  
  Execute the find operation; this functionality allows for method chaining.

<comment>Return:</comment>
  <info>mysql_xdevapi\DocResult</info>  A <class>mysql_xdevapi\DocResult</class> object that can be used to either fetch results
                           from, or to query the status of the operation.


id: CollectionFind::fields
type: function
doc:
<comment>Description:</comment>
  Set document field filter
  
  Defines the columns for the query to return. If not defined, all columns are used.

<comment>Param:</comment>
  <info>string</info>  <strong>$projection</strong>  Can either be a single string or an array of strings identifying the columns
                       to be returned for each document that match the search condition.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used for further processing.


id: CollectionFind::groupBy
type: function
doc:
<comment>Description:</comment>
  Set grouping criteria
  
  This function can be used to group the result set by one or more columns. It is often used with
  aggregate functions such as <return>COUNT</return>, <return>MAX</return>, <return>MIN</return>, <return>SUM</return> etc.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  The column or columns that have to be used for the group operation, this can
                      either be a single string or an array of string arguments, one for each
                      column.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used for further processing.


id: CollectionFind::having
type: function
doc:
<comment>Description:</comment>
  Set condition for aggregate functions
  
  This function can be used after the 'field' operation in order to make a selection on the
  documents to extract.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  This must be a valid SQL expression, the use of aggreate functions is allowed

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  CollectionFind object that can be used for further processing


id: CollectionFind::limit
type: function
doc:
<comment>Description:</comment>
  Limit number of returned documents
  
  Set the maximum number of documents to return.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  Maximum number of documents.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used for additional processing;
                                chain with the execute() method to return a DocResult object.


id: CollectionFind::lockExclusive
type: function
doc:
<comment>Description:</comment>
  Execute operation with EXCLUSIVE LOCK
  
  Locks the document exclusively. As long as the document is locked, other transactions can't update
  the document, use SELECT ... LOCK IN SHARE MODE, or read the data in certain transaction isolation
  levels. Consistent reads ignore any locks set on the records that exist in the read view.
  
  To avoid concurrency problems, it makes sense to use this function with the
  mysql_xdevapi\Collection::modify method. Essentially, this function uses row locks to serialise
  access to rows.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  Optional waiting option. By default it is <info>MYSQLX_LOCK_DEFAULT</info>. Valid
                             values are these constants:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  Returns a CollectionFind object that can be used for further
                                processing.


id: CollectionFind::lockShared
type: function
doc:
<comment>Description:</comment>
  Execute operation with SHARED LOCK
  
  Allows to share the documents between multiple transactions which are locking in shared mode.
  
  Other sessions can read the rows, but cannot modify them until your transaction commits.
  
  If any of these rows were changed by another transaction that hasn't been committed, the query
  will wait until that transaction has ended to be able to use the latest values.

<comment>Param:</comment>
  <info>int</info>  <strong>$lock_waiting_option</strong>  Optional waiting option. By default it is <info>MYSQLX_LOCK_DEFAULT</info>. Valid
                             values are these constants:
                             
                             <info>MYSQLX_LOCK_DEFAULT</info>
                             
                             <info>MYSQLX_LOCK_NOWAIT</info>
                             
                             <info>MYSQLX_LOCK_SKIP_LOCKED</info>

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used for further processing


id: CollectionFind::offset
type: function
doc:
<comment>Description:</comment>
  Skip given number of elements to be returned
  
  Skip (offset) these number of elements that otherwise would be returned by the find operation. Use
  with the limit() method.
  
  Defining an offset larger than the result set size results in an empty set.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  Number of elements to skip for the limit() operation.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used for additional processing.


id: CollectionFind::sort
type: function
doc:
<comment>Description:</comment>
  Set the sorting criteria
  
  Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC
  (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and
  it follows the same set of rules.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  One or more sorting expressions can be provided. The evaluation is from left
                      to right, and each expression is separated by a comma.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionFind</info>  A CollectionFind object that can be used to execute the command, or
                                to add additional operations.


id: CollectionModify::__construct
type: function
doc:
<comment>Description:</comment>
  CollectionModify constructor
  
  Modifies (updates) a collection and is instantiated by the mysql_xdevapi\Collection::modify
  method.


id: CollectionModify::arrayAppend
type: function
doc:
<comment>Description:</comment>
  Append element to an array field
  
  Add an element to a document's field, as multiple elements of a field are represented as an array.
  Unlike arrayInsert(), arrayAppend() always appends the new element at the end of the array,
  whereas arrayInsert() can define the location.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       The identifier of the field where the new element is inserted.
  <info>string</info>  <strong>$expression_or_literal</strong>  The new element to insert at the end of the document field array.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object that can be used to execute the command,
                                  or to add additional operations.


id: CollectionModify::arrayInsert
type: function
doc:
<comment>Description:</comment>
  Insert element into an array field
  
  Adds an element to a document's field, as multiple elements of a field are represented as an
  array. Unlike mysql_xdevapi\CollectionModify::arrayAppend this method allows to specify where the
  new element is inserted by defining which item it is after, whereas
  mysql_xdevapi\CollectionModify::arrayAppend always appends the new element at the end of the
  array.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       Identifies the item in the array after which the new element will
                                  be inserted. The format of this parameter is <return>FIELD_NAME[ INDEX ]</return>
                                  where FIELD_NAME is the name of the document field to add the
                                  element to, and INDEX is the INDEX of the element within the
                                  field.
                                  
                                  The INDEX field is zero based, so the first item of the array has
                                  an index of 0.
  <info>string</info>  <strong>$expression_or_literal</strong>  The new element to insert after FIELD_NAME[ INDEX ]

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object that can be used to execute the command,
                                  or to add additional operations


id: CollectionModify::bind
type: function
doc:
<comment>Description:</comment>
  Bind value to query placeholder
  
  Bind a parameter to the placeholder in the search condition of the modify operation.
  
  The placeholder has the form of :NAME where ':' is a common prefix that must always exists before
  any NAME where NAME is the name of the placeholder. The bind method accepts a list of placeholders
  if multiple entities have to be substituted in the search condition of the modify operation.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Placeholder values to substitute in the search condition. Multiple
                              values are allowed and have to be passed as an array of mappings
                              PLACEHOLDER_NAME-&gt;PLACEHOLDER_VALUE.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object that can be used to execute the command,
                                  or to add additional operations.


id: CollectionModify::execute
type: function
doc:
<comment>Description:</comment>
  Execute modify operation
  
  The execute method is required to send the CRUD operation request to the MySQL server.

<comment>Return:</comment>
  <info>mysql_xdevapi\Result</info>  A Result object that can be used to verify the status of the operation, such
                        as the number of affected rows.


id: CollectionModify::limit
type: function
doc:
<comment>Description:</comment>
  Limit number of modified documents
  
  Limit the number of documents modified by this operation. Optionally combine with skip() to define
  an offset value.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of documents to modify.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object.


id: CollectionModify::patch
type: function
doc:
<comment>Description:</comment>
  Patch document
  
  Takes a patch object and applies it on one or more documents, and can update multiple document
  properties.

<comment>Param:</comment>
  <info>string</info>  <strong>$document</strong>  A document with the properties to apply to the matching documents.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object.


id: CollectionModify::replace
type: function
doc:
<comment>Description:</comment>
  Replace document field
  
  Replace (update) a given field value with a new one.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       The document path of the item to set.
  <info>string</info>  <strong>$expression_or_literal</strong>  The value to set on the specified attribute.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object.


id: CollectionModify::set
type: function
doc:
<comment>Description:</comment>
  Set document attribute
  
  Sets or updates attributes on documents in a collection.

<comment>Param:</comment>
  <info>string</info>  <strong>$collection_field</strong>       The document path (name) of the item to set.
  <info>string</info>  <strong>$expression_or_literal</strong>  The value to set it to.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object.


id: CollectionModify::skip
type: function
doc:
<comment>Description:</comment>
  Skip elements
  
  Skips the first N elements that would otherwise be returned by a find operation. If the number of
  elements skipped is larger than the size of the result set, then the find operation returns an
  empty set.

<comment>Param:</comment>
  <info>int</info>  <strong>$position</strong>  Number of elements to skip.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  A CollectionModify object to use for further processing.


id: CollectionModify::sort
type: function
doc:
<comment>Description:</comment>
  Set the sorting criteria
  
  Sorts the result set by the field selected in the sort_expr argument. The allowed orders are ASC
  (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and
  it follows the same set of rules.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  One or more sort expressions can be provided. The evaluation is from left to
                      right and each expression must be separated by a comma.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  CollectionModify object that can be used for further processing.


id: CollectionModify::unset
type: function
doc:
<comment>Description:</comment>
  Unset the value of document fields
  
  Removes attributes from documents in a collection.

<comment>Param:</comment>
  <info>array</info>  <strong>$fields</strong>  The attributes to remove from documents in a collection.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionModify</info>  CollectionModify object that can be used for further processing.


id: CollectionRemove::__construct
type: function
doc:
<comment>Description:</comment>
  CollectionRemove constructor
  
  Removes collection documents and is instantiated by the mysql_xdevapi\Collection::remove method.


id: CollectionRemove::bind
type: function
doc:
<comment>Description:</comment>
  Bind value to placeholder
  
  Bind a parameter to the placeholder in the search condition of the remove operation.
  
  The placeholder has the form of :NAME where ':' is a common prefix that must always exists before
  any NAME where NAME is the name of the placeholder. The bind method accepts a list of placeholders
  if multiple entities have to be substituted in the search condition of the remove operation.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  Placeholder values to substitute in the search condition. Multiple
                              values are allowed and have to be passed as an array of mappings
                              PLACEHOLDER_NAME-&gt;PLACEHOLDER_VALUE.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  A CollectionRemove object that can be used to execute the command,
                                  or to add additional operations.


id: CollectionRemove::execute
type: function
doc:
<comment>Description:</comment>
  Execute remove operation
  
  The execute function needs to be invoked in order to trigger the client to send the CRUD operation
  request to the server.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: CollectionRemove::limit
type: function
doc:
<comment>Description:</comment>
  Limit number of documents to remove
  
  Sets the maximum number of documents to remove.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of documents to remove.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  Returns a CollectionRemove object that can be used to execute the
                                  command, or to add additional operations.


id: CollectionRemove::sort
type: function
doc:
<comment>Description:</comment>
  Set the sorting criteria
  
  Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC
  (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and
  it follows the same set of rules.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  One or more sorting expressions can be provided. The evaluation is from left
                      to right, and each expression is separated by a comma.

<comment>Return:</comment>
  <info>mysql_xdevapi\CollectionRemove</info>  A CollectionRemove object that can be used to execute the command,
                                  or to add additional operations.


id: ColumnResult::__construct
type: function
doc:
<comment>Description:</comment>
  ColumnResult constructor
  
  Retrieves column metadata, such as its character set; this is instantiated by the
  mysql_xdevapi\RowResult::getColumns method.


id: ColumnResult::getCharacterSetName
type: function
doc:
<comment>Description:</comment>
  Get character set
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: ColumnResult::getCollationName
type: function
doc:
<comment>Description:</comment>
  Get collation name
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


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

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


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

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


id: ColumnResult::getFractionalDigits
type: function
doc:
<comment>Description:</comment>
  Get fractional digit length
  
  Fetch the number of fractional digits for column.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


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

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


id: ColumnResult::getSchemaName
type: function
doc:
<comment>Description:</comment>
  Get schema name
  
  Fetch the schema name where the column is stored.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: ColumnResult::getTableLabel
type: function
doc:
<comment>Description:</comment>
  Get table label
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: ColumnResult::getTableName
type: function
doc:
<comment>Description:</comment>
  Get table name
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>string</info>  Name of the table for the column.


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

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


id: ColumnResult::isNumberSigned
type: function
doc:
<comment>Description:</comment>
  Check if signed type
  
  Retrieves a table's column information and is instantiated by the
  mysql_xdevapi\RowResult::getColumns method.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>int</info>  <info>true</info> if a given column as a signed type.


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

<comment>Return:</comment>
  <info>int</info>  <info>true</info> if a given column is padded.


id: CommonMark\CQL
type: class
doc:
<comment>Description:</comment>
  CommonMark Query Language is a DSL for describing how to travel through a CommonMark Node tree
  implemented as a parser and compiler for a small set of instructions, and a virtual machine for
  executing those instructions.
  
  In it's most simplistic form, a CQL query combines the following paths and <return>/</return> to describe how to
  travel through a tree: firstChildlastChildpreviousnextparent For example, <return>/firstChild/lastChild</return>
  would travel to the last child node of the first child node.
  
  CQL can be instructed to loop, for example through the children of, or siblings to a particular
  node, by using the path <return>children</return>, or <return>siblings</return>. For example, <return>/firstChild/children</return> will travel to
  all the children of the first child node.
  
  CQL can be instructed how to travel by using a subquery like <return>[/firstChild]</return>. For example,
  <return>/firstChild/children[/firstChild]</return> will travel to the first child node of all the children of the
  first child node.
  
  While looping, CQL can be instructed to constrict the travelled path to nodes of particular type.
  For example <return>/children(BlockQuote)</return> will travel to the children of a node where the type is
  <return>BlockQuote</return>. The following types are recognized (case insensitively):
  BlockQuoteListItemCodeBlockHtmlBlockCustomBlockParagraphHeadingThematicBreakTextSoftBreakLineBreakCodeHtmlInlineCustomInlineEmphasisStrongLinkImage
  Types may be used as a union, for example <return>/children(BlockQuote|List)</return> will travel to the children
  of a node where the type is <return>BlockQuote</return> or <return>List</return>. Types, or unions of types, may be also negated.
  For example <return>/children(~BlockQuote)</return> will travel to the children of a node where the type is not
  <return>BlockQuote</return>, and <return>/children(~BlockQuote|Paragraph)</return> will travel to the children of a node where the
  type is not <return>BlockQuote</return> or <return>Paragraph</return>
  
  CQL can be instructed to create a loop to travel to a node of a particular type, at a particular
  path. For example, <return>/firstChild(BlockQuote)</return> will travel to the first child node where the type is
  <return>BlockQuote</return>. Note that like other loops for <return>children</return> and <return>siblings</return>, this kind of path can only be
  followed by a subquery.
  
  While CQL has been implemented as part of the PHP CommonMark extension, it stands separately from
  PHP and does not use PHP's virtual machine or internal representation of values.


id: CommonMark\CQL::__construct
type: function
doc:
<comment>Description:</comment>
  CQL Construction

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  a CQL string


id: CommonMark\CQL::__invoke
type: function
doc:
<comment>Description:</comment>
  CQL Execution
  
  Shall invoke the current CQL function on the given <strong>$root</strong>, executing the given <strong>$handler</strong> on entry to
  a <info>CommonMark\Node</info>

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$root</strong>     the root node of a tree
  <info>callable</info>         <strong>$handler</strong>  should have the prototype:
                             <info>bool</info><info>null</info></info>handler<info>CommonMark\Node</info><strong>$root</strong><info>CommonMark\Node</info><strong>$entering</strong> Should
                             <strong>$handler</strong> fail to return (void), or return <info>null</info>, CQL will continue
                             executingShould the handler return a truthy value, CQL will continue
                             executing.Should the handler return a falsy value, CQL will stop
                             executing


id: CommonMark\Interfaces\IVisitable::accept
type: function
doc:
<comment>Description:</comment>
  Visitation

<comment>Param:</comment>
  <info>CommonMark\Interfaces\IVisitor</info>  <strong>$visitor</strong>  An object implementing <class>CommonMark\Interfaces\IVisitor</class>

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

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


id: CommonMark\Interfaces\IVisitor::enter
type: function
doc:
<comment>Description:</comment>
  Visitation

<comment>Param:</comment>
  <info>IVisitable</info>  <strong>$visitable</strong>  The current <class>CommonMark\Interfaces\IVisitable</class> being entered

<comment>Return:</comment>
  <info>int|IVisitable|null</info>  Returning CommonMark\Interfaces\IVisitor::Done will cause the backing
                       iterator to exit.
                       
                       Returning CommonMark\Interfaces\IVisitor::Enter will reset the backing
                       iterator at entering the current <class>IVisitable</class>
                       
                       Returning CommonMark\Interfaces\IVisitor::Leave will reset the backing
                       iterator at exiting the current <class>IVisitable</class>
                       
                       Returning an <class>IVisitable</class> will reset the backing iterator at entering the given
                       <class>IVisitable</class>
                       
                       Returning nothing will allow the backing iterator to continue

<comment>See Also:</comment>
   * 


id: CommonMark\Interfaces\IVisitor::leave
type: function
doc:
<comment>Description:</comment>
  Visitation

<comment>Param:</comment>
  <info>IVisitable</info>  <strong>$visitable</strong>  The current <class>CommonMark\Interfaces\IVisitable</class> being exited

<comment>Return:</comment>
  <info>int|IVisitable|null</info>  Returning CommonMark\Interfaces\IVisitor::Done will cause the backing
                       iterator to exit.
                       
                       Returning CommonMark\Interfaces\IVisitor::Enter will reset the backing
                       iterator at entering the current <class>IVisitable</class>
                       
                       Returning CommonMark\Interfaces\IVisitor::Leave will reset the backing
                       iterator at exiting the current <class>IVisitable</class>
                       
                       Returning an <class>IVisitable</class> will reset the backing iterator at exiting the given
                       <class>IVisitable</class>
                       
                       Returning nothing will allow the backing iterator to continue

<comment>See Also:</comment>
   * 


id: CommonMark\Node
type: class
doc:
<comment>Description:</comment>
  Represents an Abstract Node, this final abstract is not for direct use by the programmer.


id: CommonMark\Node::appendChild
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$child</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::insertAfter
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$sibling</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::replace
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$target</strong>  

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Node::unlink
type: function
doc:
<comment>Description:</comment>
  AST Manipulation
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: CommonMark\Node\BulletList::__construct
type: function
doc:
<comment>Description:</comment>
  BulletList Construction
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.


id: CommonMark\Node\CodeBlock::__construct
type: function
doc:
<comment>Description:</comment>
  CodeBlock Construction
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$fence</strong>    
  <info>string</info>  <strong>$literal</strong>  


id: CommonMark\Node\Heading::__construct
type: function
doc:
<comment>Description:</comment>
  Heading Construction
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.


id: CommonMark\Node\Image::__construct
type: function
doc:
<comment>Description:</comment>
  Image Construction
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>    
  <info>string</info>  <strong>$title</strong>  


id: CommonMark\Node\Link::__construct
type: function
doc:
<comment>Description:</comment>
  Link Construction
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$url</strong>    
  <info>string</info>  <strong>$title</strong>  


id: CommonMark\Node\OrderedList::__construct
type: function
doc:
<comment>Description:</comment>
  OrderedList Construction
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>  <strong>$tight</strong>      
  <info>int</info>  <strong>$delimiter</strong>  
  <info>int</info>  <strong>$start</strong>      


id: CommonMark\Node\Text::__construct
type: function
doc:
<comment>Description:</comment>
  Text Construction
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: CommonMark\Parse
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  Shall parse <strong>$content</strong>

<comment>Param:</comment>
  <info>string</info>  <strong>$content</strong>  markdown string
  <info>int</info>     <strong>$options</strong>  A mask of:

<comment>Return:</comment>
  <info>CommonMark\Node</info>  Shall return root CommonMark\Node


id: CommonMark\Parser
type: class
doc:
<comment>Description:</comment>
  Provides an incremental parser as an alternative to the simple Parsing API function


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

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  A mask of:


id: CommonMark\Parser::finish
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>CommonMark\Node</info>  


id: CommonMark\Parser::parse
type: function
doc:
<comment>Description:</comment>
  Parsing
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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

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


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

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$node</strong>     
  <info>int</info>              <strong>$options</strong>  A mask of:
  <info>int</info>              <strong>$width</strong>    

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


id: CommonMark\Render\HTML
type: function
doc:
<comment>Description:</comment>
  Rendering
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>CommonMark\Node</info>  <strong>$node</strong>     
  <info>int</info>              <strong>$options</strong>  A mask of:

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


id: Componere\Abstract\Definition
type: class
doc:
<comment>Description:</comment>
  This final abstract represents a class entry, and should not be used by the programmer.


id: Componere\Abstract\Definition::addInterface
type: function
doc:
<comment>Description:</comment>
  Add Interface
  
  Shall implement the given interface on the current definition

<comment>Param:</comment>
  <info>string</info>  <strong>$interface</strong>  The case insensitive name of an interface

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::addMethod
type: function
doc:
<comment>Description:</comment>
  Add Method
  
  Shall create or override a method on the current definition.

<comment>Param:</comment>
  <info>string</info>            <strong>$name</strong>    The case insensitive name for method
  <info>Componere\Method</info>  <strong>$method</strong>  <info>Componere\Method</info> not previously added to another <info>Definition</info>

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::addTrait
type: function
doc:
<comment>Description:</comment>
  Add Trait
  
  Shall use the given trait for the current definition

<comment>Param:</comment>
  <info>string</info>  <strong>$trait</strong>  The case insensitive name of a trait

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Abstract\Definition::getReflector
type: function
doc:
<comment>Description:</comment>
  Reflection
  
  Shall create or return a ReflectionClass

<comment>Return:</comment>
  <info>ReflectionClass</info>  A ReflectionClass for the current definition (cached)


id: Componere\Definition
type: class
doc:
<comment>Description:</comment>
  The Definition class allows the programmer to build and register a type at runtime.
  
  Should a Definition replace an existing class, the existing class will be restored when the
  Definition is destroyed.


id: Componere\Definition::__construct
type: function
doc:
<comment>Description:</comment>
  Definition Construction

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>        A case insensitive class name
  <info>string</info>  <strong>$parent</strong>      A case insensitive class name
  <info>array</info>   <strong>$interfaces</strong>  An array of case insensitive class names


id: Componere\Definition::addConstant
type: function
doc:
<comment>Description:</comment>
  Add Constant
  
  Shall declare a class constant on the current Definition

<comment>Param:</comment>
  <info>string</info>           <strong>$name</strong>   The case sensitive name for the constant
  <info>Componere\Value</info>  <strong>$value</strong>  The Value for the constant, must not be undefined or static

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Definition::addProperty
type: function
doc:
<comment>Description:</comment>
  Add Property
  
  Shall declare a class property on the current Definition

<comment>Param:</comment>
  <info>string</info>           <strong>$name</strong>   The case sensitive name for the property
  <info>Componere\Value</info>  <strong>$value</strong>  The default Value for the property

<comment>Return:</comment>
  <info>Definition</info>  The current Definition


id: Componere\Definition::getClosure
type: function
doc:
<comment>Description:</comment>
  Get Closure
  
  Shall return a Closure for the method specified by name

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The case insensitive name of the method

<comment>Return:</comment>
  <info>Closure</info>  A Closure bound to the correct scope


id: Componere\Definition::getClosures
type: function
doc:
<comment>Description:</comment>
  Get Closures
  
  Shall return an array of Closures

<comment>Return:</comment>
  <info>array</info>  Shall return all methods as an array of Closure objects bound to the correct scope


id: Componere\Definition::isRegistered
type: function
doc:
<comment>Description:</comment>
  State Detection
  
  Shall detect the registration state of this Definition

<comment>Return:</comment>
  <info>bool</info>  Shall return true if this Definition is registered


id: Componere\Definition::register
type: function
doc:
<comment>Description:</comment>
  Registration
  
  Shall register the current Definition

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


id: Componere\Method
type: class
doc:
<comment>Description:</comment>
  A Method represents a function with modifiable accessibility flags


id: Componere\Method::__construct
type: function
doc:
<comment>Description:</comment>
  Method Construction

<comment>Param:</comment>
  <info>Closure</info>  <strong>$closure</strong>  


id: Componere\Method::getReflector
type: function
doc:
<comment>Description:</comment>
  Reflection
  
  Shall create or return a ReflectionMethod

<comment>Return:</comment>
  <info>ReflectionMethod</info>  A ReflectionMethod for the current method (cached)


id: Componere\Method::setPrivate
type: function
doc:
<comment>Description:</comment>
  Accessibility Modification

<comment>Return:</comment>
  <info>Method</info>  The current Method


id: Componere\Patch
type: class
doc:
<comment>Description:</comment>
  The Patch class allows the programmer to change the type of an instance at runtime without
  registering a new Definition
  
  When a Patch is destroyed it is reverted, so that instances that were patched during the lifetime
  of the Patch are restored to their formal type.


id: Componere\Patch::__construct
type: function
doc:
<comment>Description:</comment>
  Patch Construction

<comment>Param:</comment>
  <info>object</info>  <strong>$instance</strong>    The target for this Patch
  <info>array</info>   <strong>$interfaces</strong>  A case insensitive array of class names


id: Componere\Patch::apply
type: function
doc:
<comment>Description:</comment>
  Application
  
  Shall apply the current patch

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


id: Componere\Patch::derive
type: function
doc:
<comment>Description:</comment>
  Patch Derivation
  
  Shall derive a <info>Patch</info> for the given <strong>$instance</strong>

<comment>Param:</comment>
  <info>object</info>  <strong>$instance</strong>  The target for the derived Patch

<comment>Return:</comment>
  <info>Patch</info>  <info>Patch</info> for <strong>$instance</strong> derived from the current <info>Patch</info>


id: Componere\Patch::getClosure
type: function
doc:
<comment>Description:</comment>
  Get Closure
  
  Shall return a Closure for the method specified by name

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The case insensitive name of the method

<comment>Return:</comment>
  <info>Closure</info>  A Closure bound to the correct scope and object


id: Componere\Patch::getClosures
type: function
doc:
<comment>Description:</comment>
  Get Closures
  
  Shall return an array of Closures

<comment>Return:</comment>
  <info>array</info>  Shall return all methods as an array of Closure objects bound to the correct scope and
         object


id: Componere\Patch::isApplied
type: function
doc:
<comment>Description:</comment>
  State Detection

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


id: Componere\Patch::revert
type: function
doc:
<comment>Description:</comment>
  Reversal
  
  Shall revert the current patch

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


id: Componere\Value
type: class
doc:
<comment>Description:</comment>
  A Value represents a PHP variable of all types, including undefined


id: Componere\Value::__construct
type: function
doc:
<comment>Description:</comment>
  Value Construction

<comment>Param:</comment>
  <info></info>  <strong>$default</strong>  


id: Componere\Value::hasDefault
type: function
doc:
<comment>Description:</comment>
  Value Interaction

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


id: Componere\Value::isPrivate
type: function
doc:
<comment>Description:</comment>
  Accessibility Detection

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


id: Componere\Value::setPrivate
type: function
doc:
<comment>Description:</comment>
  Accessibility Modification

<comment>Return:</comment>
  <info>Value</info>  The current Value


id: Componere\cast
type: function
doc:
<comment>Description:</comment>
  Casting

<comment>Param:</comment>
  <info>Type</info>  <strong>$type</strong>    A user defined type
  <info></info>      <strong>$object</strong>  An object with a user defined type compatible with Type

<comment>Return:</comment>
  <info>Type</info>  An <info>object</info> of type Type, cast from <strong>$object</strong>

<comment>See Also:</comment>
   * 


id: Componere\cast_by_ref
type: function
doc:
<comment>Description:</comment>
  Casting

<comment>Param:</comment>
  <info></info>  <strong>$object</strong>  An object with a user defined type compatible with Type

<comment>Return:</comment>
  <info>Type</info>  An <info>object</info> of type Type, cast from <strong>$object</strong>, where members are references to <strong>$object</strong> members

<comment>See Also:</comment>
   * 


id: Countable
type: class
doc:
<comment>Description:</comment>
  Les classes qui implémentent l'interface <class>Countable</class> peuvent être utilisées avec la fonction
  <strong>count()</strong>.


id: Countable::count
type: function
doc:
<comment>Description:</comment>
  Compte le nombre d'éléments d'un objet
  
  <strong>Countable::count()</strong> est exécutée lorsque la fonction <strong>count()</strong> est appelée  sur un objet qui
  implémente l'interface  <class>Countable</class>.

<comment>Return:</comment>
  <info>int</info>  Le nombre compté, sous forme <info>int</info>.
       
       La valeur retournée est forcée en <info>int</info>.


id: CrudOperationBindable::bind
type: function
doc:
<comment>Description:</comment>
  Bind value to placeholder
  
  Binds a value to a specific placeholder.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>array</info>  <strong>$placeholder_values</strong>  The name of the placeholders and the values to bind.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationBindable</info>  A CrudOperationBindable object.


id: CrudOperationLimitable::limit
type: function
doc:
<comment>Description:</comment>
  Set result limit
  
  Sets the maximum number of records or documents to return.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  The maximum number of records or documents.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationLimitable</info>  A CrudOperationLimitable object.


id: CrudOperationSkippable::skip
type: function
doc:
<comment>Description:</comment>
  Number of operations to skip
  
  Skip this number of records in the returned operation.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>int</info>  <strong>$skip</strong>  Number of elements to skip.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationSkippable</info>  A CrudOperationSkippable object.


id: CrudOperationSortable::sort
type: function
doc:
<comment>Description:</comment>
  Sort results
  
  Sort the result set by the field selected in the sort_expr argument. The allowed orders are ASC
  (Ascending) or DESC (Descending). This operation is equivalent to the 'ORDER BY' SQL operation and
  it follows the same set of rules.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$sort_expr</strong>  One or more sorting expressions can be provided. The evaluation is from left
                      to right, and each expression is separated by a comma.

<comment>Return:</comment>
  <info>mysql_xdevapi\CrudOperationSortable</info>  A CrudOperationSortable object.


id: CurlHandle
type: class
doc:
<comment>Description:</comment>
  Une classe totalement opaque qui remplace les ressources <return>curl</return> à partir de PHP 8.0.0.


id: CurlMultiHandle
type: class
doc:
<comment>Description:</comment>
  Une classe totalement opaque qui remplace les ressources <return>curl_multi</return> à partir de PHP 8.0.0.


id: CurlShareHandle
type: class
doc:
<comment>Description:</comment>
  Une classe totalement opaque qui remplace les ressources <return>curl_share</return> à partir de PHP 8.0.0.


id: DATE_ISO8601
type: constant
doc:
<comment>Description:</comment>
  ISO-8601 (exemple: 2005-08-15T15:52:01+0000)
  
  Ce format n'est pas compatible avec ISO-8601, mais reste ainsi pour des  raisons de compatibilité
  ascendante. Utilisez <info>DateTime::ISO8601_EXPANDED</info> ou <info>DateTimeInterface::ATOM</info> pour assurer la
  compatibilité avec  ISO-8601. (ref ISO8601:2004 section 4.3.3 clause d)


id: DATE_ISO8601_EXPANDED
type: constant
doc:
<comment>Description:</comment>
  ISO-8601 Expanded (exemple: +10191-07-26T08:59:52+01:00)
  
  Ce format permet des plages d'années en dehors de la plage normale de  ISO-8601 allant de <return>0000</return> à
  <return>9999</return> en  incluant toujours un caractère de signe. Il indique également que cette  partie de fuseau
  horaire (<return>+01:00</return>) est compatible avec  ISO-8601.


id: DATE_RFC3339_EXTENDED
type: constant
doc:
<comment>Description:</comment>
  RFC 3339 EXTENDED format (example: 2005-08-15T15:52:01.000+00:00)


id: DATE_RFC7231
type: constant
doc:
<comment>Description:</comment>
  RFC 7231 (à partir de PHP 7.0.19 et 7.1.5) (exemple: Sat, 30 Apr 2016 17:52:13 GMT)


id: DB2_BINARY
type: constant
doc:
<comment>Description:</comment>
  Spécifie que les données binaires seront retournées comme elles sont. Ceci est le mode par défaut.


id: DB2_CASE_LOWER
type: constant
doc:
<comment>Description:</comment>
  Spécifie que les noms de colonnes doivent être retournés en minuscule.


id: DB2_CASE_NATURAL
type: constant
doc:
<comment>Description:</comment>
  Spécifie que les noms de colonnes doivent être retournés dans leurs casses naturelles.


id: DB2_CASE_UPPER
type: constant
doc:
<comment>Description:</comment>
  Spécifie que les noms de colonnes doivent être retournés en majuscule.


id: DB2_CONVERT
type: constant
doc:
<comment>Description:</comment>
  Spécifie que les données binaires seront converties en hexadécimal et retournées comme une chaîne
  ASCII.


id: DB2_DEFERRED_PREPARE_OFF
type: constant
doc:
<comment>Description:</comment>
  Spécifie que la préparation déferrée doit être désactivée pour la ressource de requête spécifiée.


id: DB2_DEFERRED_PREPARE_ON
type: constant
doc:
<comment>Description:</comment>
  Spécifie que la préparation déferrée doit être active pour la ressource de requête spécifiée.


id: DB2_DOUBLE
type: constant
doc:
<comment>Description:</comment>
  Spécifie que la variable doit être lié à un type DOUBLE, FLOAT ou REAL.


id: DB2_FORWARD_ONLY
type: constant
doc:
<comment>Description:</comment>
  Spécifie un curseur d'avancement seul pour une déclaration de ressource. Il s'agit de la valeur
  par défaut de ce type de curseur, et il est supporté par tous les serveurs de base de données.


id: DB2_LONG
type: constant
doc:
<comment>Description:</comment>
  Spécifie que la variable doit être lié à un type SMALLINT, INTEGER ou BIGINT.


id: DB2_PARAM_FILE
type: constant
doc:
<comment>Description:</comment>
  Spécifie que la colonne doit être lié directement à un fichier pour entrée.


id: DB2_PARAM_IN
type: constant
doc:
<comment>Description:</comment>
  Spécifie que la variable PHP doit être lié comme étant un paramètre ENTRANT pour une procédure
  d'enregistrement.


id: DB2_PARAM_INOUT
type: constant
doc:
<comment>Description:</comment>
  Spécifie que la variable PHP doit être lié comme étant un paramètre ENTRANT/SORTANT pour une
  procédure d'enregistrement.


id: DB2_PARAM_OUT
type: constant
doc:
<comment>Description:</comment>
  Spécifie que la variable PHP doit être lié comme étant un paramètre SORTANT pour une procédure
  d'enregistrement.


id: DB2_PASSTHRU
type: constant
doc:
<comment>Description:</comment>
  Spécifie que les données binaires seront converties en valeur <info>null</info>.


id: DB2_SCROLLABLE
type: constant
doc:
<comment>Description:</comment>
  Spécifie le curseur flottant pour une déclaration de ressource. Ce mode permet un accès aléatoire
  aux lignes du jeu de résultats, mais présentement, il est supporté seulement par IBM DB2 Universal
  Database.


id: DBASE_RDONLY
type: constant
doc:
<comment>Description:</comment>
  Ouvre une base de donnée en lecture seule. Utilisé avec <strong>dbase_open()</strong>. (Disponible à partir de
  dbase 7.0.0)


id: DBASE_RDWR
type: constant
doc:
<comment>Description:</comment>
  Ouvre une base de donnée en lecture et écriture. Utilisé avec <strong>dbase_open()</strong>. (Disponible à partir
  de dbase 7.0.0)


id: DBASE_TYPE_DBASE
type: constant
doc:
<comment>Description:</comment>
  Créer une base de donnée style dBASE. Utilisé avec <strong>dbase_create()</strong>. (Disponible à partir de dbase
  7.0.0)


id: DBASE_TYPE_FOXPRO
type: constant
doc:
<comment>Description:</comment>
  Créer une base de donnée style FoxPro. Utilisé avec <strong>dbase_create()</strong>. (Disponible à partir de dbase
  7.0.0)


id: DBA_LMDB_NO_SUB_DIR
type: constant
doc:
<comment>Description:</comment>
  Drapeau du pilote LMDB pour interdire la création d'un sous-répertoire pour les fichiers de base
  de données. Disponible à partir de PHP 8.2.0.


id: DBA_LMDB_USE_SUB_DIR
type: constant
doc:
<comment>Description:</comment>
  Drapeau du pilote LMDB pour permettre la création d'un sous-répertoire pour les fichiers de base
  de données. Disponible à partir de PHP 8.2.0.


id: DISP_E_BADINDEX
type: constant
doc:
<comment>Description:</comment>
  -2147352565
  
  Une erreur qui indique qu'un index de tableau n'existe pas.
  
  À partir de PHP 7.0.0, la valeur est <return>2147614731</return> sur x64.


id: DISP_E_DIVBYZERO
type: constant
doc:
<comment>Description:</comment>
  -2147352558
  
  Une erreur retournée qui indique qu'une division par zéro a eu lieu.
  
  À partir de PHP 7.0.0, la valeur est <return>2147614738</return> sur x64.


id: DISP_E_OVERFLOW
type: constant
doc:
<comment>Description:</comment>
  -2147352566
  
  Une erreur qui indique qu'une valeur n'a pû être convertie en la représentation attendue.
  
  À partir de PHP 7.0.0, la valeur est <return>2147614730</return> de sur x64


id: DNS_ANY
type: constant
doc:
<comment>Description:</comment>
  Tous les champs. Sur la plupart des systèmes, cela retourne tous les champs, mais il ne faut pas
  s'y fier. Utilisez <info>DNS_ALL</info>.


id: DNS_CAA
type: constant
doc:
<comment>Description:</comment>
  Certification Authority Authorization Resource (disponible à partir de PHP 7.0.16 et 7.1.2)


id: DNS_HINFO
type: constant
doc:
<comment>Description:</comment>
  Champs d'informations d'hôte (HINFO) (voir la <return>Operating System Names</return> pour la signification de ces
  valeurs)


id: DOMAttr
type: class
doc:
<comment>Description:</comment>
  <class>DOMAttr</class> représente un attribut dans l'objet <class>DOMElement</class>.


id: DOMAttr::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DOMAttr
  
  Crée un nouvel objet <class>DOMAttr</class>. Cet objet est en lecture seule. Il peut être ajouté à un document,
  mais les nœuds additionnels ne peuvent pas être ajoutés à ce nœud tant que ce nœud est associé à
  un document. Pour créer un nœud accessible en écriture, utilisez .

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Le nom de l'attribut.
  <info>string</info>  <strong>$value</strong>  La valeur de l'attribut.

<comment>See Also:</comment>
   * DOMDocument::createAttribute


id: DOMAttr::isId
type: function
doc:
<comment>Description:</comment>
  Vérifie si l'attribut est un identifiant défini
    
  
  Cette fonction vérifie si l'attribut est un identifiant défini.
  
  En accord avec le standard DOM, ceci requiert une DTD qui définit l'attribut ID qui est du type
  ID. Vous devez valider votre document avec la fonction  ou la fonction
  <return>DOMDocument::validateOnParse</return> avant d'utiliser cette fonction.

<comment>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: DOMCdataSection
type: class
doc:
<comment>Description:</comment>
  <class>DOMCdataSection</class> hérite de la classe <class>DOMText</class> pour la représentation textuelle de la construction du
  bloc CData.


id: DOMCdataSection::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet DOMCdataSection
  
  Construit un nouveau nœud CDATA. Fonctionne comme la classe <class>DOMText</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  La valeur du nœud CDATA. Si non fourni, un nœud CDATA vide sera créé.

<comment>See Also:</comment>
   * DOMText::__construct
   * DOMDocument::createTextNode


id: DOMCharacterData
type: class
doc:
<comment>Description:</comment>
  Représente un nœud contenant des données. Aucun nœud ne correspond à cette classe, mais d'autres
  nœuds en hérite.


id: DOMCharacterData::after
type: function
doc:
<comment>Description:</comment>
  Adds nodes after the character data
  
  Adds the passed <strong>$nodes</strong> after the element.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nœuds à ajouter après le nœud. Les chaînes de caractères sont
                          automatiquement convertie en des nœuds textuels.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMCharacterData::before


id: DOMCharacterData::appendData
type: function
doc:
<comment>Description:</comment>
  Ajoute la chaîne à la fin des données dans le nœud
    
  
  Ajoute la chaîne <strong>$data</strong> à la fin des données dans le nœud.

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

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

<comment>See Also:</comment>
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::before
type: function
doc:
<comment>Description:</comment>
  Adds nodes before the node
  
  Adds the passed <strong>$nodes</strong> before the node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nœuds à ajouter avant le nœud. Les chaînes de caractères sont
                          automatiquement convertie en des nœuds de texte.

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMCharacterData::after


id: DOMCharacterData::deleteData
type: function
doc:
<comment>Description:</comment>
  Supprime une sous-chaîne dans le nœud
    
  
  Efface <strong>$count</strong> caractères à partir de la position <strong>$offset</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  La position à partir de laquelle on doit commencer à effacer.
  <info>int</info>  <strong>$count</strong>   Le nombre de caractères à effacer. SI la somme de <strong>$offset</strong> et de <strong>$count</strong> excède la
                longueur totale de la chaîne, alors tous les caractères jusqu'à la fin de la chaîne
                seront effacés.

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

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::insertData
type: function
doc:
<comment>Description:</comment>
  Insère une chaîne à la position spécifiée d'unité 16-bit
    
  
  Insère la chaîne <strong>$data</strong> à la position  <strong>$offset</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  La position de l'insertion.
  <info>string</info>  <strong>$data</strong>    La chaîne à insérer.

<comment>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>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::replaceData
   * DOMCharacterData::substringData


id: DOMCharacterData::remove
type: function
doc:
<comment>Description:</comment>
  Removes the character data
  
  Removes the character data.

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

<comment>See Also:</comment>
   * DOMChildNode::remove
   * DOMCharacterData::after
   * DOMCharacterData::before
   * DOMCharacterData::replaceWith
   * DOMNode::removeChild


id: DOMCharacterData::replaceData
type: function
doc:
<comment>Description:</comment>
  Remplace une sous-chaîne dans le nœud DOMCharacterData
    
  
  Remplace <strong>$count</strong> caractères en partant de la position <strong>$offset</strong> par les données <strong>$data</strong>.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>  La position à partir de laquelle on commence le remplacement.
  <info>int</info>     <strong>$count</strong>   Le nombre de caractères à remplacer. Si la somme de  <strong>$offset</strong> et de <strong>$count</strong>  excède
                   la longueur totale de la chaîne, alors tous les caractères jusqu'à la fin des
                   données seront remplacés.
  <info>string</info>  <strong>$data</strong>    La chaîne utilisée pour remplacer les caractères sélectionnés.

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

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::substringData


id: DOMCharacterData::replaceWith
type: function
doc:
<comment>Description:</comment>
  Replaces the character data with new nodes
  
  Replaces the character data with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Les nœuds de remplacement.

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

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMCharacterData::after
   * DOMCharacterData::before
   * DOMCharacterData::remove


id: DOMCharacterData::substringData
type: function
doc:
<comment>Description:</comment>
  Extrait un morceau de données dans le nœud
    
  
  Retourne la sous-chaîne spécifiée.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  La position du début de la chaîne à extraire.
  <info>int</info>  <strong>$count</strong>   Le nombre de caractères à extraire.

<comment>Return:</comment>
  <info>string|false</info>  La sous-chaîne spécifiée. Si la somme de <strong>$offset</strong>  et de <strong>$count</strong> excède la longueur
                totale de la chaîne, alors toutes les unités 16-bits jusqu'à la fin des données
                seront retournées.

<comment>See Also:</comment>
   * DOMCharacterData::appendData
   * DOMCharacterData::deleteData
   * DOMCharacterData::insertData
   * DOMCharacterData::replaceData


id: DOMChildNode::after
type: function
doc:
<comment>Description:</comment>
  Ajoute des nœuds après le nœud
  
  Ajoute les <strong>$nodes</strong> passés après le nœud.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nœuds à ajouter après le nœud. Les chaînes de caractères sont
                          automatiquement convertie en des nœuds textuels.

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMChildNode::remove
   * DOMChildNode::replaceWith
   * DOMNode::appendChild


id: DOMChildNode::before
type: function
doc:
<comment>Description:</comment>
  Ajoute des nœuds avant le nœud
  
  Ajoute les <strong>$nodes</strong> passés avant le nœud.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nœuds à ajouter avant le nœud. Les chaînes de caractères sont
                          automatiquement convertie en des nœuds de texte.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::remove
   * DOMChildNode::replaceWith


id: DOMChildNode::remove
type: function
doc:
<comment>Description:</comment>
  Supprime le nœud
  
  Supprime le nœud.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::before
   * DOMChildNode::replaceWith
   * DOMNode::removeChild


id: DOMChildNode::replaceWith
type: function
doc:
<comment>Description:</comment>
  Remplace le nœud par de nouveaux nœuds
  
  Remplace le nœud par les nouveaux <strong>$nodes</strong>. Une combinaison de DOMChildNode::remove et
  DOMChildNode::append.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Les nœuds de remplacement.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMChildNode::before
   * DOMChildNode::remove
   * DOMNode::replaceChild


id: DOMComment::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DOMComment
    
  
  Crée un nouvel objet <class>DOMComment</class>.  Cet objet est en lecture seule. Il peut être ajouté à un
  document, mais les nœuds additionnels ne peuvent pas être ajoutés à ce nœud tant que ce nœud n'est
  pas associé à un document. Pour créer un nœud accessible en écriture, utilisez .

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  La valeur du commentaire.

<comment>See Also:</comment>
   * DOMDocument::createComment


id: DOMDocument
type: class
doc:
<comment>Description:</comment>
  Représente un document HTML ou XML entier ; ce sera la racine de l'arbre document.


id: DOMDocument::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DOMDocument
    
  
  Crée un nouvel objet <class>DOMDocument</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$version</strong>   Le numéro de version du document en tant que partie de la déclaration XML.
  <info>string</info>  <strong>$encoding</strong>  L'encodage du document en tant que partie de la déclaration XML.

<comment>See Also:</comment>
   * DOMImplementation::createDocument


id: DOMDocument::adoptNode
type: function
doc:
<comment>Description:</comment>
  Transfer a node from another document
  
  Transfer a node from another document into the current document.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  The node to transfer.

<comment>Return:</comment>
  <info>DOMNode|false</info>  The node that was transfered, or <info>false</info> on error.

<comment>See Also:</comment>
   * DOMDocument::importNode


id: DOMDocument::append
type: function
doc:
<comment>Description:</comment>
  Appends nodes after the last child node
  
  Appends one or many <strong>$nodes</strong> to the list of children after the last child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Les nœuds à ajouter. Les chaînes de caractères sont automatiquement
                          convertie en des nœuds de texte.

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMDocument::prepend


id: DOMDocument::createAttribute
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel attribut
  
  Cette fonction crée une nouvelle instance de la classe  <class>DOMAttr</class>. Ce nœud ne sera pas affiché dans
  le document, à moins qu'il ne soit inséré avec <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$localName</strong>  Le nom de l'attribut.

<comment>Return:</comment>
  <info>DOMAttr|false</info>  Le nouveau <class>DOMAttr</class> ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createAttributeNS
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel attribut avec un espace de noms associé
    
  
  Cette fonction crée une nouvelle instance de la classe <class>DOMAttr</class>. Ce nœud ne sera pas affiché dans
  le document, à moins qu'il ne soit inséré avec <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      L'URI de l'espace de noms.
  <info>string</info>       <strong>$qualifiedName</strong>  Le nom de la balise et le préfixe de l'attribut, sous cette forme :
                               <return>préfixe:nomBalise</return>.

<comment>Return:</comment>
  <info>DOMAttr|false</info>  Le nouveau <class>DOMAttr</class> ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createCDATASection
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau nœud cdata
  
  Cette fonction crée une nouvelle instance de la classe <class>DOMCDATASection</class>.  Ce nœud ne sera pas
  affiché dans le document, à moins qu'il ne soit inséré avec <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Le contenu du cdata.

<comment>Return:</comment>
  <info>DOMCdataSection|false</info>  Le nouveau <class>DOMCDATASection</class> ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createComment
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau nœud de commentaire
  
  Cette fonction crée une nouvelle instance de la classe <class>DOMComment</class>. Ce nœud ne sera pas affiché
  dans le document, à moins qu'il ne soit inséré avec <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Le contenu du commentaire.

<comment>Return:</comment>
  <info>DOMComment</info>  Le nouveau <class>DOMComment</class>.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createDocumentFragment
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau fragment de document
  
  Cette fonction crée une nouvelle instance de la classe <class>DOMDocumentFragment</class>. Ce nœud ne sera pas
  affiché dans le document, à moins qu'il ne soit inséré avec <strong>DOMNode::appendChild()</strong>.

<comment>Return:</comment>
  <info>DOMDocumentFragment</info>  Le nouveau <class>DOMDocumentFragment</class>.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createElement
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau nœud
  
  Cette fonction crée une nouvelle instance de la classe <class>DOMElement</class>. Ce nœud ne sera pas affiché
  dans le document, à moins qu'il ne soit inséré avec <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info></info>        <strong>$name</strong>   Le nom du tag de l'élément.
  <info>string</info>  <strong>$value</strong>  La valeur de l'élément. Par défaut, un élément vide sera créé. La valeur peut
                  également être définie plus tard avec  DOMElement::$nodeValue.
                  
                  La valeur est utilisé textuellement à l'exception des références d'entités
                  \< et &gt; qui seront échappées. Notez que & doit être échappé manuellement ; sinon ceci est considéré comme le début d'une référence d'entité. De plus " ne sera pas échappé.

<comment>Return:</comment>
  <info>DOMElement|false</info>  Retourne une nouvelle instance de la classe  <class>DOMElement</class> ou <info>false</info> si une erreur
                    survient.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createElementNS
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau nœud avec un espace de noms associé
    
  
  Cette fonction crée un nouveau nœud avec un espace de noms associé. Ce nœud ne sera pas affiché
  dans le document, à moins qu'il ne soit inséré avec <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      L'URI de l'espace de noms.
  <info>string</info>       <strong>$qualifiedName</strong>  Le nom qualifié de l'élément, en tant que <return>préfixe:nomBalise</return>.
  <info>string</info>       <strong>$value</strong>          La valeur de l'élément. Par défaut, un élément vide sera créé. Vous
                               pouvez également définir la valeur plus tard en utilisant la fonction
                               DOMElement::$nodeValue.

<comment>Return:</comment>
  <info>DOMElement|false</info>  Un nouveau <class>DOMElement</class> ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createEntityReference
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau nœud de référence d'entité
  
  Cette fonction crée une nouvelle instance de la classe <class>DOMEntityReference</class>. Ce nœud ne sera pas
  affiché dans le document, à moins qu'il ne soit inséré avec <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Le contenu de la référence de l'entité, e.g. la référence de l'entité sans le <return>&</return>
                 initial et le <return>;</return> final.

<comment>Return:</comment>
  <info>DOMEntityReference|false</info>  Le nouveau <class>DOMEntityReference</class> ou <info>false</info>  si une erreur survient.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createProcessingInstruction
   * DOMDocument::createTextNode


id: DOMDocument::createProcessingInstruction
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau nœud PI
  
  Cette fonction crée une nouvelle instance de la classe <class>DOMProcessingInstruction</class>. Ce nœud ne sera
  pas affiché dans le document, à moins qu'il ne soit inséré avec <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$target</strong>  La cible de l'instruction gérée.
  <info>string</info>  <strong>$data</strong>    Le contenu de l'instruction gérée.

<comment>Return:</comment>
  <info>DOMProcessingInstruction|false</info>  Le nouveau <class>DOMProcessingInstruction</class> ou <info>false</info>  si une erreur
                                  survient.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createTextNode


id: DOMDocument::createTextNode
type: function
doc:
<comment>Description:</comment>
  Crée un nouveau nœud de texte
  
  Cette fonction crée une nouvelle instance de la classe <class>DOMText</class>. Ce nœud ne sera pas affiché dans
  le document, à moins qu'il ne soit inséré avec <strong>DOMNode::appendChild()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  Le contenu du texte.

<comment>Return:</comment>
  <info>DOMText</info>  Un nouveau <class>DOMText</class>.

<comment>See Also:</comment>
   * DOMNode::appendChild
   * DOMDocument::createAttribute
   * DOMDocument::createAttributeNS
   * DOMDocument::createCDATASection
   * DOMDocument::createComment
   * DOMDocument::createDocumentFragment
   * DOMDocument::createElement
   * DOMDocument::createElementNS
   * DOMDocument::createEntityReference
   * DOMDocument::createProcessingInstruction


id: DOMDocument::getElementById
type: function
doc:
<comment>Description:</comment>
  Cherche un élément avec un certain identifiant
  
  Cette fonction est similaire à la fonction   mais cherche un élément avec un identifiant donné.
  
  Pour que cette fonction fonctionne, vous devez soit définir les attributs ID avec  ou définir une
  DTD qui définit un attribut devant être de type ID. Dans le dernier cas, vous devez valider votre
  document avec  ou DOMDocument::$validateOnParse avant d'utiliser cette fonction.

<comment>Param:</comment>
  <info>string</info>  <strong>$elementId</strong>  La valeur de l'identifiant unique pour un élément.

<comment>Return:</comment>
  <info>DOMElement|null</info>  Retourne un <class>DOMElement</class> ou <info>null</info> si l'élément n'est pas trouvé.

<comment>See Also:</comment>
   * DOMDocument::getElementsByTagName


id: DOMDocument::getElementsByTagName
type: function
doc:
<comment>Description:</comment>
  Cherche tous les éléments qui ont le nom de la balise locale donné
  
  Cette fonction retourne une instance de la classe <class>DOMNodeList</class> contenant tous les éléments qui ont
  un nom de balise donné.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Le nom local (sans espace de nommage) de la balise à chercher. La valeur
                          spéciale <return>*</return> correspond à toutes les balises.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Un nouvel objet <class>DOMNodeList</class> contenant tous les éléments correspondants.

<comment>See Also:</comment>
   * DOMDocument::getElementsByTagNameNS


id: DOMDocument::getElementsByTagNameNS
type: function
doc:
<comment>Description:</comment>
  Recherche tous les éléments avec un nom de balise donné dans un espace de noms spécifié
    
  
  Retourne un <class>DOMNodeList</class> de tous les éléments avec un nom local donné et une URI d'espace de noms.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  L'URI de l'espace de noms des éléments à chercher. La valeur spéciale <return>"*"</return>
                           représente tous les espaces de noms. Passer <info>null</info> représente l'espace de
                           noms vide.
  <info>string</info>       <strong>$localName</strong>  Le nom local des éléments à chercher. La valeur spéciale <return>"*"</return> représente
                           tous les noms locaux.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Un nouvel objet <class>DOMNodeList</class> contenant tous les éléments trouvés.

<comment>See Also:</comment>
   * DOMDocument::getElementsByTagName


id: DOMDocument::importNode
type: function
doc:
<comment>Description:</comment>
  Importe un nœud dans le document courant
  
  Cette fonction retourne une copie du nœud à importer et l'associe avec le  document courant.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  Le nœud à importer.
  <info>bool</info>     <strong>$deep</strong>  Si défini à <info>true</info>, cette méthode importera récursivement le sous-arbre situé sous
                  le nœud <strong>$node</strong>.
                  
                  Pour copier les attributs des nœuds, le paramètre <strong>$deep</strong> doit être défini à <info>true</info>

<comment>Return:</comment>
  <info>DOMNode|false</info>  Le nœud copié ou <info>false</info> si la copie a échouée.


id: DOMDocument::load
type: function
doc:
<comment>Description:</comment>
  Charge du XML depuis un fichier
    
  
  Charge un document XML depuis un fichier.
  
  Les chemins de style Unix avec des antislash peuvent conduire à des réductions de performance sous
  les systèmes Windows ; assurez-vous d'appeler la fonction <strong>realpath()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le chemin vers le document XML.
  <info>int</info>     <strong>$options</strong>   L'opérateur <return>OR</return> des constantes d'options libxml.

<comment>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>
   * DOMDocument::loadXML
   * DOMDocument::save
   * DOMDocument::saveXML


id: DOMDocument::loadHTML
type: function
doc:
<comment>Description:</comment>
  Charge du code HTML à partir d'une chaîne de caractères
    
  
  Cette fonction analyse un document HTML contenu dans la chaîne <strong>$source</strong>. Contrairement au XML, le
  HTML n'a pas besoin d'être bien formé pour être chargé.
  
  Cette fonction analyse l'entrée à l'aide d'un analyseur HTML 4. Les règles d'analyse de HTML 5,
  que les navigateurs modernes utilisent, sont différentes. En fonction de l'entrée, il peut en
  résulter une structure DOM différente. Par conséquent, cette fonction ne peut pas être utilisée en
  toute sécurité pour assainir le code HTML.
  
  Par exemple, certains éléments HTML fermeront implicitement un élément parent lorsqu'ils seront
  rencontrés. Les règles de fermeture automatique des éléments parents diffèrent entre HTML 4 et
  HTML 5, de sorte que la structure DOM que <class>DOMDocument</class> voit peut être différente de la structure
  DOM qu'un navigateur web voit, ce qui peut permettre à un attaquant de briser le code HTML
  résultant.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>   La chaîne HTML.
  <info>int</info>     <strong>$options</strong>  Opération de 'OU' logique des constantes d'option libxml.

<comment>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>
   * DOMDocument::loadHTMLFile
   * DOMDocument::saveHTML
   * DOMDocument::saveHTMLFile


id: DOMDocument::loadHTMLFile
type: function
doc:
<comment>Description:</comment>
  Charge du HTML à partir d'un fichier
    
  
  Cette fonction analyse un document HTML contenu dans le fichier <strong>$filename</strong>. Contrairement au XML,
  le HTML n'a pas besoin d'être bien formé pour être chargé.
  
  Cette fonction analyse l'entrée à l'aide d'un analyseur HTML 4. Les règles d'analyse de HTML 5,
  que les navigateurs modernes utilisent, sont différentes. En fonction de l'entrée, il peut en
  résulter une structure DOM différente. Par conséquent, cette fonction ne peut pas être utilisée en
  toute sécurité pour assainir le code HTML.
  
  Par exemple, certains éléments HTML fermeront implicitement un élément parent lorsqu'ils seront
  rencontrés. Les règles de fermeture automatique des éléments parents diffèrent entre HTML 4 et
  HTML 5, de sorte que la structure DOM que <class>DOMDocument</class> voit peut être différente de la structure
  DOM qu'un navigateur web voit, ce qui peut permettre à un attaquant de briser le code HTML
  résultant.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le chemin vers le fichier HTML.
  <info>int</info>     <strong>$options</strong>   Opération de 'OU' logique des constantes d'option libxml.

<comment>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>
   * DOMDocument::loadHTML
   * DOMDocument::saveHTML
   * DOMDocument::saveHTMLFile


id: DOMDocument::loadXML
type: function
doc:
<comment>Description:</comment>
  Charge du XML depuis une chaîne de caractères
    
  
  Charge un document XML depuis une chaîne de caractères.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>   La chaîne de caractères contenant le XML.
  <info>int</info>     <strong>$options</strong>  L'opérateur <return>OR</return> des constantes libxml.

<comment>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>
   * DOMDocument::load
   * DOMDocument::save
   * DOMDocument::saveXML


id: DOMDocument::normalizeDocument
type: function
doc:
<comment>Description:</comment>
  Normalise le document
  
  Cette méthode fonctionne comme si vous sauvegardiez le document puis vous le chargiez de nouveau,
  rendant le document sous une forme "normale".

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

<comment>See Also:</comment>
   * La spécification DOM
   * DOMNode::normalize


id: DOMDocument::prepend
type: function
doc:
<comment>Description:</comment>
  Prepends nodes before the first child node
  
  Prepends one or many <strong>$nodes</strong> to the list of children before the first child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Les nœuds à ajouter. Les chaînes de caractères sont automatiquement
                          convertie en des nœuds de texte.

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMDocument::append


id: DOMDocument::registerNodeClass
type: function
doc:
<comment>Description:</comment>
  Enregistre la classe étendue utilisée pour créer un type de base de nœud
  
  Cette méthode vous permet d'enregistrer votre propre classe étendue DOM à utiliser ensuite dans
  l'extension DOM de PHP.
  
  Cette méthode ne fait pas partie du standard DOM.
  
  Les constructeur des objets des classes de nœud enregistré ne sont pas appelé.

<comment>Param:</comment>
  <info>string</info>       <strong>$baseClass</strong>      La classe DOM qui vous voulez étendre. Vous pouvez trouver une liste
                               de ces classes dans l'introduction du chapitre.
  <info>string|null</info>  <strong>$extendedClass</strong>  Le nom de votre classe étendue. Si la valeur <info>null</info> est fournie, toutes
                               les classes enregistrées précédemment étendant <strong>$baseClass</strong> seront
                               supprimé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: DOMDocument::relaxNGValidate
type: function
doc:
<comment>Description:</comment>
  Effectue une validation relaxNG sur le document
  
  Effectue une validation relaxNG sur le document  selon le schéma RNG défini par <strong>$filename</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le fichier RNG.

<comment>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>
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::validate


id: DOMDocument::relaxNGValidateSource
type: function
doc:
<comment>Description:</comment>
  Effectue une validation relaxNG sur le document
  
  Effectue une validation relaxNG sur le document  selon le schéma RNG défini dans la chaîne
  <strong>$source</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>  Une chaîne contenant le schéma RNG.

<comment>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>
   * DOMDocument::relaxNGValidate
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::validate


id: DOMDocument::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in document
  
  Replaces the children in the document with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMDocument::append
   * DOMDocument::prepend


id: DOMDocument::save
type: function
doc:
<comment>Description:</comment>
  Sauvegarde l'arbre interne XML dans un fichier
    
  
  Crée un document XML depuis la représentation DOM. Cette fonction est habituellement appelée après
  la construction d'un nouveau document DOM,  comme dans l'exemple ci-dessous.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le chemin où sera sauvegardé le document XML.
  <info>int</info>     <strong>$options</strong>   Options additionnelles. Actuellement, seul LIBXML_NOEMPTYTAG est supporté.

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

<comment>See Also:</comment>
   * DOMDocument::save
   * DOMDocument::load
   * DOMDocument::loadXML


id: DOMDocument::saveHTML
type: function
doc:
<comment>Description:</comment>
  Sauvegarde le document interne dans une chaîne en utilisant un formatage HTML
    
  
  Crée un document HTML depuis une représentation DOM.  Cette fonction est habituellement appelée
  après la  construction d'un tout nouveau document DOM, comme dans l'exemple ci-dessous.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$node</strong>  Paramètre optionnel pour afficher une portion du document.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le code HTML ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * DOMDocument::saveHTML
   * DOMDocument::loadHTML
   * DOMDocument::loadHTMLFile


id: DOMDocument::saveHTMLFile
type: function
doc:
<comment>Description:</comment>
  Sauvegarde un document interne dans un fichier en utilisant un formatage HTML
    
  
  Crée un document HTML depuis une représentation DOM. Cette fonction  est habituellement appelée
  après la construction d'un tout nouveau  document DOM, comme dans l'exemple ci-dessous.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le chemin où l'on doit sauvegarder le document HTML.

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

<comment>See Also:</comment>
   * DOMDocument::saveHTML
   * DOMDocument::loadHTML
   * DOMDocument::loadHTMLFile


id: DOMDocument::saveXML
type: function
doc:
<comment>Description:</comment>
  Sauvegarde l'arbre interne XML dans une chaîne de caractères
    
  
  Crée un document XML depuis la représentation DOM. Cette fonction est habituellement appelée après
  la création d'un tout nouveau document DOM, comme dans l'exemple ci-dessous.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$node</strong>     Utilisez ce paramètre pour afficher uniquement un nœud spécifique sans
                          déclaration XML plutôt que la totalité du document.
  <info>int</info>           <strong>$options</strong>  Options additionnelles. Les options LIBXML_NOEMPTYTAG et LIBXML_NOXMLDECL
                          sont supportées. Antérieur à PHP 8.3.0, uniquement l'option
                          LIBXML_NOEMPTYTAG est supporté.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le XML ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * DOMDocument::save
   * DOMDocument::load
   * DOMDocument::loadXML


id: DOMDocument::schemaValidate
type: function
doc:
<comment>Description:</comment>
  Valide un document selon un schéma. Seuls les schémas XML 1.0 sont supportés.
    
  
  Valide un document selon un schéma contenu dans un fichier donné.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le chemin vers le fichier contenant le schéma.
  <info>int</info>     <strong>$flags</strong>     Un masque de drapeaux de validation du schéma Libxml. Actuellement, la seule
                     valeur supportée est LIBXML_SCHEMA_CREATE. Disponible depuis Libxml 2.6.14.

<comment>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>
   * DOMDocument::schemaValidateSource
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::validate


id: DOMDocument::schemaValidateSource
type: function
doc:
<comment>Description:</comment>
  Valide un document selon un schéma
    
  
  Valide un document selon le schéma défini dans la chaîne donnée.

<comment>Param:</comment>
  <info>string</info>  <strong>$source</strong>  Une chaîne contenant le schéma.
  <info>int</info>     <strong>$flags</strong>   Un masque de drapeau de validation de schéma Libxml. Actuellement, la seule
                   valeur supportée est LIBXML_SCHEMA_CREATE. Disponible depuis Libxml 2.6.14.

<comment>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>
   * DOMDocument::schemaValidate
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource
   * DOMDocument::validate


id: DOMDocument::validate
type: function
doc:
<comment>Description:</comment>
  Valide un document en se basant sur sa DTD
    
  
  Valide un document en se basant sur sa DTD.
  
  Vous pouvez utiliser la propriété <return>validateOnParse</return> de la classe <class>DOMDocument</class> pour effectuer une
  validation 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. Si le
        document n'a aucune DTD d'attachée, cette méthode retournera <info>false</info>.

<comment>See Also:</comment>
   * DOMDocument::schemaValidate
   * DOMDocument::schemaValidateSource
   * DOMDocument::relaxNGValidate
   * DOMDocument::relaxNGValidateSource


id: DOMDocument::xinclude
type: function
doc:
<comment>Description:</comment>
  Remplace les XIncludes dans un objet DOMDocument
    
  
  Cette méthode remplace les XIncludes dans un objet DOMDocument.
  
  Vu que la bibliothèque libxml2 résout automatiquement les entités, cette méthode peut produire des
  résultats non attendus si le fichier XML inclus a une DTD d'attachée.

<comment>Param:</comment>
  <info>int</info>  <strong>$options</strong>  Opération de 'OU' logique des constantes d'option libxml.

<comment>Return:</comment>
  <info>int|false</info>  Retourne le nombre de XIncludes du document, -1 si une erreur survient lors du
             processus, ou <info>false</info> s'il n'y a aucune substitution.


id: DOMDocumentFragment::append
type: function
doc:
<comment>Description:</comment>
  Appends nodes after the last child node
  
  Appends one or many <strong>$nodes</strong> to the list of children after the last child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Les nœuds à ajouter. Les chaînes de caractères sont automatiquement
                          convertie en des nœuds de texte.

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMDocumentFragment::prepend


id: DOMDocumentFragment::appendXML
type: function
doc:
<comment>Description:</comment>
  Ajoute des données XML
  
  Ajoute des données XML brutes à un DOMDocumentFragment.
  
  Cette méthode ne fait pas partie du standard DOM. Elle a été créée pour simplifier l'ajout d'un
  fragment XML dans un DOMDocument.
  
  Si vous voulez respecter les standards, vous devez créer un DOMDocument temporaire avec une racine
  et parcourir les nœuds enfants de vos données XML pour les ajouter.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  XML à ajouter.

<comment>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: DOMDocumentFragment::prepend
type: function
doc:
<comment>Description:</comment>
  Prepends nodes before the first child node
  
  Prepends one or many <strong>$nodes</strong> to the list of children before the first child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Les nœuds à ajouter. Les chaînes de caractères sont automatiquement
                          convertie en des nœuds de texte.

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMDocumentFragment::append


id: DOMDocumentFragment::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in fragment
  
  Replaces the children in the document fragment with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMDocumentFragment::append
   * DOMDocumentFragment::prepend


id: DOMDocumentType
type: class
doc:
<comment>Description:</comment>
  Chaque <class>DOMDocument</class> a un attribut <return>doctype</return> dont la valeur est soit <info>null</info>, soit un objet
  <class>DOMDocumentType</class>.


id: DOMElement::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DOMElement
    
  
  Crée un nouvel objet <class>DOMElement</class>. Cet objet est en lecture seule. Il peut être ajouté à un
  document, mais les nœuds additionnels ne peuvent pas être ajoutés à ce nœud tant qu'il est associé
  à un document. Pour créer un nœud accessible en écriture, utilisez  ou  .

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  Le nom de l'élément. Lorsqu'il est passé dans l'URI de l'espace de
                               nom, le nom de l'élément doit comporter un préfixe pour être associé
                               à l'URI.
  <info>string|null</info>  <strong>$value</strong>          La valeur de l'élément.
  <info>string</info>       <strong>$namespace</strong>      Un espace de nom de l'URI pour créer l'élément dans un espace de nom
                               spécifique.

<comment>See Also:</comment>
   * DOMDocument::createElement
   * DOMDocument::createElementNS


id: DOMElement::after
type: function
doc:
<comment>Description:</comment>
  Adds nodes after the element
  
  Adds the passed <strong>$nodes</strong> after the element.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nœuds à ajouter après le nœud. Les chaînes de caractères sont
                          automatiquement convertie en des nœuds textuels.

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

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMElement::before


id: DOMElement::append
type: function
doc:
<comment>Description:</comment>
  Appends nodes after the last child node
  
  Appends one or many <strong>$nodes</strong> to the list of children after the last child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Les nœuds à ajouter. Les chaînes de caractères sont automatiquement
                          convertie en des nœuds de texte.

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

<comment>See Also:</comment>
   * DOMParentNode::append
   * DOMElement::prepend


id: DOMElement::before
type: function
doc:
<comment>Description:</comment>
  Adds nodes before the element
  
  Adds the passed <strong>$nodes</strong> before the element.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Nœuds à ajouter avant le nœud. Les chaînes de caractères sont
                          automatiquement convertie en des nœuds de texte.

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

<comment>See Also:</comment>
   * DOMChildNode::before
   * DOMElement::after


id: DOMElement::getAttribute
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur d'un attribut
  
  Récupère la valeur d'un attribut avec le nom <strong>$qualifiedName</strong>  pour le nœud courant.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Le nom de l'attribut.

<comment>Return:</comment>
  <info>string</info>  La valeur de l'attribut ou une chaîne vide si aucun attribut avec le nom <strong>$qualifiedName</strong>
          donné n'est trouvé.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::setAttribute
   * DOMElement::removeAttribute


id: DOMElement::getAttributeNS
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur de l'attribut
  
  Récupère la valeur de l'attribut dans l'espace de noms <strong>$namespace</strong> avec le nom local <strong>$localName</strong>
  pour le nœud courant.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  L'URI de l'espace de noms.
  <info>string</info>       <strong>$localName</strong>  Le nom local.

<comment>Return:</comment>
  <info>string</info>  La valeur de l'attribut, ou une chaîne vide si aucun attribut avec  le nom local
          <strong>$localName</strong> donné et dans l'espace de noms <strong>$namespace</strong> n'est trouvé.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::setAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::getAttributeNames
type: function
doc:
<comment>Description:</comment>
  Get attribute names
  
  Get attribute names.

<comment>Return:</comment>
  <info>array</info>  Return attribute names.


id: DOMElement::getAttributeNode
type: function
doc:
<comment>Description:</comment>
  Retourne le nœud d'attribut
  
  Retourne le nœud d'attribut avec le nom  <strong>$qualifiedName</strong> pour l'élément courant.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Le nom de l'attribut.

<comment>Return:</comment>
  <info>DOMAttr|DOMNameSpaceNode|false</info>  Le nœud d'attribut. Notez que pour la déclaration de namespace XML
                                  (les attributs <return>xmlns</return> et <return>xmlns:*</return>)  une instance de <class>DOMNameSpaceNode</class>
                                  est retourné au lieu de <class>DOMAttr</class>.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::setAttributeNode
   * DOMElement::removeAttributeNode


id: DOMElement::getAttributeNodeNS
type: function
doc:
<comment>Description:</comment>
  Retourne le nœud d'attribut
    
  
  Retourne le nœud d'attribut dans l'espace de noms <strong>$namespace</strong> avec le nom local <strong>$localName</strong> pour le
  nœud courant.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  L'URI de l'espace de noms.
  <info>string</info>       <strong>$localName</strong>  Le nom local.

<comment>Return:</comment>
  <info>DOMAttr|DOMNameSpaceNode|null</info>  Le nœud d'attribut. Notez que pour la déclaration de namespace XML
                                 (les attributs <return>xmlns</return> et <return>xmlns:*</return>)  une instance de <class>DOMNameSpaceNode</class>
                                 est retourné au lieu d'un objet <class>DOMAttr</class>.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::setAttributeNodeNS
   * DOMElement::removeAttributeNode


id: DOMElement::getElementsByTagName
type: function
doc:
<comment>Description:</comment>
  Retourne les éléments par leur nom de balise
  
  Cette fonction retourne une nouvelle instance de la classe <class>DOMNodeList</class> contenant tous les éléments
  descendants avec un nom de balise <strong>$qualifiedName</strong> donné, dans l'ordre dans lequel ils sont
  rencontrés lors du parcours de l'arbre  de cet élément.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Le nom de la balise. Utilisez le caractère générique <return>*</return> pour récupérer tous
                          les éléments contenus dans l'arbre de l'élément.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Cette fonction retourne une nouvelle instance de la classe <class>DOMNodeList</class> contenant tous
               les éléments correspondants.

<comment>See Also:</comment>
   * DOMElement::getElementsByTagNameNS


id: DOMElement::getElementsByTagNameNS
type: function
doc:
<comment>Description:</comment>
  Récupère les éléments par leur espace de noms et leur localName
  
  Cette fonction récupère tous les éléments descendants avec un nom local  <strong>$localName</strong> et un espace
  de noms  <strong>$namespace</strong> donnés.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  L'URI de l'espace de noms des éléments à chercher. La valeur spéciale <return>"*"</return>
                           représente tous les espaces de noms. Passer <info>null</info> représente l'espace de
                           noms vide.
  <info>string</info>       <strong>$localName</strong>  Le nom local des éléments à chercher. La valeur spéciale <return>"*"</return> représente
                           tous les noms locaux.

<comment>Return:</comment>
  <info>DOMNodeList</info>  Cette fonction retourne un nouvel objet de la classe <class>DOMNodeList</class> contenant tous les
               éléments correspondants dans l'ordre dans lesquels ils sont rencontrés lors du
               parcours de l'arbre de cet élément.

<comment>See Also:</comment>
   * DOMElement::getElementsByTagNameNS


id: DOMElement::hasAttribute
type: function
doc:
<comment>Description:</comment>
  Vérifie si un attribut existe
  
  Indique si un attribut nommé <strong>$qualifiedName</strong>  existe en tant que membre de l'élément.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</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>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttribute
   * DOMElement::setAttribute
   * DOMElement::removeAttribute


id: DOMElement::hasAttributeNS
type: function
doc:
<comment>Description:</comment>
  Vérifie si un attribut existe
    
  
  Vérifie si un attribut dans l'espace de noms <strong>$namespace</strong>  nommé <strong>$localName</strong> existe en tant que
  membre de l'élément.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  L'URI de l'espace de noms.
  <info>string</info>       <strong>$localName</strong>  Le nom local.

<comment>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>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNS
   * DOMElement::setAttributeNS
   * DOMElement::removeAttributeNS


id: DOMElement::insertAdjacentElement
type: function
doc:
<comment>Description:</comment>
  Insert adjacent element
  
  Inserts an element at a relative position given by <strong>$where</strong>.

<comment>Param:</comment>
  <info>string</info>      <strong>$where</strong>    <return>beforebegin</return> - Insert before the target element.<return>afterbegin</return> - Insert as the
                        first child of the target element.<return>beforeend</return> - Insert as the last child of
                        the target element.<return>afterend</return> - Insert after the target element.
  <info>DOMElement</info>  <strong>$element</strong>  The element to insert.

<comment>Return:</comment>
  <info>DOMElement|null</info>  Return <class>DOMElement</class> or <info>null</info> on failure.

<comment>See Also:</comment>
   * DOMElement::insertAdjacentText


id: DOMElement::insertAdjacentText
type: function
doc:
<comment>Description:</comment>
  Insert adjacent text
  
  Inserts text at a relative position given by <strong>$where</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$where</strong>  <return>beforebegin</return> - Insert before the target element.<return>afterbegin</return> - Insert as the first
                  child of the target element.<return>beforeend</return> - Insert as the last child of the target
                  element.<return>afterend</return> - Insert after the target element.
  <info>string</info>  <strong>$data</strong>   The string to insert.

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

<comment>See Also:</comment>
   * DOMElement::insertAdjacentElement


id: DOMElement::prepend
type: function
doc:
<comment>Description:</comment>
  Prepends nodes before the first child node
  
  Prepends one or many <strong>$nodes</strong> to the list of children before the first child node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Les nœuds à ajouter. Les chaînes de caractères sont automatiquement
                          convertie en des nœuds de texte.

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

<comment>See Also:</comment>
   * DOMParentNode::prepend
   * DOMElement::append


id: DOMElement::remove
type: function
doc:
<comment>Description:</comment>
  Removes the element
  
  Removes the element.

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

<comment>See Also:</comment>
   * DOMElement::after
   * DOMElement::before
   * DOMElement::replaceWith
   * DOMNode::removeChild


id: DOMElement::removeAttribute
type: function
doc:
<comment>Description:</comment>
  Efface un attribut
  
  Efface l'attribut nommé <strong>$qualifiedName</strong> de l'élément.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</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>
   * DOMElement::hasAttribute
   * DOMElement::getAttribute
   * DOMElement::setAttribute


id: DOMElement::removeAttributeNS
type: function
doc:
<comment>Description:</comment>
  Efface un attribut
  
  Retire l'attribut <strong>$localName</strong> dans l'espace de noms <strong>$namespace</strong> de l'élément.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  L'URI de l'espace de noms.
  <info>string</info>       <strong>$localName</strong>  Le nom local.

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

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNS
   * DOMElement::setAttributeNS


id: DOMElement::removeAttributeNode
type: function
doc:
<comment>Description:</comment>
  Efface un attribut
  
  Efface l'attribut <strong>$attr</strong> de l'élément.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  Le nœud de l'attribut.

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

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNode
   * DOMElement::setAttributeNode


id: DOMElement::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in element
  
  Replaces the children in the element with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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

<comment>See Also:</comment>
   * DOMParentNode::replaceChildren
   * DOMElement::replaceWith
   * DOMElement::after
   * DOMElement::before
   * DOMElement::remove


id: DOMElement::replaceWith
type: function
doc:
<comment>Description:</comment>
  Replaces the element with new nodes
  
  Replaces the element with new <strong>$nodes</strong>.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Les nœuds de remplacement.

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

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMElement::replaceChildren
   * DOMElement::after
   * DOMElement::before
   * DOMElement::remove


id: DOMElement::setAttribute
type: function
doc:
<comment>Description:</comment>
  Ajoute un nouvel attribut, ou modifie un attribut existant
  
  Ajoute un attribut avec comme nom <strong>$qualifiedName</strong> et comme valeur <strong>$value</strong>. Si l'attribut n'existe
  pas, il sera créé.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Le nom de l'attribut.
  <info>string</info>  <strong>$value</strong>          La valeur de l'attribut.

<comment>Return:</comment>
  <info>DOMAttr|bool</info>  Le <class>DOMAttr</class> crée ou modifié, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttribute
   * DOMElement::removeAttribute


id: DOMElement::setAttributeNS
type: function
doc:
<comment>Description:</comment>
  Ajoute un nouvel attribut
  
  Ajoute un attribut avec comme espace de noms <strong>$namespace</strong> et comme nom <strong>$name</strong> avec comme valeur
  <strong>$value</strong>. Si l'attribut n'existe pas, il sera créé.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>      L'URI de l'espace de noms.
  <info>string</info>       <strong>$qualifiedName</strong>  Le nom qualifié de l'attribut, sous la forme <return>prefixe:nomdebalise</return>.
  <info>string</info>       <strong>$value</strong>          La valeur de l'attribut.

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

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNodeNS
   * DOMElement::removeAttributeNode


id: DOMElement::setAttributeNode
type: function
doc:
<comment>Description:</comment>
  Ajoute un nouvel attribut à l'élément
  
  Ajoute un nouvel attribut <strong>$attr</strong> à l'élément. Si un attribut du même nom existe déjà sur l'élément,
  cet attribut est remplacé par <strong>$attr</strong>.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  L'attribut.

<comment>Return:</comment>
  <info>DOMAttr|null|false</info>  Retourne l'ancien attribut s'il a été remplacé ou <info>null</info> s'il n'y avait pas
                      d'ancien attribut. Si une erreur <info>DOM_WRONG_DOCUMENT_ERR</info> est déclenchée, et que
                      strictErrorChecking est <info>false</info>, alors <info>false</info> est renvoyé.

<comment>See Also:</comment>
   * DOMElement::hasAttribute
   * DOMElement::getAttributeNode
   * DOMElement::removeAttributeNode


id: DOMElement::setAttributeNodeNS
type: function
doc:
<comment>Description:</comment>
  Ajoute un nouvel attribut à l'élément
  
  Ajoute un nouvel attribut <strong>$attr</strong> à l'élément, en tenant compte de l'espace de noms (namespace): Si
  un attribut du même nom existe déjà sur l'élément, cet attribut est remplacé par <strong>$attr</strong>.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  Le nom de l'attribut.

<comment>Return:</comment>
  <info>DOMAttr|null|false</info>  Retourne l'ancien attribut s'il a été remplacé ou <info>null</info> s'il n'y avait pas
                      d'ancien attribut. Si une erreur <info>DOM_WRONG_DOCUMENT_ERR</info> est déclenchée, et que
                      strictErrorChecking est <info>false</info>, alors <info>false</info> est renvoyé.

<comment>See Also:</comment>
   * DOMElement::hasAttributeNS
   * DOMElement::getAttributeNodeNS
   * DOMElement::removeAttributeNode


id: DOMElement::setIdAttribute
type: function
doc:
<comment>Description:</comment>
  Déclare l'attribut spécifié par son nom à être de type ID
  
  Déclare l'attribut <strong>$qualifiedName</strong> afin qu'il soit de type ID.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Le nom de l'attribut.
  <info>bool</info>    <strong>$isId</strong>           Définissez à <info>true</info> si vous voulez que <strong>$qualifiedName</strong> soit de type ID, <info>false</info>
                          sinon.

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttributeNode
   * DOMElement::setIdAttributeNS


id: DOMElement::setIdAttributeNS
type: function
doc:
<comment>Description:</comment>
  Déclare l'attribut spécifié par son nom local et son espace de nom URI à être de type ID
  
  Déclare l'attribut spécifié par <strong>$qualifiedName</strong> et <strong>$namespace</strong> afin qu'il soit de type ID.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>      L'URI de l'espace de nom de l'attribut.
  <info>string</info>  <strong>$qualifiedName</strong>  Le nom local de l'attribut, sous la forme <return>prefix:tagname</return>.
  <info>bool</info>    <strong>$isId</strong>           Définissez à <info>true</info> si vous voulez que <strong>$name</strong> soit de type ID, <info>false</info> sinon.

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttribute
   * DOMElement::setIdAttributeNode


id: DOMElement::setIdAttributeNode
type: function
doc:
<comment>Description:</comment>
  Déclare l'attribut spécifié par le nœud à être de type ID
  
  Déclare l'attribut spécifié par <strong>$attr</strong>  afin qu'il soit de type ID.

<comment>Param:</comment>
  <info>DOMAttr</info>  <strong>$attr</strong>  L'attribut du nœud.
  <info>bool</info>     <strong>$isId</strong>  Définissez à <info>true</info> si vous voulez que <strong>$name</strong> soit de type ID, <info>false</info> sinon.

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

<comment>See Also:</comment>
   * DOMDocument::getElementById
   * DOMElement::setIdAttribute
   * DOMElement::setIdAttributeNS


id: DOMElement::toggleAttribute
type: function
doc:
<comment>Description:</comment>
  Toggle attribute
  
  Toggle the attribute.

<comment>Param:</comment>
  <info>string</info>     <strong>$qualifiedName</strong>  The qualified name of the attribute.
  <info>bool|null</info>  <strong>$force</strong>          if <info>null</info>, the function will toggle the attribute.if <info>true</info>, the function
                             adds the attribute.if <info>false</info>, the function removes the attribute.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the attribute is present after finishing the call, <info>false</info> otherwise.


id: DOMEntity
type: class
doc:
<comment>Description:</comment>
  Cette interface représente une entité connue, analysée ou non, dans un document XML.


id: DOMEntityReference::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DOMEntityReference
    
  
  Crée un nouvel objet <class>DOMEntityReference</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Le nom de la référence à l'entité.

<comment>See Also:</comment>
   * DOMDocument::createEntityReference


id: DOMImplementation
type: class
doc:
<comment>Description:</comment>
  La classe <class>DOMImplementation</class> fournit des méthodes pour effectuer des opérations qui sont
  indépendantes d'une instance particulière du modèle objet d'un document.


id: DOMImplementation::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DOMImplementation
    
  
  Crée un nouvel objet <class>DOMImplementation</class>.


id: DOMImplementation::createDocument
type: function
doc:
<comment>Description:</comment>
  Crée un objet DOM Document du type spécifié avec ses éléments
    
  
  Crée un objet <class>DOMDocument</class> du type spécifié avec ces éléments du document.

<comment>Param:</comment>
  <info>string|null</info>           <strong>$namespace</strong>      L'URI de l'espace de noms des éléments du document à créer.
  <info>string</info>                <strong>$qualifiedName</strong>  Le nom qualifié des éléments du document à créer.
  <info>DOMDocumentType|null</info>  <strong>$doctype</strong>        Le type de document à créer ou <info>null</info>.

<comment>Return:</comment>
  <info>DOMDocument|false</info>  Un nouvel objet <class>DOMDocument</class> ou <info>false</info> en cas d'erreur. Si <strong>$namespace</strong>,
                     <strong>$qualifiedName</strong>, et <strong>$doctype</strong> sont nulles, le <class>DOMDocument</class> retourné est vide avec
                     aucun élément de document.

<comment>See Also:</comment>
   * DOMDocument::__construct
   * DOMImplementation::createDocumentType


id: DOMImplementation::createDocumentType
type: function
doc:
<comment>Description:</comment>
  Crée un objet DOMDocumentType vide
    
  
  Crée un objet <class>DOMDocumentType</class> vide.  Les déclarations et notations d'entités ne sont pas
  disponibles.  Les expansions de références d'entités et les ajouts d'attributs par  défaut ne sont
  pas non plus effectués.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Le nom qualifié du type de document à créer.
  <info>string</info>  <strong>$publicId</strong>       L'identifiant publique externe du sous-ensemble.
  <info>string</info>  <strong>$systemId</strong>       L'identifiant système externe du sous-ensemble.

<comment>Return:</comment>
  <info>DOMDocumentType|false</info>  Un nouveau nœud <class>DOMDocumentType</class>  avec son <return>ownerDocument</return> défini à <info>null</info> ou
                         <info>false</info> en cas d'erreur.

<comment>See Also:</comment>
   * DOMImplementation::createDocument


id: DOMImplementation::hasFeature
type: function
doc:
<comment>Description:</comment>
  Teste si l'implémentation DOM implémente une fonctionnalité spécifique
    
  
  Teste si l'implémentation DOM implémente une fonctionnalité <strong>$feature</strong> spécifique.
  
  Vous pouvez trouver une liste de toutes les fonctionnalités dans la section Conformance de la
  spécification DOM.

<comment>Param:</comment>
  <info>string</info>  <strong>$feature</strong>  La fonctionnalité à tester.
  <info>string</info>  <strong>$version</strong>  Le numéro de version de la fonctionnalité <strong>$feature</strong>  à tester. Dans le niveau 2,
                    ceci peut être soit <return>2.0</return> ou <return>1.0</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>
   * DOMNode::isSupported


id: DOMNamedNodeMap::count
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre de nœuds dans la collection non triée (map)
  
  Récupère le nombre de nœuds dans la collection non triée (map).

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de nœuds dans la collection non triée, ce qui est identique à la propriété
       length.


id: DOMNamedNodeMap::getIterator
type: function
doc:
<comment>Description:</comment>
  Retrieve an external iterator
  
  Returns an external iterator for the named node map.

<comment>Return:</comment>
  <info>Iterator</info>  Une instance d'un objet qui implémente un <class>Iterator</class> ou l'interface <class>Traversable</class>.

<comment>See Also:</comment>
   * IteratorAggregate::getIterator


id: DOMNamedNodeMap::getNamedItem
type: function
doc:
<comment>Description:</comment>
  Retourne un nœud spécifié par son nom
    
  
  Récupère un nœud spécifié par son <return>nodeName</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$qualifiedName</strong>  Le <return>nodeName</return> du nœud à récupérer.

<comment>Return:</comment>
  <info>DOMNode|null</info>  Un nœud (de n'importe quel type) avec un <return>nodeName</return> spécifié, ou  <info>null</info> si aucun nœud
                n'est trouvé.

<comment>See Also:</comment>
   * DOMNamedNodeMap::getNamedItemNS


id: DOMNamedNodeMap::getNamedItemNS
type: function
doc:
<comment>Description:</comment>
  Retourne un nœud spécifié par son nom local et son espace de noms
    
  
  Retourne un nœud spécifié par son nom local <strong>$localName</strong> et son espace de noms <strong>$namespace</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespace</strong>  L'URI de l'espace de noms du nœud à récupérer.
  <info>string</info>       <strong>$localName</strong>  Le nom local du nœud à récupérer.

<comment>Return:</comment>
  <info>DOMNode|null</info>  Un nœud, de n'importe quel type ou <info>null</info>  si aucun nœud n'est trouvé.

<comment>See Also:</comment>
   * DOMNamedNodeMap::getNamedItemNS


id: DOMNamedNodeMap::item
type: function
doc:
<comment>Description:</comment>
  Retourne un nœud selon son index
  
  Retourne un nœud spécifié par <strong>$index</strong> dans l'objet  <class>DOMNamedNodeMap</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  Index dans cette carte.

<comment>Return:</comment>
  <info>DOMNode|null</info>  Le nœud à la position <strong>$index</strong> dans la carte, ou <info>null</info> si ce n'est pas un index valide
                (plus grand que ou égal au nombre de nœuds dans cette carte).


id: DOMNode::C14N
type: function
doc:
<comment>Description:</comment>
  Canonise des nœuds en une chaîne
  
  Canonise des nœuds en une chaîne de caractères.

<comment>Param:</comment>
  <info>bool</info>        <strong>$exclusive</strong>     Active l'analyse des seuls nœuds correspondant à l'Xpath ou aux
                             préfixes d'espace de noms fournis.
  <info>bool</info>        <strong>$withComments</strong>  Conserve les commentaires dans la sortie.
  <info>array|null</info>  <strong>$xpath</strong>         Un tableau de <return>xpath</return> utilisés pour filtrer les nœuds.
  <info>array|null</info>  <strong>$nsPrefixes</strong>    Un tableau de préfixes d'espaces de noms utilisés pour filtrer les
                             nœuds.

<comment>Return:</comment>
  <info>string|false</info>  Retourne les nœuds canonisés, sous la forme d'une chaîne de caractères ou <info>false</info> si
                une erreur survient

<comment>See Also:</comment>
   * DOMNode::C14NFile


id: DOMNode::C14NFile
type: function
doc:
<comment>Description:</comment>
  Canonise des nœuds en fichier
  
  Canonise des nœuds en fichier.

<comment>Param:</comment>
  <info>string</info>      <strong>$uri</strong>           Chemin vers lequel le fichier sera créé.
  <info>bool</info>        <strong>$exclusive</strong>     Active l'analyse des seuls nœuds correspondant à l'xpath ou préfixes
                             d'espace de noms fournis.
  <info>bool</info>        <strong>$withComments</strong>  Conserve les commentaires dans la sortie.
  <info>array|null</info>  <strong>$xpath</strong>         Un tableau d'<return>xpath</return> utilisés pour filtrer les nœuds.
  <info>array|null</info>  <strong>$nsPrefixes</strong>    Un tableau de préfixes d'espace de noms utilisés pour filtrer les
                             nœuds.

<comment>Return:</comment>
  <info>int|false</info>  Nombre d'octets écrits ou <info>false</info> si une erreur survient

<comment>See Also:</comment>
   * DOMNode::C14N


id: DOMNode::appendChild
type: function
doc:
<comment>Description:</comment>
  Ajoute un nouveau fils à la fin des fils
    
  
  Cette fonction ajoute un fils à une liste de fils existante ou crée une nouvelle liste de fils. Le
  fils peut être créé avec, e.g. DOMDocument::createElement, DOMDocument::createTextNode, etc.  ou
  simplement en utilisant tout autre nœud.
  
  Lors de l'utilisation d'un nœud existant, il sera supprimé.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>  Le nœud fils à ajouter.

<comment>Return:</comment>
  <info>DOMNode|false</info>  Le nœud fils ajouté ou <info>false</info> en cas d'erreur.

<comment>See Also:</comment>
   * DOMChildNode::after
   * DOMNode::insertBefore
   * DOMNode::removeChild
   * DOMNode::replaceChild


id: DOMNode::cloneNode
type: function
doc:
<comment>Description:</comment>
  Clone un nœud
  
  Crée une copie d'un nœud.

<comment>Param:</comment>
  <info>bool</info>  <strong>$deep</strong>  Indique si l'on doit copier tous les nœuds fils. Ce paramètre vaut <info>false</info> par défaut.

<comment>Return:</comment>
  <info>DOMNode|false</info>  Le nœud cloné.


id: DOMNode::contains
type: function
doc:
<comment>Description:</comment>
  Checks if node contains other node
  
  Checks if node contains <strong>$other</strong> node.

<comment>Param:</comment>
  <info>DOMNode|DOMNameSpaceNode|null</info>  <strong>$other</strong>  Node to be checked.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if node contains <strong>$other</strong> node, <info>false</info> otherwise.


id: DOMNode::getLineNo
type: function
doc:
<comment>Description:</comment>
  Lit le numéro de ligne d'un nœud
  
  Lit le numéro de ligne d'un nœud.

<comment>Return:</comment>
  <info>int</info>  Retourne le numéro de ligne de définition du nœud.


id: DOMNode::getNodePath
type: function
doc:
<comment>Description:</comment>
  Récupère un XPath pour un nœud
  
  Récupère un chemin XPath pour le nœud.

<comment>Return:</comment>
  <info>string|null</info>  Retourne un chaîne de caractères contenant le XPath, ou <info>null</info> si une erreur survient.

<comment>See Also:</comment>
   * <class>DOMXPath</class>


id: DOMNode::getRootNode
type: function
doc:
<comment>Description:</comment>
  Get root node
  
  Get root node.

<comment>Param:</comment>
  <info>array</info>  <strong>$options</strong>  This parameter has no effect yet.

<comment>Return:</comment>
  <info>DOMNode</info>  Returns the root node.


id: DOMNode::hasAttributes
type: function
doc:
<comment>Description:</comment>
  Vérifie si le nœud possède un attribut
    
  
  Cette méthode vérifie si un nœud possède des attributs. Le nœud testé doit être un
  <info>XML_ELEMENT_NODE</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>
   * DOMNode::hasChildNodes


id: DOMNode::hasChildNodes
type: function
doc:
<comment>Description:</comment>
  Vérifie si le nœud possède des enfants
    
  
  Cette fonction vérifie si un nœud possède des enfants.

<comment>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>
   * DOMImplementation::hasFeature


id: DOMNode::insertBefore
type: function
doc:
<comment>Description:</comment>
  Ajoute un nouveau fils avant un nœud de référence.
    
  
  Cette fonction insère un nouveau nœud juste avant le nœud de référence. Si vous comptez faire des
  modifications plus tard sur l'enfant ajouté, vous devez utiliser le nœud retourné.
  
  Lors de l'utilisation d'un nœud existant, il sera déplacé.

<comment>Param:</comment>
  <info>DOMNode</info>       <strong>$node</strong>   Le nouveau nœud.
  <info>DOMNode|null</info>  <strong>$child</strong>  Le nœud référencé. Si non spécifié, <strong>$node</strong>  sera ajouté aux fils.

<comment>Return:</comment>
  <info>DOMNode|false</info>  Le nœud inséré ou <info>false</info> en cas d'erreur.

<comment>See Also:</comment>
   * DOMNode::appendChild


id: DOMNode::isDefaultNamespace
type: function
doc:
<comment>Description:</comment>
  Vérifie si l'espace de nom spécifié est l'espace de noms par défaut ou non
  
  Vérifie si <strong>$namespace</strong> est l'espace de noms par défaut.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  L'URI de l'espace de noms à vérifier.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si <strong>$namespace</strong> est l'espace de noms par défaut, <info>false</info> sinon.


id: DOMNode::isEqualNode
type: function
doc:
<comment>Description:</comment>
  Checks that both nodes are equal
  
  Checks that both nodes are equal.

<comment>Param:</comment>
  <info>DOMNode|null</info>  <strong>$otherNode</strong>  The node.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if both nodes are equal, <info>false</info> otherwise.


id: DOMNode::isSameNode
type: function
doc:
<comment>Description:</comment>
  Indique si deux nœuds sont identiques
    
  
  Cette fonction indique si deux nœuds sont identiques. La comparaison n'est pas basée sur le
  contenu.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$otherNode</strong>  Le nœud à comparer.

<comment>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: DOMNode::isSupported
type: function
doc:
<comment>Description:</comment>
  Vérifie si la fonctionnalité est disponible pour la version spécifiée
    
  
  Vérifie si la fonctionnalité <strong>$feature</strong> demandée est supportée par la version <strong>$version</strong> spécifiée.

<comment>Param:</comment>
  <info>string</info>  <strong>$feature</strong>  La fonctionnalité à tester. Voir l'exemple de DOMImplementation::hasFeature pour
                    une liste de fonctionnalités.
  <info>string</info>  <strong>$version</strong>  Le numéro de la version de la fonctionnalité <strong>$feature</strong>  à tester.

<comment>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>
   * DOMImplementation::hasFeature


id: DOMNode::lookupNamespaceURI
type: function
doc:
<comment>Description:</comment>
  Retourne l'URI de l'espace de noms selon le préfixe
    
  
  Retourne l'URI de l'espace de noms selon le préfixe <strong>$prefix</strong>.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$prefix</strong>  Le préfixe à rechercher. Si ce paramètre est <info>null</info>, la méthode renverra l'URI
                        de l'espace de noms par défaut, s'il existe.

<comment>Return:</comment>
  <info>string|null</info>  Renvoie l'URI de l'espace de noms associé, ou <info>null</info> s'il n'en est pas trouvé.

<comment>See Also:</comment>
   * DOMNode::lookupPrefix


id: DOMNode::lookupPrefix
type: function
doc:
<comment>Description:</comment>
  Retourne le préfixe de l'espace de noms selon l'URI de l'espace de noms
    
  
  Retourne le préfixe de l'espace du nœud selon l'URI de l'espace de noms.

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>  L'URI de l'espace de noms.

<comment>Return:</comment>
  <info>string|null</info>  Le préfixe de l'espace de noms ou <info>null</info> en cas d'erreur.

<comment>See Also:</comment>
   * DOMNode::lookupNamespaceUri


id: DOMNode::normalize
type: function
doc:
<comment>Description:</comment>
  Normalise le nœud
  
  Supprime les nœuds de texte vides et fusionne les nœuds de texte adjacents dans ce nœud ainsi que
  tous ces enfants.

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

<comment>See Also:</comment>
   * La spécification DOM
   * DOMDocument::normalizeDocument


id: DOMNode::removeChild
type: function
doc:
<comment>Description:</comment>
  Supprime un fils de la liste des enfants
    
  
  Cette fonction supprime un fils de la liste des enfants.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$child</strong>  Le fils à effacer.

<comment>Return:</comment>
  <info>DOMNode|false</info>  Si le fils ne peut être effacé, la fonction retourne l'ancien fils ou <info>false</info> en cas
                 d'erreur.

<comment>See Also:</comment>
   * DOMChildNode::remove
   * DOMNode::appendChild
   * DOMNode::replaceChild


id: DOMNode::replaceChild
type: function
doc:
<comment>Description:</comment>
  Remplace un fils
    
  
  Cette fonction remplace le fils <strong>$child</strong>  par le nouveau nœud spécifié. Si <strong>$node</strong> est déjà un fils,
  il ne sera pas ajouté une seconde fois. Si le remplacement réussi, l'ancien nœud sera retourné.

<comment>Param:</comment>
  <info>DOMNode</info>  <strong>$node</strong>   Le nouveau nœud. Il doit être membre du document cible, i.e. créé par une des
                   méthodes de DOMDocument-&gt;createXXX() ou importé dans le document par .
  <info>DOMNode</info>  <strong>$child</strong>  L'ancien nœud.

<comment>Return:</comment>
  <info>DOMNode|false</info>  L'ancien nœud ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * DOMChildNode::replaceWith
   * DOMNode::appendChild
   * DOMNode::removeChild


id: DOMNodeList::count
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre de nœuds dans la collection triée (list)
  
  Récupère le nombre de nœuds dans la collection triée (list).

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de nœuds dans la collection triée, ce qui est identique à la propriété
       length.


id: DOMNodeList::getIterator
type: function
doc:
<comment>Description:</comment>
  Retrieve an external iterator
  
  Returns an external iterator for the node list.

<comment>Return:</comment>
  <info>Iterator</info>  Une instance d'un objet qui implémente un <class>Iterator</class> ou l'interface <class>Traversable</class>.

<comment>See Also:</comment>
   * IteratorAggregate::getIterator


id: DOMNodeList::item
type: function
doc:
<comment>Description:</comment>
  Retourne un nœud spécifié par son index
    
  
  Retourne un nœud spécifié par son <strong>$index</strong>  dans l'objet <class>DOMNodeList</class>.
  
  Si vous avez besoin de connaître le nombre de nœuds dans la collection, utilisez la propriété
  <return>length</return> de l'objet <class>DOMNodeList</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  L'index du nœud dans la collection.

<comment>Return:</comment>
  <info>DOMElement|DOMNode|DOMNameSpaceNode|null</info>  Le nœud à la position <strong>$index</strong> dans la  <class>DOMNodeList</class>, ou
                                            <info>null</info> si ce n'est pas un index valide.


id: DOMParentNode::append
type: function
doc:
<comment>Description:</comment>
  Ajoute des nœuds après le dernier nœud enfant
  
  Ajoute un ou plusieurs <strong>$nodes</strong> à la liste des enfants après le dernier nœud enfant.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Les nœuds à ajouter. Les chaînes de caractères sont automatiquement
                          convertie en des nœuds de texte.

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

<comment>See Also:</comment>
   * DOMParentNode::prepend


id: DOMParentNode::prepend
type: function
doc:
<comment>Description:</comment>
  Ajoute des nœuds avant le premier nœud enfant
  
  Ajoute un ou plusieurs <strong>$nodes</strong> à la liste des enfants avant le premier nœud enfant.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  Les nœuds à ajouter. Les chaînes de caractères sont automatiquement
                          convertie en des nœuds de texte.

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

<comment>See Also:</comment>
   * DOMParentNode::append


id: DOMParentNode::replaceChildren
type: function
doc:
<comment>Description:</comment>
  Replace children in node
  
  Replace children in node.

<comment>Param:</comment>
  <info>DOMNode|string</info>  <strong>$nodes</strong>  The nodes replacing the children. Strings are automatically converted to
                          text nodes.

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


id: DOMProcessingInstruction::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DOMProcessingInstruction
    
  
  Crée un nouvel objet <class>DOMProcessingInstruction</class>. Cet objet est en lecture seule. Il peut être ajouté
  à un document, mais les nœuds additionnels ne peuvent pas être ajoutés à ce nœud tant qu'il est
  associé à un document. Pour créer un nœud accessible en écriture,  utilisez .

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Le nom du tag de l'instruction.
  <info>string</info>  <strong>$value</strong>  La valeur de l'instruction.

<comment>See Also:</comment>
   * DOMDocument::createProcessingInstruction


id: DOMSTRING_SIZE_ERR
type: constant
doc:
<comment>Description:</comment>
  Si la rangée spécifiée de texte ne tient pas dans le <class>DOMString</class>.


id: DOMText
type: class
doc:
<comment>Description:</comment>
  La classe <class>DOMText</class> hérite de  <class>DOMCharacterData</class> et représente le contenu textuel de <class>DOMElement</class> ou
  <class>DOMAttr</class>.


id: DOMText::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DOMText
    
  
  Crée un nouvel objet <class>DOMText</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  La valeur du nœud texte. Si aucune n'est fournie,  un nœud texte vide est créé.

<comment>See Also:</comment>
   * DOMDocument::createTextNode


id: DOMText::isElementContentWhitespace
type: function
doc:
<comment>Description:</comment>
  Rapporte si le nœud textuel contient des caractères d'espacement blanc

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


id: DOMText::isWhitespaceInElementContent
type: function
doc:
<comment>Description:</comment>
  Indique si ce nœud de texte contient des espaces blancs
    
  
  Indique si un nœud de texte ne contient que des espaces ou est vide. Cette détermination est faite
  durant le chargement du document.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le nœud contient zéro ou plusieurs caractères blancs et rien d'autre.
        Retourne <info>false</info> sinon.


id: DOMText::splitText
type: function
doc:
<comment>Description:</comment>
  Coupe le nœud en deux nœuds à l'endroit spécifié
    
  
  Coupe le nœud en deux nœuds à l'endroit spécifié <strong>$offset</strong>,  en gardant les deux dans l'arbre comme
  parents.
  
  Après la césure, ce nœud contiendra tout le texte jusqu'à <strong>$offset</strong>. Un nouveau nœud avec le reste
  du texte sera retourné. Si le nœud d'origine possède un parent, le nouveau nœud est inséré à la
  suite du nœud courant. Lorsque <strong>$offset</strong> est égal à la taille du nœud, le nouveau nœud est vide.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  La position de la césure, commençant à 0.

<comment>Return:</comment>
  <info>DOMText|false</info>  Le nouveau nœud du même type, qui contient tout le contenu à partir de la position
                 <strong>$offset</strong>.


id: DOMXPath::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DOMXPath
    
  
  Crée un nouvel objet <class>DOMXPath</class>.

<comment>Param:</comment>
  <info>DOMDocument</info>  <strong>$document</strong>  L'objet <class>DOMDocument</class> associé à l'objet <class>DOMXPath</class>.


id: DOMXPath::evaluate
type: function
doc:
<comment>Description:</comment>
  Évalue une expression XPath donnée et retourne un résultat typé si possible
    
  
  Exécute l'expression XPath <strong>$expression</strong> et retourne un résultat typé si possible.

<comment>Param:</comment>
  <info>string</info>        <strong>$expression</strong>      L'expression XPath à exécuter.
  <info>DOMNode|null</info>  <strong>$contextNode</strong>     Le paramètre optionnel <strong>$contextNode</strong> peut être spécifié pour
                                 effectuer des requêtes XPath relatives. Par défaut, les requêtes
                                 sont relatives à l'élément root.
  <info>bool</info>          <strong>$registerNodeNS</strong>  Le paramètre optionnel <strong>$registerNodeNS</strong> peut être renseigné pour
                                 désactiver l'enregistrement automatique du nœud de contexte.

<comment>Return:</comment>
  <info>mixed</info>  Retourne un résultat typé si possible ou un <class>DOMNodeList</class> contenant tous les nœuds
         correspondant à l'expression XPath <strong>$expression</strong>.
         
         Si le paramètre <strong>$expression</strong> est mal formé ou bien si le paramètre <strong>$contextNode</strong> est
         invalide, la méthode DOMXPath::evaluate retournera <info>false</info>.

<comment>See Also:</comment>
   * DOMXPath::query


id: DOMXPath::query
type: function
doc:
<comment>Description:</comment>
  Évalue l'expression XPath donnée
    
  
  Évalue l'expression <strong>$expression</strong> XPath donnée.

<comment>Param:</comment>
  <info>string</info>        <strong>$expression</strong>      L'expression XPath à exécuter.
  <info>DOMNode|null</info>  <strong>$contextNode</strong>     Le paramètre optionnel <strong>$contextNode</strong> peut être spécifié pour
                                 effectuer des requêtes XPath relative. Par défaut, les requêtes
                                 sont relatives à l'élément racine.
  <info>bool</info>          <strong>$registerNodeNS</strong>  Le paramètre optionnel <strong>$registerNodeNS</strong> peut être renseigné pour
                                 désactiver l'enregistrement automatique du nœud de contexte.

<comment>Return:</comment>
  <info>mixed</info>  Retourne un <class>DOMNodeList</class> contenant tous les nœuds correspondant à l'expression <strong>$expression</strong>
         XPath donnée. Toutes les expressions qui ne retournent pas de nœud retourneront un
         <class>DOMNodeList</class> vide.
         
         Si le paramètre <strong>$expression</strong> est malformé ou le paramètre <strong>$contextNode</strong> est invalide,
         DOMXPath::query retournera <info>false</info>.

<comment>See Also:</comment>
   * DOMXPath::query


id: DOMXPath::registerNamespace
type: function
doc:
<comment>Description:</comment>
  Enregistre l'espace de noms avec l'objet DOMXPath
    
  
  Enregistre l'espace de noms <strong>$namespace</strong> et le  <strong>$prefix</strong> avec l'objet <class>DOMXPath</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>     Le préfixe.
  <info>string</info>  <strong>$namespace</strong>  L'URI de l'espace de noms.

<comment>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: DOMXPath::registerPhpFunctions
type: function
doc:
<comment>Description:</comment>
  Enregistre une fonction PHP comme fonction XPath
  
  Cette méthode active la possibilité d'utiliser des fonctions PHP dans des expressions XPath.

<comment>Param:</comment>
  <info>string|array|null</info>  <strong>$restrict</strong>  Utilisez ce paramètre uniquement pour autoriser certaines fonctions
                                à être appelées depuis XPath.
                                
                                Ce paramètre peut être soit une chaîne de caractères (un nom de
                                fonction) ou un tableau de noms de fonctions.

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

<comment>See Also:</comment>
   * DOMXPath::registerNamespace
   * DOMXPath::query
   * DOMXPath::evaluate


id: DOM_INDEX_SIZE_ERR
type: constant
doc:
<comment>Description:</comment>
  Si l'index ou la taille sont négatifs ou plus grands que la valeur autorisée.


id: DOM_INUSE_ATTRIBUTE_ERR
type: constant
doc:
<comment>Description:</comment>
  Si une tentative est faite d'ajouter un attribut qui est déjà utilisé autre part.


id: DOM_INVALID_ACCESS_ERR
type: constant
doc:
<comment>Description:</comment>
  Si un paramètre ou une opération n'est pas supporté par l'objet fondamental.


id: DOM_INVALID_CHARACTER_ERR
type: constant
doc:
<comment>Description:</comment>
  Si un caractère invalide ou non autorisé est spécifié, par exemple, dans un nom.


id: DOM_INVALID_MODIFICATION_ERR
type: constant
doc:
<comment>Description:</comment>
  Si une tentative est faite de modifier le type d'un objet fondamental.


id: DOM_INVALID_STATE_ERR
type: constant
doc:
<comment>Description:</comment>
  Si une tentative est faite d'utiliser un objet qui n'est pas, ou n'est plus, utilisable.


id: DOM_NAMESPACE_ERR
type: constant
doc:
<comment>Description:</comment>
  Si une tentative est faite de créer ou de modifier un objet dans un sens qui est incorrect au
  regard de l'espace de noms.


id: DOM_NOT_FOUND_ERR
type: constant
doc:
<comment>Description:</comment>
  Si une tentative est faite de référencer un nœud dans un contexte où il n'existe pas.


id: DOM_NOT_SUPPORTED_ERR
type: constant
doc:
<comment>Description:</comment>
  Si l'implémentation ne supporte pas le type requis de l'objet ou de l'opération.


id: DOM_NO_DATA_ALLOWED_ERR
type: constant
doc:
<comment>Description:</comment>
  Si des données sont spécifiées dans un nœud qui ne supporte pas les données.


id: DOM_NO_MODIFICATION_ALLOWED_ERR
type: constant
doc:
<comment>Description:</comment>
  Si une tentative est faite de modifier un objet où les modifications ne sont pas autorisées.


id: DOM_PHP_ERR
type: constant
doc:
<comment>Description:</comment>
  Code erreur ne faisant pas partie de la spécification DOM. Utilisé pour les erreurs PHP.


id: DOM_VALIDATION_ERR
type: constant
doc:
<comment>Description:</comment>
  Si un appel à une méthode tel que insertBefore ou removeChild voudrait rendre le nœud invalide
  avec le respect de la validation partielle, cette exception sera exécutée et l'opération ne sera
  pas effectuée.


id: DOM_WRONG_DOCUMENT_ERR
type: constant
doc:
<comment>Description:</comment>
  Si un nœud est utilisé dans un document autre que celui qui l'a créé.


id: DatabaseObject::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Check if object exists in database
  
  Verifies if the database object refers to an object that exists in the database.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if object exists in the database, else <info>false</info> if it does not.


id: DatabaseObject::getName
type: function
doc:
<comment>Description:</comment>
  Get object name
  
  Fetch name of this database object.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>string</info>  The name of this database object.


id: DatabaseObject::getSession
type: function
doc:
<comment>Description:</comment>
  Get session name
  
  Fetch session associated to the database object.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>mysql_xdevapi\Session</info>  The Session object.


id: DateInterval
type: class
doc:
<comment>Description:</comment>
  Représente un intervalle de dates.
  
  Un intervalle stocke un nombre fixe de durées (en années, mois, jours, heures, etc.) ou une chaîne
  relative à une durée dans un format compréhensible par le constructeur de la classe <class>DateTime</class> et
  <class>DateTimeImmutable</class>.
  
  Plus précisement, l'information d'un objet de la classe <class>DateInterval</class> est une instruction pour
  aller d'une date/moment à une autre date/moment. Ce processus n'est pas toujours réversible.
  
  Une façon typique de créer un objet <class>DateInterval</class> est en calculant la différence entre deux objets
  dates/moments à travers DateTimeInterface::diff.
  
  Comme il n'y a pas une manière bien définie pour comparer les intervalles, les instances de
  <class>DateInterval</class> sont incomparables.


id: DateInterval::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DateInterval
  
  Crée un nouvel objet DateInterval.

<comment>Param:</comment>
  <info>string</info>  <strong>$duration</strong>  Une spécification d'intervalle.
                     
                     Le format commence avec la lettre <return>P</return>, pour period. Chaque durée de la période
                     est représentée par une valeur entière suivie par une désignation de période.
                     Si la durée contient des éléments de temps, cette portion de la spécification
                     est précédée par la lettre <return>T</return>.
                     
                      Désignation de période <strong>$duration</strong> Désignation de
                     périodeDescription<return>Y</return>Années<return>M</return>Mois<return>D</return>Jours<return>W</return> Semaine. Converti en jours. Antérieur à
                     PHP 8.0.0, ne peut pas être combiné avec <return>D</return>. <return>H</return>Heures<return>M</return>Minutes<return>S</return>Secondes
                     
                     Voici quelques exemples simples : 2 jours sera <return>P2D</return> ; 2 secondes sera <return>PT2S</return> ; 6
                     années et 5 minutes sera <return>P6YT5M</return>.
                     
                     Les types d'unité doivent être entrés des plus grands aux plus petits. Ainsi,
                     les années doivent être présentes avant les mois, les mois avant les jours, les
                     jours avant les minutes, etc. Aussi, une année et 4 jours doit être représenté
                     comme <return>P1Y4D</return>, et non <return>P4D1Y</return>.
                     
                     Cette spécification peut également être représentée sous la forme d'une durée.
                     Aussi, une année et 4 jours peut être <return>P0001-00-04T00:00:00</return>. Mais les valeurs de
                     ce format ne peuvent pas excéder une période donnée (i.e. <return>25</return> heures est
                     invalide).
                     
                     Ces formats sont basés sur la spécification de durée ISO 8601.

<comment>See Also:</comment>
   * <strong>DateInterval::format()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>
   * <strong>DateTime::diff()</strong>


id: DateInterval::createFromDateString
type: function
doc:
<comment>Description:</comment>
  Configure un objet DateInterval à partir des parties d'une chaîne
  
  Style orienté objet
  
  Style procédural
  
  Utilise les analyseurs de dates comme celui de  <class>DateTimeImmutable</class> et  configure un objet
  <class>DateInterval</class>  à partir d'une chaîne de caractères.

<comment>Param:</comment>
  <info>string</info>  <strong>$datetime</strong>  Une date avec des parties relatives. Spécifiquement, le format relatif supporté
                     par l'analyseur utilisé pour les classes <class>DateTimeImmutable</class>, <class>DateTime</class> et la
                     fonction <class>strtotime</class> sera utilisé pour construire le DateInterval.

<comment>Return:</comment>
  <info>DateInterval|false</info>  Retourne un nouvel objet <class>DateInterval</class> en cas de succès,  ou <info>false</info> si une
                      erreur survient.


id: DateInterval::format
type: function
doc:
<comment>Description:</comment>
  Formate l'intervalle
  
  Formate l'intervalle.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>   Les caractères suivants sont reconnus dans la chaîne <strong>$format</strong>. Chaque caractère
                   utilisé pour le format doit être préfixé par un signe de pourcentage (<return>%</return>).
                   Caractère de <strong>$format</strong>DescriptionValeur d'exemple<return>%</return>Caractère <return>%</return> littéral<return>%</return><return>Y</return>Année,
                   numérique, au moins 2 chiffres avec zéros initiaux<return>01</return>, <return>03</return><return>y</return>Année, numérique<return>1</return>,
                   <return>3</return><return>M</return>Mois, numérique, au moins 2 chiffres avec zéros initiaux<return>01</return>, <return>03</return>, <return>12</return><return>m</return>Mois,
                   numérique<return>1</return>, <return>3</return>, <return>12</return><return>D</return>Jour, numérique, au moins 2 chiffres avec zéros initiaux<return>01</return>, <return>03</return>,
                   <return>31</return><return>d</return>Jour, numérique<return>1</return>, <return>3</return>, <return>31</return><return>a</return>Nombre total de jours, provenant de la méthode
                   DateTime::diff ou <return>(unknown)</return> sinon<return>4</return>, <return>18</return>, <return>8123</return><return>H</return>Heure, numérique, au moins 2
                   chiffres avec zéros initiaux<return>01</return>, <return>03</return>, <return>23</return><return>h</return>Heure, numérique<return>1</return>, <return>3</return>, <return>23</return><return>I</return>Minute,
                   numérique, au moins 2 chiffres avec zéros initiaux<return>01</return>, <return>03</return>, <return>59</return><return>i</return>Minute, numérique<return>1</return>,
                   <return>3</return>, <return>59</return><return>S</return>Seconde, numérique, au moins 2 chiffres avec zéros initiaux<return>01</return>, <return>03</return>,
                   <return>57</return><return>s</return>Seconde, numérique<return>1</return>, <return>3</return>, <return>57</return><return>F</return>Microsecondes, numérique, au moins 6 chiffres, avec
                   zéros initiaux<return>007701</return>, <return>052738</return>, <return>428291</return><return>f</return>Microsecondes, numérique<return>7701</return>, <return>52738</return>,
                   <return>428291</return><return>R</return>Signe "<return>-</return>" lorsque négatif, "<return>+</return>" si positif<return>-</return>, <return>+</return><return>r</return>Signe "<return>-</return>" lorsque négatif,
                   vide si positif<return>-</return>,

<comment>Return:</comment>
  <info>string</info>  Retourne l'intervalle formaté.

<comment>See Also:</comment>
   * DateTime::diff


id: DatePeriod
type: class
doc:
<comment>Description:</comment>
  Représente une période de dates.
  
  Une période de dates permet des itérations à travers un jeu de dates et d'heures, survenant à
  intervalle régulier, sur une période donnée.


id: DatePeriod::EXCLUDE_START_DATE
type: constant
doc:
<comment>Description:</comment>
  Exclut la date de début, utilisée par <strong>DatePeriod::__construct()</strong>.


id: DatePeriod::INCLUDE_END_DATE
type: constant
doc:
<comment>Description:</comment>
  Inclut la date de fin, utilisée par <strong>DatePeriod::__construct()</strong>.


id: DatePeriod::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DatePeriod
  
  Cette variante du constructeur a été rendu obsolète, utilisez DatePeriod::createFromISO8601String
  à la place.
  
  Crée un nouvel objet <class>DatePeriod</class>.
  
  Les objets<class>DatePeriod</class> peuvent être utilisés comme itérateur pour générer un certain nombre d'objets
  <class>DateTimeImmutable</class> ou <class>DateTime</class> à partir d'une <strong>$start</strong> date (date de début), un <strong>$interval</strong>, et une
  <strong>$end</strong> date (date de fin) ou du nombre de <strong>$récurrences</strong>.
  
  La classe des objets renvoyés est équivalente à la classe ancêtre <class>DateTimeImmutable</class> ou <class>DateTime</class>
  fournis pas l'objet <strong>$start</strong>.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$start</strong>        La date de début de la période. Inclus par défaut dans le jeu de
                                   résultats.
  <info>DateInterval</info>       <strong>$interval</strong>     L'intervalle entre les récurrences de la période.
  <info>int</info>                <strong>$recurrences</strong>  Le nombre de récurrences. Doit être plus grand que <return>0</return>. Le nombre
                                   de résultats renvoyés est supérieur d'une unité, car la date de
                                   début est incluse dans le jeu de résultats par défaut.
  <info>DateTimeInterface</info>  <strong>$end</strong>          La date de fin de la période. Non inclus par défaut dans le jeu
                                   de résultats.
  <info>string</info>             <strong>$isostr</strong>       Un sous-ensemble de la   spécification ISO 8601 de la répétition
                                   de l'intervalle.
                                   
                                   Exemples de certaines fonctionnalités de spécification
                                   d'intervalle  ISO 8601 que PHP ne prend pas en charge :
                                   
                                   Les occurrences zéro (<return>R0/</return>)
                                   
                                   Décalages horaires autres que UTC (<return>Z</return>), tels que <return>+02:00</return>.
  <info>int</info>                <strong>$options</strong>      Un champ de bits qui peut être utilisé pour contrôler certains
                                   comportements avec les dates de début et de fin.
                                   
                                   Peut être configuré à <info>DatePeriod::EXCLUDE_START_DATE</info> pour exclure
                                   la date de début du jeu de dates de récursion dans la période.
                                   
                                   Peut être configuré à <info>DatePeriod::INCLUDE_END_DATE</info> pour inclure
                                   la date de fin du jeu de dates de récursion dans la période.


id: DatePeriod::createFromISO8601String
type: function
doc:
<comment>Description:</comment>
  Creates a new DatePeriod object from an ISO8601 string
  
  Creates a new DatePeriod object from an ISO8601 string, as specified with <strong>$specification</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$specification</strong>  A subset of the ISO 8601 repeating interval specification.
                          
                          An example of an accepted ISO 8601 interval specifications is
                          <return>R5/2008-03-01T13:00:00Z/P1Y2M10DT2H30M</return>, which specifies:
                          
                          5 iterations (<return>R5/</return>)
                          
                          Starting at <return>2008-03-01T13:00:00Z</return>.
                          
                          Each iteration is an 1 year, 2 months, 10 days, 2 hours, and 30 minute
                          interval (<return>/P1Y2M10DT2H30M</return>).
                          
                          Examples of some ISO 8601 interval specification features that PHP does
                          not support are:
                          
                          zero occurrences (<return>R0/</return>)
                          
                          time offsets other than UTC (<return>Z</return>), such as <return>+02:00</return>.
  <info>int</info>     <strong>$options</strong>        A bit field which can be used to control certain behaviour with start- and
                          end- dates.
                          
                          With <info>DatePeriod::EXCLUDE_START_DATE</info> you exclude the start date from the
                          set of recurring dates within the period.
                          
                          With <info>DatePeriod::INCLUDE_END_DATE</info> you include the end date in the set of
                          recurring dates within the period.

<comment>Return:</comment>
  <info>static</info>  Creates a new DatePeriod object.
          
          <class>DatePeriod</class> objects created with this method can be used as an iterator to generate a
          number of <class>DateTimeImmutable</class> objects.


id: DatePeriod::getDateInterval
type: function
doc:
<comment>Description:</comment>
  Retourne l'intervalle
    
  
  Style orienté objet
  
  Retourne un <info>objet</info> <class>DateIntervalle</class> représentant l'intervalle utilisé pour la période.

<comment>Return:</comment>
  <info>DateInterval</info>  Retourne un <info>objet</info> <class>DateInterval</class>

<comment>See Also:</comment>
   * DatePeriod::getStartDate
   * DatePeriod::getEndDate


id: DatePeriod::getEndDate
type: function
doc:
<comment>Description:</comment>
  Retourne la date de fin
    
  
  Style orienté objet
  
  Retourne la date de fin de la période.

<comment>Return:</comment>
  <info>DateTimeInterface|null</info>  Retourne <info>null</info> si la <class>DatePeriod</class> n'a pas de date de fin.  Par exemple,
                          lorsqu'elle est initialisée avec le paramètre <strong>$recurrences</strong>,  ou avec le
                          paramètre <strong>$isostr</strong> sans date de fin.
                          
                          Renvoie un <info>object</info> <class>DateTimeImmutable</class> lorsque la <class>DatePeriod</class> est initialisée
                          avec un <info>object</info> <class>DateTimeImmutable</class> comme paramètre <strong>$end</strong>.
                          
                          Retourne un <info>object</info> <class>DateTime</class> cloné représentant la date de fin sinon.

<comment>See Also:</comment>
   * DatePeriod::getStartDate
   * DatePeriod::getDateInterval


id: DatePeriod::getRecurrences
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre de récurrences
  
  Style orienté objet
  
  Récupère le nombre de récurrences.

<comment>Return:</comment>
  <info>int|null</info>  Le nombre de récurrences est défini en passant explicitement la valeur de <return>$recurrences</return>
            au constructeur de la classe <class>DatePeriod</class>, sinon il est défini comme <info>null</info>.

<comment>See Also:</comment>
   * DatePeriod::$recurrences


id: DatePeriod::getStartDate
type: function
doc:
<comment>Description:</comment>
  Obtient la date de début
    
  
  Style orienté objet
  
  Obtient la date de début d'une période.

<comment>Return:</comment>
  <info>DateTimeInterface</info>  Renvoi un <info>object</info> <class>DateTimeImmutable</class> quand la <class>DatePeriod</class> est initialisée avec un
                     <info>object</info> <class>DateTimeImmutable</class> comme paramètre <strong>$start</strong>.
                     
                     Renvoi un <info>object</info> <class>DateTime</class> dans les autres cas.

<comment>See Also:</comment>
   * DatePeriod::getEndDate
   * DatePeriod::getDateInterval


id: DateTime
type: class
doc:
<comment>Description:</comment>
  Représentation de la date et du temps.
  
  Cette classe se comporte comme <class>DateTimeImmutable</class>, à l'exception que les objets se modifient
  eux-mêmes quand une méthode de modification telle que <strong>DateTime::modify()</strong> est appelée.
  
  L'appel de méthodes sur des objets de la classe <class>DateTime</class> modifiera les informations encapsulées
  dans ces objets, si vous voulez éviter cela, vous devrez utiliser l'opérateur <return>clone</return> pour  créer un
  nouvel objet. L'utilisation de <class>DateTimeImmutable</class> au lieu de <class>DateTime</class> est recommandée pour obtenir
  ce  comportement par défaut.


id: DateTime::__construct
type: function
doc:
<comment>Description:</comment>
  Retourne un nouvel objet DateTime
  
  Comme DateTimeImmutable::__construct mais fonctionne avec <class>DateTime</class>. Considérer l'utilisation de
  <class>DateTimeImmutable</class> et ses fonctionnalités à la place.
  
  Retourne un nouvel objet <class>DateTime</class>.

<comment>Param:</comment>
  <info>string</info>             <strong>$datetime</strong>  Une chaîne date/heure. Les formats valides sont expliqués dans la
                                documentation sur les
                                formats Date et Heure.
                                
                                Passer <return>"now"</return> pour obtenir le temps courant lors de l'utilisation du
                                paramètre <strong>$timezone</strong>.
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  Un object <class>DateTimeZone</class> représentant le fuseau horaire de <strong>$datetime</strong>.
                                
                                Si <strong>$timezone</strong> est omit ou <info>null</info>, le fuseau horaire actuel sera
                                utilisé.
                                
                                Le paramètre <strong>$timezone</strong> et le fuseau horaire actuel sont ignorés
                                quand le paramètre <strong>$datetime</strong> est un horodatage UNIX (e.g.
                                <return>@946684800</return>) ou spécifie un fuseau horaire (e.g.
                                <return>2010-01-28T15:00:00+02:00</return>).

<comment>Return:</comment>
  <info>unknown</info>  Retourne une nouvelle instance DateTime.

<comment>See Also:</comment>
   * DateTimeImmutable::__construct


id: DateTime::__set_state
type: function
doc:
<comment>Description:</comment>
  Le gestionnaire __set_state
  
  Le gestionnaire __set_state().
  
  Comme DateTimeImmutable::__set_state mais fonctionne avec <class>DateTime</class>.

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Le tableau d'initialisation.

<comment>Return:</comment>
  <info>DateTime</info>  Retourne une nouvelle instance de l'objet <class>DateTime</class>.


id: DateTime::__wakeup
type: function
doc:
<comment>Description:</comment>
  Le gestionnaire __wakeup
  
  Le gestionnaire __wakeup().

<comment>Return:</comment>
  <info>void</info>  Initialise un objet DateTime.


id: DateTime::add
type: function
doc:
<comment>Description:</comment>
  Modifie un objet un objet DateTime, avec le nombre de jours, mois, années, heures, minutes et
  secondes ajouté
    
  
  Style orienté objet
  
  Style procédural
  
  Ajoute la durée de l'objet <class>DateInterval</class> à l'objet  <class>DateTime</class>.
  
  Comme DateTimeImmutable::add mais fonctionne avec <class>DateTime</class>.
  
  La version procédurale prend un objet <class>DateTime</class> comme premier argument.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Style procédural uniquement : Un objet <class>DateTime</class> retourné par la fonction
                           <strong>date_create()</strong>. Cette fonction modifie cet objet.
  <info>DateInterval</info>  <strong>$interval</strong>  Un objet <class>DateInterval</class>

<comment>Return:</comment>
  <info>DateTime</info>  Retourne l'objet modifié <class>DateTime</class> pour chainer les méthodes.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>


id: DateTime::createFromFormat
type: function
doc:
<comment>Description:</comment>
  Analyse une heure au format texte selon le format spécifié.
    
  
  Style orienté objet
  
  Style procédural
  
  Retourne un nouvel objet DateTime représentant la date et l'heure spécifiées par le texte
  <strong>$datetime</strong>, qui a été formaté dans le  <strong>$format</strong> donné.
  
  Identique à DateTimeImmutable::createFromFormat  mais crée une instance de l'objet <class>DateTime</class>.
  
  Cette méthode, y compris les paramètres, les exemples et les considérations, est documentée sur la
  page DateTimeImmutable::createFromFormat.

<comment>Return:</comment>
  <info>DateTime|false</info>  Retourne un nouvel objet <class>DateTime</class> ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::createFromFormat()</strong>


id: DateTime::createFromImmutable
type: function
doc:
<comment>Description:</comment>
  Retourne une nouvelle instance d'objet DateTime encapsulant l'objet DateTimeImmutable fourni

<comment>Param:</comment>
  <info>DateTimeImmutable</info>  <strong>$object</strong>  L'objet immuable <class>DateTimeImmutable</class> qui doit être converti en une
                              version mutable. Cet objet n'est pas modifié, mais une nouvelle
                              instance d'objet <class>DateTime</class> est créée contenant les même informations de
                              date, temps, et fuseau horaire.

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


id: DateTime::createFromInterface
type: function
doc:
<comment>Description:</comment>
  Retourne un nouvel objet DateTime encapsulant l'objet DateTimeInterface fourni

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  L'objet <class>DateTimeInterface</class> qui doit être converti en une version
                              mutable. Cet objet n'est pas modifié, mais une nouvelle instance
                              d'objet <class>DateTime</class> est créé contenant les même informations de date,
                              temps, et fuseau horaire.

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


id: DateTime::diff
type: function
doc:
<comment>Description:</comment>
  Retourne la différence entre deux objets DateTime
  
  Style orienté objet
  
  Style procédural
  
  Retourne la différence entre deux objets <class>DateTimeInterface</class>.

<comment>Param:</comment>
  <info></info>      <strong>$datetime</strong>  La date à comparer.
  <info>bool</info>  <strong>$absolute</strong>  Doit-on forcer l'intervalle à être positif ?

<comment>Return:</comment>
  <info>DateInterval</info>  L'objet <class>DateInterval</class> représente la différence entre les deux dates.
                
                La valeur de retour représente de façon plus détaillé l'intervale de temps  à
                appliquer sur l'objet original (<strong>$this</strong> ou <strong>$originObject</strong>) pour arriver à
                <strong>$targetObject</strong>. Cette procédure n'est pas toujours réversible.
                
                La méthode est consciente des changements d'heure d'été et peut donc renvoyer  un
                intervalle de <return>24 heures et 30 minutes</return>, comme dans l'un  des exemples. Si vous
                souhaitez calculer avec le temps absolu, vous devez  d'abord convertir à la fois
                <strong>$this</strong>/ <strong>$baseObject</strong> et <strong>$targetObject</strong>  en UTC.

<comment>See Also:</comment>
   * <strong>DateInterval::format()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>


id: DateTime::format
type: function
doc:
<comment>Description:</comment>
  Retourne une date formatée suivant le format fourni
  
  Style orienté objet
  
  Style procédural
  
  Retourne une date formatée suivant le format fourni.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Seulement en style procédural : un objet <class>DateTime</class> retourné par
                              <strong>date_create()</strong>
  <info>string</info>             <strong>$format</strong>  Le format de la date désirée. Voir les options de formatage
                              ci-dessous. Il existe aussi de nombreuses  constantes de dates qui
                              peuvent être utilisées, ce qui fait que <info>DATE_RSS</info> va remplacer le
                              format <return>"D, d M Y H:i:s"</return>.
                              
                               Les caractères suivants sont reconnus dans le paramètre <strong>$format</strong>
                              Caractères pour le paramètre <strong>$format</strong>DescriptionExemple de valeurs
                              retournéesJour------<return>d</return>Jour du mois, sur deux chiffres (avec un zéro
                              initial)<return>01</return> à <return>31</return><return>D</return>Jour de la semaine, en trois lettres (et en anglais -
                              par défaut : en anglais, ou sinon, dans la langue locale du
                              serveur)<return>Mon</return> à <return>Sun</return><return>j</return>Jour du mois sans les zéros initiaux<return>1</return> à <return>31</return><return>l</return> ('L'
                              minuscule)Jour de la semaine, textuel, version longue, en
                              anglais<return>Sunday</return> à <return>Saturday</return><return>N</return>Représentation numérique ISO 8601 du jour de
                              la semaine<return>1</return> (pour Lundi) à <return>7</return> (pour Dimanche)<return>S</return>Suffixe ordinal d'un
                              nombre pour le jour du mois, en anglais, sur deux lettres<return>st</return>, <return>nd</return>, <return>rd</return> ou
                              <return>th</return>.  Fonctionne bien avec <return>j</return> <return>w</return>Jour de la semaine au format numérique<return>0</return>
                              (pour dimanche) à <return>6</return> (pour samedi)<return>z</return>Jour de l'année<return>0</return> à
                              <return>365</return>Semaine------<return>W</return>Numéro de semaine dans l'année ISO 8601, les semaines
                              commencent le lundiExemple : <return>42</return> (la 42ème semaine de
                              l'année)Mois------<return>F</return>Mois, textuel, version longue; en anglais, comme
                              <return>January</return> ou <return>December</return><return>January</return> à <return>December</return><return>m</return>Mois au format numérique, avec
                              zéros initiaux<return>01</return> à <return>12</return><return>M</return>Mois, en trois lettres, en anglais<return>Jan</return> à <return>Dec</return><return>n</return>Mois
                              sans les zéros initiaux<return>1</return> à <return>12</return><return>t</return>Nombre de jours dans le mois<return>28</return> à
                              <return>31</return>Année------<return>L</return>Est ce que l'année est bissextile<return>1</return> si bissextile, <return>0</return>
                              sinon.<return>o</return>La numérotation de semaine dans l'année ISO 8601. C'est la même
                              valeur que <return>Y</return>, excepté si le numéro de la semaine ISO (<return>W</return>) appartient à
                              l'année précédente ou suivante, cette année sera utilisée à la
                              place.Exemples : <return>1999</return> ou <return>2003</return><return>X</return> Une représentation numérique complète
                              étendue d'une année, d'au moins 4 chiffres, avec un <return>-</return> pour les années
                              avant l'ère commune et un <return>+</return> pour les années de l'ère commune.
                              Exemples : <return>-0055</return>, <return>+0787</return>, <return>+1999</return>, <return>+10191</return> <return>x</return> Une représentation numérique
                              complète étendue si nécessaire, ou une représentation numérique
                              complète standard si possible (comme <return>Y</return>). Au moins quatre chiffres. Les
                              années antérieures à l'ère commune sont préfixées par un <return>-</return>. Les années
                              au-delà (et y compris) du <return>10000</return> sont préfixées par un <return>+</return>.  Exemples :
                              <return>-0055</return>, <return>0787</return>, <return>1999</return>, <return>+10191</return> <return>Y</return>Une représentation numérique complète d'une
                              année, au moins 4 chiffres, avec <return>-</return> pour les années av. J.-C.Exemples :
                              <return>-0055</return>, <return>0787</return>, <return>1999</return>, <return>2003</return>, <return>10191</return><return>y</return>Année sur 2 chiffresExemples : <return>99</return> ou
                              <return>03</return>Heure------<return>a</return>Ante meridiem et Post meridiem en minuscules<return>am</return> ou
                              <return>pm</return><return>A</return>Ante meridiem et Post meridiem en majuscules<return>AM</return> ou <return>PM</return><return>B</return>Heure Internet
                              Swatch<return>000</return> à <return>999</return><return>g</return>Heure, au format 12h, sans les zéros initiaux<return>1</return> à
                              <return>12</return><return>G</return>Heure, au format 24h, sans les zéros initiaux<return>0</return> à <return>23</return><return>h</return>Heure, au
                              format 12h, avec les zéros initiaux<return>01</return> à <return>12</return><return>H</return>Heure, au format 24h, avec
                              les zéros initiaux<return>00</return> à <return>23</return><return>i</return>Minutes avec les zéros initiaux<return>00</return> à
                              <return>59</return><return>s</return>Secondes avec zéros initiaux<return>00</return> à <return>59</return><return>u</return> Microsecondes. Notez que la
                              fonction <strong>date()</strong> génèrera toujours <return>000000</return> vu qu'elle prend un paramètre
                              de type entier, alors que la méthode DateTime::format supporte les
                              microsecondes si <class>DateTime</class> a été créée avec des microsecondes. Exemple
                              : <return>654321</return><return>v</return> Millisecondes. Même note que pour <return>u</return>. Exemple: <return>654</return>Fuseau
                              horaire------<return>e</return>L'identifiant du fuseau horaireExemples : <return>UTC</return>, <return>GMT</return>,
                              <return>Atlantic/Azores</return><return>I</return> (i majuscule)L'heure d'été est activée ou pas<return>1</return> si
                              oui, <return>0</return> sinon.<return>O</return>Différence d'heures avec l'heure de Greenwich (GMT),
                              sans deux-points entre les heures et les minutesExemple :
                              <return>+0200</return><return>P</return>Différence avec l'heure Greenwich (GMT) avec un deux-points
                              entre les heures et les minutesExemple : <return>+02:00</return><return>p</return> Identique à <return>P</return>, mais
                              retourne <return>Z</return> au lieu de <return>+00:00</return> (disponible à partir de PHP 8.0.0)
                              Exemples : <return>Z</return> ou <return>+02:00</return><return>T</return>Abréviation du fuseau horaire, si connu ; sinon
                              décalage depuis GMTExemples : <return>EST</return>, <return>MDT</return>, <return>+05</return><return>Z</return>Décalage horaire en
                              secondes. Le décalage des zones à l'ouest de la zone UTC est négatif,
                              et à l'est, il est positif.<return>-43200</return> à <return>50400</return>Date et Heure
                              complète------<return>c</return>Date au format ISO 86012004-02-12T15:19:21+00:00<return>r</return>Format
                              de date RFC 2822/RFC 5322Exemple : <return>Thu, 21 Dec 2000
                              16:01:070200</return><return>U</return>Secondes depuis l'époque Unix (1er Janvier 1970,  0h00
                              00s GMT)Voir aussi <strong>time()</strong>
                              
                              Les caractères non reconnus seront imprimés tels quels. "<return>Z</return>" retournera
                              toujours <return>0</return> lorsqu'il est utilisé avec <strong>gmdate()</strong>.
                              
                              Sachant que cette fonction n'accepte que des entiers sous la forme de
                              timestamp, le caractère <return>u</return> n'est utile que lors de l'utilisation de la
                              fonction <strong>date_format()</strong> avec un timestamp utilisateur créé avec la
                              fonction <strong>date_create()</strong>.

<comment>Return:</comment>
  <info>string</info>  Retourne la date formatée, sous forme de chaîne de caractères, en cas de succès.

<comment>See Also:</comment>
   * IntlDateFormatter::format


id: DateTime::getLastErrors
type: function
doc:
<comment>Description:</comment>
  Alias de DateTimeImmutable::getLastErrors
  
  Cette fonction est un alias de :  DateTimeImmutable::getLastErrors


id: DateTime::getOffset
type: function
doc:
<comment>Description:</comment>
  Retourne le décalage horaire
  
  Style orienté objet
  
  Style procédural
  
  Retourne le décalage horaire.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Seulement en style procédural : un objet <class>DateTime</class> retourné par
                              <strong>date_create()</strong>

<comment>Return:</comment>
  <info>int</info>  Retourne le décalage horaire en seconde, depuis UTC en cas de succès.


id: DateTime::getTimestamp
type: function
doc:
<comment>Description:</comment>
  Récupère le timestamp Unix
  
  Style orienté objet
  
  Style procédural
  
  Récupère le timestamp Unix.

<comment>Return:</comment>
  <info>int</info>  Retourne le timestamp Unix représentant la date.

<comment>See Also:</comment>
   * <strong>DateTime::setTimestamp()</strong>
   * <strong>DateTimeImmutable::setTimestamp()</strong>
   * <strong>DateTimeInterface::format()</strong>


id: DateTime::getTimezone
type: function
doc:
<comment>Description:</comment>
  Retourne le fuseau horaire relatif au DateTime fourni
  
  Style orienté objet
  
  Style procédural
  
  Retourne le fuseau horaire relatif au DateTime fourni.

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  Seulement en style procédural : un objet <class>DateTime</class> retourné par
                              <strong>date_create()</strong>

<comment>Return:</comment>
  <info>DateTimeZone|false</info>  Retourne un objet <class>DateTimeZone</class> en cas de succès ou <info>false</info> si une erreur
                      survient.

<comment>See Also:</comment>
   * <strong>DateTime::setTimezone()</strong>


id: DateTime::modify
type: function
doc:
<comment>Description:</comment>
  Modifie le timestamp
  
  Style orienté objet
  
  Style procédural
  
  Modifie le timestamp d'un objet <class>DateTime</class>  en l'incrémentant ou le décrémentant dans un format
  acceptable par <strong>strtotime()</strong>.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>    Style procédural uniquement : Un objet <class>DateTime</class> retourné par la fonction
                       <strong>date_create()</strong>. Cette fonction modifie cet objet.
  <info>string</info>    <strong>$modifier</strong>  Une chaîne date/heure. Les formats valides sont expliqués dans la
                       documentation sur les
                       formats Date et Heure.

<comment>Return:</comment>
  <info>DateTime|false</info>  Retourne l'objet modifié <class>DateTime</class> pour chainer les méthodes ou <info>false</info> si une erreur
                  survient.

<comment>See Also:</comment>
   * <strong>strtotime()</strong>
   * <strong>DateTimeImmutable::modify()</strong>
   * <strong>DateTime::add()</strong>
   * <strong>DateTime::sub()</strong>
   * <strong>DateTime::setDate()</strong>
   * <strong>DateTime::setISODate()</strong>
   * <strong>DateTime::setTime()</strong>
   * <strong>DateTime::setTimestamp()</strong>


id: DateTime::setDate
type: function
doc:
<comment>Description:</comment>
  Assigne la date
  
  Style orienté objet
  
  Style procédural
  
  Assigne la date courante de l'objet <class>DateTime</class> à une nouvelle date.
  
  Comme DateTimeImmutable::setDate mais fonctionne avec <class>DateTime</class> et modifie l'objet existant.
  
  La version procédurale prend un objet <class>DateTime</class> comme premier argument.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  Style procédural uniquement : Un objet <class>DateTime</class> retourné par la fonction
                     <strong>date_create()</strong>. Cette fonction modifie cet objet.
  <info>int</info>       <strong>$year</strong>    Année de la date.
  <info>int</info>       <strong>$month</strong>   Mois de la date.
  <info>int</info>       <strong>$day</strong>     Jour de la date.

<comment>Return:</comment>
  <info>DateTime</info>  Retourne l'objet modifié <class>DateTime</class> pour chainer les méthodes.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>


id: DateTime::setISODate
type: function
doc:
<comment>Description:</comment>
  Configure une date ISO
  
  Style orienté objet
  
  Style procédural
  
  Configure une date au format ISO 8601 : en utilisant des décalages de semaines et de jours, au
  lieu de dates spécifiques.
  
  Comme DateTimeImmutable::setISODate mais fonctionne avec <class>DateTime</class>.
  
  La version procédurale prend un objet <class>DateTime</class> comme premier argument.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>     Style procédural uniquement : Un objet <class>DateTime</class> retourné par la fonction
                        <strong>date_create()</strong>. Cette fonction modifie cet objet.
  <info>int</info>       <strong>$year</strong>       L'année de la date.
  <info>int</info>       <strong>$week</strong>       Le numéro de la semaine.
  <info>int</info>       <strong>$dayOfWeek</strong>  Décalage par rapport au premier jour de la semaine.

<comment>Return:</comment>
  <info>DateTime</info>  Retourne l'objet modifié <class>DateTime</class> pour chainer les méthodes.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setISODate()</strong>


id: DateTime::setTime
type: function
doc:
<comment>Description:</comment>
  Assigne l'heure
  
  Style orienté objet
  
  Style procédural
  
  Change le temps dans l'objet <class>DateTime</class>.
  
  Comme DateTimeImmutable::setTime mais fonctionne avec <class>DateTime</class>.
  
  La version procédurale prend un objet <class>DateTime</class> comme premier argument.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>       Style procédural uniquement : Un objet <class>DateTime</class> retourné par la fonction
                          <strong>date_create()</strong>. Cette fonction modifie cet objet.
  <info>int</info>       <strong>$hour</strong>         Heure du moment.
  <info>int</info>       <strong>$minute</strong>       Minute du moment.
  <info>int</info>       <strong>$second</strong>       Seconde du moment.
  <info>int</info>       <strong>$microsecond</strong>  Microsecondes du moment.

<comment>Return:</comment>
  <info>DateTime</info>  Retourne l'objet modifié <class>DateTime</class> pour chainer les méthodes.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTime()</strong>


id: DateTime::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Assigne la date et l'heure à l'aide d'un horodatage Unix
  
  Style orienté objet
  
  Style procédural
  
  Assigne la date et l'heure à l'aide d'un horodatage Unix.
  
  Comme DateTimeImmutable::setTimestamp mais fonctionne avec <class>DateTime</class>.
  
  La version procédurale prend un objet <class>DateTime</class> comme premier argument.

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>     Style procédural uniquement : Un objet <class>DateTime</class> retourné par la fonction
                        <strong>date_create()</strong>. Cette fonction modifie cet objet.
  <info>int</info>       <strong>$timestamp</strong>  Horodatage Unix représentant la date et l'heure. Définir un horodatage en
                        dehors de l'intervalle d'un entier est possible en utilisant
                        DateTimeImmutable::modify avec le format <return>@</return>.

<comment>Return:</comment>
  <info>DateTime</info>  Retourne l'objet modifié <class>DateTime</class> pour chainer les méthodes.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTimestamp()</strong>


id: DateTime::setTimezone
type: function
doc:
<comment>Description:</comment>
  Configure le fuseau horaire de l'objet DateTime
  
  Style orienté objet
  
  Style procédural
  
  Définit un nouveau fuseau horaire pour un <info>object</info> <class>DateTime</class> .
  
  Comme DateTimeImmutable::setTimezone mais fonctionne avec <class>DateTime</class>.
  
  La version procédurale prend un objet <class>DateTime</class> comme premier argument.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Style procédural uniquement : Un objet <class>DateTime</class> retourné par la fonction
                           <strong>date_create()</strong>. Cette fonction modifie cet objet.
  <info>DateTimeZone</info>  <strong>$timezone</strong>  Un objet <class>DateTimeZone</class> représentant le fuseau horaire désiré.

<comment>Return:</comment>
  <info>DateTime</info>  Retourne l'objet <class>DateTime</class> object pour chainer les méthodes. Le point dans le temps
            sous-jacent n'est pas modifié lors de l'appel de cette méthode.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setTimezone()</strong>
   * <strong>DateTime::getTimezone()</strong>
   * <strong>DateTimeZone::__construct()</strong>


id: DateTime::sub
type: function
doc:
<comment>Description:</comment>
  Soustrait une durée à un objet DateTime
    
  
  Style orienté objet
  
  Style procédural
  
  Modifie l'objet DateTime spécifié, en soustrayant l'objet <class>DateInterval</class> spécifié.
  
  Comme DateTimeImmutable::sub mais fonctionne avec <class>DateTime</class>.
  
  La version procédurale prend un objet <class>DateTime</class> comme premier argument.

<comment>Param:</comment>
  <info>DateTime</info>      <strong>$object</strong>    Style procédural uniquement : Un objet <class>DateTime</class> retourné par la fonction
                           <strong>date_create()</strong>. Cette fonction modifie cet objet.
  <info>DateInterval</info>  <strong>$interval</strong>  Un objet <class>DateInterval</class>

<comment>Return:</comment>
  <info>DateTime</info>  Retourne l'objet modifié <class>DateTime</class> pour chainer les méthodes.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::sub()</strong>


id: DateTimeImmutable
type: class
doc:
<comment>Description:</comment>
  Représentation d'une date et heure.
  
  Cette classe se comporte de la manière identique à <class>DateTime</class> à l'exception que de nouveaux objets
  sont retournés quand des méthodes de modification telle que <strong>DateTime::modify()</strong> sont appelées.


id: DateTimeImmutable::__construct
type: function
doc:
<comment>Description:</comment>
  Retourne un nouvel objet DateTimeImmutable
  
  Style orienté objet
  
  Style procédural
  
  Returns new a DateTimeImmutable object.

<comment>Param:</comment>
  <info>string</info>             <strong>$datetime</strong>  Une chaîne date/heure. Les formats valides sont expliqués dans la
                                documentation sur les
                                formats Date et Heure.
                                
                                Passer <return>"now"</return> pour obtenir le temps courant lors de l'utilisation du
                                paramètre <strong>$timezone</strong>.
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  Un object <class>DateTimeZone</class> représentant le fuseau horaire de <strong>$datetime</strong>.
                                
                                Si <strong>$timezone</strong> est omit ou <info>null</info>, le fuseau horaire actuel sera
                                utilisé.
                                
                                Le paramètre <strong>$timezone</strong> et le fuseau horaire actuel sont ignorés
                                quand le paramètre <strong>$datetime</strong> est un horodatage UNIX (e.g.
                                <return>@946684800</return>) ou spécifie un fuseau horaire (e.g.
                                <return>2010-01-28T15:00:00+02:00</return> ou <return>2010-07-05T06:00:00Z</return>).

<comment>Return:</comment>
  <info>DateTimeImmutable|false</info>  Retourne une nouvelle instance DateTimeImmutable.


id: DateTimeImmutable::__set_state
type: function
doc:
<comment>Description:</comment>
  Le gestionnaire __set_state
  
  Le gestionnaire __set_state().

<comment>Param:</comment>
  <info>array</info>  <strong>$array</strong>  Le tableau d'initialisation.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retourne une nouvelle instance d'un objet DateTimeImmutable.


id: DateTimeImmutable::add
type: function
doc:
<comment>Description:</comment>
  Retourne un nouvel object, avec le nombre de jours, mois, années, heures, minutes et secondes
  ajouté
    
  
  Construit un nouvel objet <class>DateTimeImmutable</class>, et y ajoute l'objet <class>DateInterval</class> spécifié, pour
  représenter la nouvelle valeur.

<comment>Param:</comment>
  <info>DateInterval</info>  <strong>$interval</strong>  Un object <class>DateInterval</class>

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retourne un nouvel objet <class>DateTimeImmutable</class> avec les données modifiées.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::sub()</strong>
   * <strong>DateTimeImmutable::diff()</strong>
   * <strong>DateTimeImmutable::modify()</strong>


id: DateTimeImmutable::createFromFormat
type: function
doc:
<comment>Description:</comment>
  Analyse une heure au format texte selon le format spécifié.
    
  
  Style orienté objet
  
  Style procédural
  
  Retourne un nouvel objet <class>DateTimeImmutable</class>  représentant la date et l'heure spécifiées par la
  chaîne  <strong>$datetime</strong>, qui a été formatée au  <strong>$format</strong> donné.

<comment>Param:</comment>
  <info>string</info>             <strong>$format</strong>    Le format dans lequel <info>string</info> doit être transmise. Voir les  options
                                de formatage ci-dessous. Dans la plupart des cas, les mêmes lettres
                                que pour la <strong>date()</strong> peuvent être utilisées.
                                
                                Tous les champs sont initialisés avec la date/heure actuelle. Dans
                                la  plupart des cas, vous voudrez les remettre à "zéro" (l'époque
                                Unix,  <return>1970-01-01 00:00:00 UTC</return>). Vous pouvez faire cela  en incluant
                                le caractère <return>!</return> comme premier caractère dans  <strong>$format</strong>, ou <return>|</return> comme
                                dernier.  Veuillez consulter la documentation de chaque caractère
                                ci-dessous pour  plus d'informations.
                                
                                Le format est analysé de gauche à droite, ce qui signifie que dans
                                certaines situations, l'ordre dans lequel les caractères de format
                                sont présents affecte le résultat. Dans le cas de <return>z</return>  (le jour de
                                l'année), il est nécessaire qu'une année ait déjà été analysée,  par
                                exemple via les caractères <return>Y</return> ou <return>y</return>.
                                
                                Les lettres utilisées pour l'analyse des nombres autorisent une
                                large plage  de valeurs, en dehors de ce que serait la plage
                                logique. Par exemple,  le <return>d</return> (jour du mois) accepte des valeurs
                                comprises entre  <return>00</return> et <return>99</return>. La seule contrainte est sur  le nombre de
                                chiffres. Le mécanisme de débordement de l'analyseur date/heure  est
                                utilisé lorsque des valeurs hors plage sont données. Les exemples
                                ci-dessous illustrent certains de ces comportements.
                                
                                Cela signifie également que les données analysées pour une lettre de
                                format  sont gourmandes et liront jusqu'au nombre de chiffres que
                                son format autorise.  Cela peut également signifier qu'il n'y a plus
                                assez de caractères dans la chaîne  <strong>$datetime</strong> pour les caractères de
                                format suivants. Un exemple  plus bas sur cette page illustre
                                également ce problème.
                                
                                Les caractères suivants sont reconnus pour le paramètre
                                <strong>$format</strong><strong>$format</strong> characterDescriptionExemple de valeurs
                                analyséesJour------<return>d</return> et <return>j</return>Jour du mois, sur 2 chiffres, avec ou sans
                                le zéro initial<return>01</return> à <return>31</return> ou <return>1</return> à <return>31</return> (les nombres à 2  chiffres
                                supérieurs au nombre de jours du mois sont acceptés,  auquel cas ils
                                feront déborder le mois. Par exemple utiliser  33 avec janvier,
                                signifiera le 2 février) <return>D</return> and <return>l</return>Une représentation textuelle du jour
                                De <return>Mon</return> jusqu'à <return>Sun</return> ou de <return>Sunday</return> jusqu'à <return>Saturday</return> Si le nom de jour
                                donné est différent alors le nom de jour  appartenant à une date
                                analysée (ou par défaut) est différent,  alors un débordement se
                                produit vers la date  suivante avec le nom de jour donné.  Voir les
                                exemples ci-dessous pour une explication. <return>S</return>Préfixe anglais du jour
                                du mois, sur 2 caractères. Il sera ignoré lors de l'analyse.<return>st</return>, <return>nd</return>,
                                <return>rd</return> ou <return>th</return>. <return>z</return> Le jour de l'année (en commençant à 0); doit être
                                précédé par <return>Y</return> ou <return>y</return>. <return>0</return> à <return>365</return> (les nombres à 3 chiffres supérieurs aux
                                nombres d'une année sont  acceptés, auquel cas ils feront déborder
                                l'année. Par exemple,  utiliser 366 avec 2022, signifie le 2 janvier
                                2023) Mois------<return>F</return> et <return>M</return>Une représentation textuelle du mois, comme
                                January ou Sept De <return>January</return> à <return>December</return> ou de <return>Jan</return> à <return>Dec</return> <return>m</return> et <return>n</return>Une
                                représentation numérique du mois, avec ou sans zéro initial De <return>01</return> à
                                <return>12</return> ou de <return>1</return> à <return>12</return> (les nombres à 2 chiffres supérieurs à 12 sont
                                acceptés, auquel cas ils  feront déborder l'année. Par exemple,
                                utiliser 13 signifie janvier de  l'année suivante) Année------<return>X</return> et <return>x</return>
                                Une représentation numérique complète d'une année,  jusqu'à 19
                                chiffres, éventuellement préfixée par  <return>+</return> ou <return>-</return> Exemples : <return>1999</return> ou
                                <return>2003</return><return>Y</return>Une représentation complète de l'année, sur 4 chiffres Exemples
                                : <return>0055</return>, <return>787</return>, <return>1999</return>, <return>-2003</return>, <return>+10191</return> <return>y</return>Une représentation partielle de
                                l'année, sur 2 chiffres (qui doit être dans l'intervalle 1970-2069,
                                inclus) Exemples : <return>99</return> ou <return>03</return> (seront interprétés comme l'année <return>1999</return>
                                et l'année <return>2003</return>, respectivement) Heure------<return>a</return> et <return>A</return>Ante meridiem et
                                Post meridiem<return>am</return> ou <return>pm</return><return>g</return> et <return>h</return>L'heure au format 12-heures, avec ou sans
                                zéro initial De <return>1</return> à <return>12</return> ou de <return>01</return> à <return>12</return> (les nombres à 2 chiffres
                                supérieurs à 12 sont acceptés,  auquel cas ils feront déborder le
                                jour. Par exemple  utiliser 14 signifie 02 dans la prochaine période
                                AM/PM) <return>G</return> et <return>H</return>L'heure au format 24-heures, avec ou sans zéro initial
                                De <return>0</return> à <return>23</return> ou de <return>00</return> à <return>23</return> (les nombres à 2 chiffres supérieurs à 24
                                sont acceptés,  auquel cas ils feront déborder la journée. Par
                                exemple  utiliser 26 signifie 02:00 le lendemain) <return>i</return>Les minutes, avec
                                un zéro initial De <return>00</return> à <return>59</return> (les nombres à 2 chiffres supérieurs à 59
                                sont acceptés,  auquel cas ils feront déborder l'heure. Par exemple
                                utiliser 66 signifie :06 l'heure suivante) <return>s</return>Les secondes, avec un
                                zéro initial De <return>00</return> à <return>59</return> (les nombres à 2 chiffres supérieurs à 59
                                sont acceptés,  auquel cas ils feront déborder la minute. Par
                                exemple  utiliser 90 signifie :30 la minute suivante) <return>v</return>Les
                                millisecondes (jusqu'à 3 chiffres) Exemple: <return>12</return> (<return>0.12</return> secondes), <return>345</return>
                                (<return>0.345</return> secondes) <return>u</return>Les microsecondes (jusqu'à 6 chiffres) Exemple :
                                <return>45</return> (<return>0.45</return> secondes), <return>654321</return> (<return> 0.654321</return> secondes) Fuseau
                                horaire------<return>e</return>, <return>O</return>, <return>P</return> et <return>T</return> L'identifiant du fuseau horaire, ou la
                                différence en heures avec UTC, ou la différence avec UTC avec deux
                                points (:) entre les heures et les minutes, ou l'abréviation du
                                fuseau horaireExemples : <return>UTC</return>, <return>GMT</return>, <return>Atlantic/Azores</return> ou <return>+0200</return> ou
                                <return>+02:00</return> ou <return>EST</return>, <return>MDT</return> Date/heure complète------<return>U</return>Le nombre de secondes
                                depuis l'époque Unix (January 1 1970 00:00:00 GMT)Exemple :
                                <return>1292177455</return>Espace et séparateurs------<return> </return> (espace)Zéro ou plusieurs
                                espaces, tabulations, caractères NBSP (U+A0), ou NNBSP
                                (U+202F)Exemple: <return>"\t"</return>, <return>"  "</return><return>#</return> Un des symboles de séparation suivants
                                : <return>;</return>, <return>:</return>, <return>/</return>, <return>.</return>, <return>,</return>, <return>-</return>, <return>(</return> ou <return>)</return> Exemple : <return>/</return><return>;</return>, <return>:</return>, <return>/</return>, <return>.</return>, <return>,</return>, <return>-</return>, <return>(</return> ou <return>)</return> Le
                                caractère spécifié.Exemple : <return>-</return><return>?</return>Un octet aléatoire Exemple : <return>^</return>
                                (Sachez que pour les  caractères UTF-8, vous pourriez avoir besoin
                                de plus d'un  <return>?</return>. Dans ce cas, utiliser <return>*</return>  est probablement ce que
                                vous voulez à la place) <return>*</return>Octets aléatoires jusqu'au prochain
                                séparateur ou chiffreExemple : <return>*</return> dans <return>Y-*-d</return> avec la chaîne
                                <return>2009-aWord-08</return> trouvera la chaîne <return>aWord</return><return>!</return> Réinitialise tous les champs
                                (année, mois, jour, heure, minute, seconde ainsi que les
                                informations quant au fuseau horaire) à des valeurs similaires à
                                zéro (<return>0</return> pour heure, minute, seconde et fraction, <return>1</return> pour mois et
                                jour, <return>1970</return> pour l'année et <return>UTC</return> pour l'information de fuseau horaire)
                                Sans le caractère <return>!,</return> tous les champs seront définis à la date et
                                heure courante.<return>|</return>Réinitialise tous les champs (année, mois, jour,
                                heure, minute, seconde ainsi que les informations quant au fuseau
                                horaire) à valeurs similaires à zéro s'ils n'ont pas encore été
                                analysés<return>Y-m-d|</return> définira l'année, le mois et le jour avec les
                                informations trouvées dans la chaîne analysée, mais aussi l'heure,
                                les minutes et les secondes à 0.<return>+</return>Si le spécifieur de format est
                                présent, les données restantes de la chaîne ne causeront pas une
                                erreur, mais une alerteUtilisez la méthode DateTime::getLastErrors
                                pour identifier la présence de données restantes.
                                
                                Les caractères non reconnus dans la chaîne de format entraîneront
                                l'échec de l'analyse et un message d'erreur est ajouté à la
                                structure  renvoyée. Vous pouvez interroger les messages d'erreur
                                avec  DateTimeImmutable::getLastErrors.
                                
                                Pour inclure un caractère littéral dans <strong>$format</strong>, vous devez
                                l'échapper avec un antislash (<return>\</return>).
                                
                                Si <strong>$format</strong> n'est pas composé du caractère <return>!</return> alors les valeurs de
                                temps générées qui sont absentes de <strong>$format</strong> prendront comme valeur
                                le temps système.
                                
                                Si <strong>$format</strong> contient le caractère <return>!</return>, alors les valeurs de temps
                                générées qui sont absentes de <strong>$format</strong> ainsi que les valeurs situées
                                à gauche de <return>!</return> prendront des valeurs mesurées depuis l'époque Unix.
                                
                                Le début de l'époque Unix est le 01/01/1970 à 00:00:00 UTC.
  <info>string</info>             <strong>$datetime</strong>  Chaîne représentant le moment.
  <info>DateTimeZone|null</info>  <strong>$timezone</strong>  Un objet <class>DateTimeZone</class> représentant le fuseau horaire désiré.
                                
                                Si <strong>$timezone</strong> est omis ou <info>null</info> et <strong>$datetime</strong> ne contient pas de
                                fuseau, le fuseau courant sera utilisé.
                                
                                Le paramètre <strong>$timezone</strong> et le fuseau courant sont ignorés lorsque le
                                paramètre <strong>$datetime</strong> contient un timestamp (e.g. <return>946684800</return>) ou
                                précise un fuseau (e.g. <return>2010-01-28T15:00:00+02:00</return>).

<comment>Return:</comment>
  <info>DateTimeImmutable|false</info>  Retourne un nouvel objet <class>DateTimeImmutable</class> ou <info>false</info> si une erreur
                           survient.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::__construct()</strong>
   * <strong>DateTimeImmutable::getLastErrors()</strong>
   * <strong>checkdate()</strong>
   * <strong>strptime()</strong>


id: DateTimeImmutable::createFromInterface
type: function
doc:
<comment>Description:</comment>
  Retourne un nouvel objet DateTimeImmutable encapsulant l'objet DateTimeInterface fourni

<comment>Param:</comment>
  <info>DateTimeInterface</info>  <strong>$object</strong>  L'objet <class>DateTimeInterface</class> qui doit être converti en une version
                              immutable. Cet objet n'est pas modifié, mais une nouvelle instance
                              d'objet <class>DateTimeImmutable</class> est créé contenant les même informations de
                              date, temps, et fuseau horaire.

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


id: DateTimeImmutable::createFromMutable
type: function
doc:
<comment>Description:</comment>
  Retourne une nouvelle instance de DateTimeImmutable encapsulant l'objet DateTime fournit

<comment>Param:</comment>
  <info>DateTime</info>  <strong>$object</strong>  L'objet <class>DateTime</class> mutable que vous voulez convertir en version immutable. Cet
                     objet n'est pas modifié, mais une nouvelle instance de <class>DateTimeImmutable</class> est
                     créé, contenant les mêmes informations de date, heure et de fuseau horaire.

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


id: DateTimeImmutable::getLastErrors
type: function
doc:
<comment>Description:</comment>
  Retourne les alertes et erreurs
  
  Retourne un tableau des alertes et erreur trouvés lors de l'analyse d'une chaîne date/heure.

<comment>Return:</comment>
  <info>array|false</info>  Retourne un tableau contenant les informations à propos des alertes et erreurs, ou
               <info>false</info> s'il y a ni alertes ni erreurs.


id: DateTimeImmutable::modify
type: function
doc:
<comment>Description:</comment>
  Créée un nouvel objet avec l'horodatage modifié
  
  Crée un nouvel objet <info>DateTimeImmutable</info> avec l'horodatage modifié. L'objet original ne sera pas
  modifié.

<comment>Param:</comment>
  <info>string</info>  <strong>$modifier</strong>  Une chaîne date/heure. Les formats valides sont expliqués dans la documentation
                     sur les
                     formats Date et Heure.

<comment>Return:</comment>
  <info>DateTimeImmutable|false</info>  Retourne un novel objet DateTimeImmutable modifié ou <info>false</info> si une erreur
                           survient.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>
   * <strong>DateTimeImmutable::sub()</strong>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setISODate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>
   * <strong>DateTimeImmutable::setTimestamp()</strong>


id: DateTimeImmutable::setDate
type: function
doc:
<comment>Description:</comment>
  Définit la date
  
  Retourne un nouvel objet DateTimeImmutable avec la date actuelle de l'objet DateTimeImmutable
  définit à la date donnée.

<comment>Param:</comment>
  <info></info>     <strong>$object</strong>  Style procédural uniquement : Un objet <class>DateTime</class> retourné par la fonction
                <strong>date_create()</strong>. Cette fonction modifie cet objet.
  <info>int</info>  <strong>$year</strong>    Année de la date.
  <info>int</info>  <strong>$month</strong>   Mois de la date.
  <info>int</info>  <strong>$day</strong>     Jour de la date.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retourne un nouvel objet <class>DateTimeImmutable</class> avec les données modifiées.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setISODate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>


id: DateTimeImmutable::setISODate
type: function
doc:
<comment>Description:</comment>
  Définit la date ISO
  
  Retourne un nouvel objet DateTimeImmutable avec la date défini en respectant le standard ISO 8601,
  utilisant les semaines et écarts de jour plutôt que des dates spécifiques.

<comment>Param:</comment>
  <info>int</info>  <strong>$year</strong>       Année de la date.
  <info>int</info>  <strong>$week</strong>       Semaine de la date.
  <info>int</info>  <strong>$dayOfWeek</strong>  Offset from the first day of the week.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retourne un nouvel objet <class>DateTimeImmutable</class> avec les données modifiées.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setTime()</strong>


id: DateTimeImmutable::setTime
type: function
doc:
<comment>Description:</comment>
  Définit l'horaire
  
  Retourne un nouvel objet DateTimeImmutable avec l'heure définit à l'heure fournit.

<comment>Param:</comment>
  <info>int</info>  <strong>$hour</strong>         Heure de l'horaire.
  <info>int</info>  <strong>$minute</strong>       Minutes de l'horaire.
  <info>int</info>  <strong>$second</strong>       Secondes de l'horaire.
  <info>int</info>  <strong>$microsecond</strong>  Microsecondes de l'horaire.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retourne un nouvel objet <class>DateTimeImmutable</class> avec les données modifiées.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::setDate()</strong>
   * <strong>DateTimeImmutable::setISODate()</strong>


id: DateTimeImmutable::setTimestamp
type: function
doc:
<comment>Description:</comment>
  Définit la date et l'heure basé sur un horodatage Unix
  
  Retourne un nouvel objet <info>DateTimeImmutable</info> construit à partir de l'ancien, avec la date et l'heure
  basées sur un horodatage Unix.

<comment>Param:</comment>
  <info>int</info>  <strong>$timestamp</strong>  L'horodatage Unix représentant la date. Définir l'horodatage en dehors de
                   l'intervalle d'un entier est possible en utilisant DateTimeImmutable::modify avec
                   le format <return>@</return>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retourne un nouvel objet <class>DateTimeImmutable</class> avec les données modifiées.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::getTimestamp()</strong>


id: DateTimeImmutable::setTimezone
type: function
doc:
<comment>Description:</comment>
  Définit le fuseau horaire
  
  Retourne un nouvel objet DateTimeImmutable avec un nouveau fuseau horaire défini.

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$timezone</strong>  Un objet <class>DateTimeZone</class> représentant le fuseau horaire désiré.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retourne un nouvel objet modifié <class>DateTimeImmutable</class> pour chaîner les méthodes.
                     Le point dans le temps sous-jacent n'est pas modifié lors de l'appel de cette
                     méthode.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::getTimezone()</strong>
   * <strong>DateTimeZone::__construct()</strong>


id: DateTimeImmutable::sub
type: function
doc:
<comment>Description:</comment>
  Soustrait un nombre de jours, mois, années, heures et secondes
  
  Retourne un nouvel objet <class>DateTimeImmutable</class>, avec l'objet <class>DateInterval</class> spécifié soustrait de
  l'objet DateTimeImmutable spécifié.

<comment>Param:</comment>
  <info>DateInterval</info>  <strong>$interval</strong>  Un objet <class>DateInterval</class>.

<comment>Return:</comment>
  <info>DateTimeImmutable</info>  Retourne un nouvel objet <class>DateTimeImmutable</class> avec les données modifiées.

<comment>See Also:</comment>
   * <strong>DateTimeImmutable::add()</strong>
   * <strong>DateTimeImmutable::diff()</strong>
   * <strong>DateTimeImmutable::modify()</strong>


id: DateTimeInterface
type: class
doc:
<comment>Description:</comment>
  DateTimeInterface a été créé pour que les déclarations de type de paramètre, retour, ou propriété
  peuvent accepter soit <class>DateTime</class> ou <class>DateTimeImmutable</class> comme valeur. Il n'est pas possible
  d'implémenter cette interface dans les classes utilisateurs.
  
  Les constantes communes qui permettent de formater les objets <class>DateTimeImmutable</class> ou <class>DateTime</class> via
  DateTimeImmutable::format et DateTime::format sont également définies sur cette  interface.


id: DateTimeZone::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet DateTimeZone
  
  Style orienté objet
  
  Style procédural
  
  Crée un nouvel objet <class>DateTimeZone</class>.
  
  Un objet DateTimeZone fournit l'accès à trois types différents de règles de fuseau horaires : un
  décalage UTC (type <return>1</return>), une abréviation de fuseau horaire (type <return>2</return>), et un identifiant de fuseau
  horaire tel que publié dans la base de donnée de fuseau horaire IANA (type <return>3</return>).
  
  L'objet DateTimeZone peut être attaché aux objets <class>DateTime</class> et <class>DateTimeImmutable</class> enfin d'être en
  mesure de rendre le fuseau horaire encapsulé par ces objets dans un fuseau horaire local.

<comment>Param:</comment>
  <info>string</info>  <strong>$timezone</strong>  Un des fuseaux horaires supportés, une valeur de décalage (+0200), ou une
                     abréviation de fuseau (BST).

<comment>Return:</comment>
  <info>DateTimeZone|false</info>  Retourne un objet <class>DateTimeZone</class>, en cas de succès. Style procédural retourne
                      <info>false</info> en cas d'erreur..


id: DateTimeZone::getLocation
type: function
doc:
<comment>Description:</comment>
  Retourne les informations géographiques d'un fuseau horaire
  
  Style orienté objet
  
  Style procédural
  
  Retourne les informations géographiques d'un fuseau horaire, comprenant le code du pays, la
  latitude et la longitude, et commentaires.

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>  Seulement en style procédural : un <class>DateTimeZone</class> objet retourné par
                         <strong>timezone_open()</strong>

<comment>Return:</comment>
  <info>array|false</info>  Tableau contenant les informations de localisation du fuseau horaire  ou <info>false</info> si une
               erreur survient.

<comment>See Also:</comment>
   * <strong>DateTimeZone::listIdentifiers()</strong> pour obtenir une liste
    complète ou partielle de tous les identifiants de fuseaux horaires pris en charge
   


id: DateTimeZone::getName
type: function
doc:
<comment>Description:</comment>
  Retourne le nom du fuseau horaire
  
  Style orienté objet
  
  Style procédural
  
  Retourne le nom du fuseau horaire.

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>  L'objet <class>DateTimeZone</class> utilisé pour récupérer le nom du fuseau horaire.

<comment>Return:</comment>
  <info>string</info>  Selon le type de zone, le décalage UTC (type 1), l'abréviation  de fuseau horaire (type 2)
          et les identifiants de fuseau horaire  tels que publiés dans la base de données de fuseaux
          horaires IANA  (type 3), la chaîne de description pour créer un nouvel objet  <class>DateTimeZone</class>
          avec le même décalage et/ou  les mêmes règles. Par exemple <return>02:00</return>,  <return>CEST</return> ou l'un des noms
          de fuseaux horaires  dans la liste des fuseaux horaires.


id: DateTimeZone::getOffset
type: function
doc:
<comment>Description:</comment>
  Retourne le décalage GMT d'un fuseau horaire
  
  Style orienté objet
  
  Style procédural
  
  <strong>timezone_offset_get()</strong> retourne le décalage horaire par rapport au GMT pour le paramètre <strong>$datetime</strong>.
  Le  décalage GMT est calculé à partir des informations de fuseau horaire  contenu dans l'objet
  <class>DateTime</class>.

<comment>Param:</comment>
  <info>DateTimeZone</info>       <strong>$object</strong>    Seulement en style procédural : un <class>DateTimeZone</class> objet retourné par
                                <strong>timezone_open()</strong>
  <info>DateTimeInterface</info>  <strong>$datetime</strong>  Objet <class>DateTime</class> qui contient la date dont il faut calculer le
                                décalage.

<comment>Return:</comment>
  <info>int</info>  Retourne le décalage horaire, exprimé en secondes, en cas de succès.


id: DateTimeZone::getTransitions
type: function
doc:
<comment>Description:</comment>
  Retourne toutes les transitions d'un fuseau horaire
  
  Style orienté objet
  
  Style procédural

<comment>Param:</comment>
  <info>DateTimeZone</info>  <strong>$object</strong>          Seulement en style procédural : un <class>DateTimeZone</class> objet retourné par
                                 <strong>timezone_open()</strong>
  <info>int</info>           <strong>$timestampBegin</strong>  Début du timestamp.
  <info>int</info>           <strong>$timestampEnd</strong>    Fin du timestamp.

<comment>Return:</comment>
  <info>array|false</info>  Retourne un tableau indexé numériquement des tableaux de transition en cas de succès,
               ou <info>false</info> si une erreur survient. Les objets DateTimeZone enveloppant des fuseaux de
               type 1 (décalage UTC) et type 2 (abréviations) ne contiennent pas des transitions et
               appelé cette méthode sur eux retournera <info>false</info>.
               
               Si <strong>$timestampBegin</strong> est fournit, la première entrée dans le tableau retourné
               contiendra un élément de transition au temps de <strong>$timestampBegin</strong>.
               
               Structure des tableaux de transitionCléTypeDescription<return>ts</return><info>int</info>timestamp
               Unix<return>time</return><info>string</info>Chaîne de temps <info>DateTimeInterface::ISO8601_EXPANDED</info> (PHP 8.2 et
               ultérieur), ou <info>DateTimeInterface::ISO8601</info> (PHP 8.1 et inférieur)<return>offset</return><info>int</info>Décalage
               horaire vers UTC en secondes<return>isdst</return><info>bool</info>Si l'heure d'été ext
               activée<return>abbr</return><info>string</info>Abréviation du fuseau horaire


id: DateTimeZone::listAbbreviations
type: function
doc:
<comment>Description:</comment>
  Retourne un tableau associatif, décrivant un fuseau horaire
  
  Style orienté objet
  
  Style procédural
  
  La liste des abréviations retournée contient tous les usages historiques des abréviations, ce qui
  peut amener à des entrées correctes, mais confus. Il y a aussi des conflits, car <return>PST</return> est utilisé
  tous deux dans les États-Unis et les Philippines.
  
  La liste que cette fonction retourne n'est par conséquent pas adapter pour construire un tableau
  d'option présentant un choix de fuseau horaire aux utilisateurs.
  
  Les données pour cette fonction sont pré-compilées pour des raisons de performance, et ne sont pas
  mis à jour lors de l'utilisation d'une timezonedb plus récente.

<comment>Return:</comment>
  <info>array</info>  Retourne le tableau des abréviations des fuseaux horaires.

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


id: DateTimeZone::listIdentifiers
type: function
doc:
<comment>Description:</comment>
  Retourne un tableau numérique contenant tous les identifiants de fuseaux horaires définis
  
  Style orienté objet
  
  Style procédural

<comment>Param:</comment>
  <info>int</info>          <strong>$timezoneGroup</strong>  Une (ou une combinaison) des constantes de classe <class>DateTimeZone</class>.
  <info>string|null</info>  <strong>$countryCode</strong>    Un code de pays en deux lettres (en majuscule), compatible ISO
                               3166-1.
                               
                               Cette option n'est disponible que lorsque le paramètre <strong>$timezoneGroup</strong>
                               prend la valeur de  <info>DateTimeZone::PER_COUNTRY</info>.

<comment>Return:</comment>
  <info>array</info>  Retourne le tableau des identificateurs des fuseaux horaires. Seuls les éléments non
         obsolètes sont retournés. Pour tout obtenir,  y compris les identifiants de fuseau horaire
         obsolètes, utilisez  <return>DateTimeZone::ALL_WITH_BC</return> comme valeur pour  <strong>$timezoneGroup</strong>.

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


id: DeflateContext
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>zlib.deflate</return> resources as of PHP 8.0.0.


id: Directory
type: class
doc:
<comment>Description:</comment>
  Les instances de la classe <class>Directory</class> sont créées en appelant la fonction <strong>dir()</strong>, sans utiliser
  l'opérateur new.


id: Directory::close
type: function
doc:
<comment>Description:</comment>
  Ferme le gestionnaire de dossier

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


id: Directory::read
type: function
doc:
<comment>Description:</comment>
  Lit une entrée depuis le gestionnaire de dossier

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


id: Directory::rewind
type: function
doc:
<comment>Description:</comment>
  Réinitialise le gestionnaire de dossier

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


id: DirectoryIterator
type: class
doc:
<comment>Description:</comment>
  La classe <class>DirectoryIterator</class> fournit une interface simple pour lire le contenu d'un système de
  fichiers.


id: DirectoryIterator::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel itérateur de dossier à partir d'un chemin
  
  Construit un nouvel itérateur de dossier à partir d'un chemin.

<comment>Param:</comment>
  <info>string</info>  <strong>$directory</strong>  Le chemin du dossier à parcourir.

<comment>See Also:</comment>
   * <class>SplFileInfo</class>
   * <class>Iterator</class>


id: DirectoryIterator::__toString
type: function
doc:
<comment>Description:</comment>
  Lit le nom du fichier
  
  Lit le nom du fichier de l'élément <class>DirectoryIterator</class> courant.

<comment>Return:</comment>
  <info>string</info>  Retourne le nom du fichier courant de l'élément <class>DirectoryIterator</class>.

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * la méthode magique __toString


id: DirectoryIterator::current
type: function
doc:
<comment>Description:</comment>
  Retourne l'élément courant du DirectoryIterator
  
  Retourne l'élément courant du <class>DirectoryIterator</class>

<comment>Return:</comment>
  <info>mixed</info>  Retourne l'élément courant du <class>DirectoryIterator</class>

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


id: DirectoryIterator::getBasename
type: function
doc:
<comment>Description:</comment>
  Lit le nom de dossier de l'élément DirectoryIterator
  
  Lit le nom de dossier de l'élément <class>DirectoryIterator</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$suffix</strong>  Si le nom du dossier se termine par le suffixe <strong>$suffix</strong>,  il sera retiré.

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

<comment>See Also:</comment>
   * DirectoryIterator::getFilename
   * DirectoryIterator::getPath
   * DirectoryIterator::getPathname
   * <strong>basename()</strong>
   * <strong>pathinfo()</strong>


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

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

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


id: DirectoryIterator::getFilename
type: function
doc:
<comment>Description:</comment>
  Retourne le nom de l'entrée courante du dossier
  
  Retourne le nom de l'entrée courante de l'objet <class>DirectoryIterator</class>.

<comment>Return:</comment>
  <info>string</info>  Retourne le nom du fichier courant dans l'itérateur <class>DirectoryIterator</class>.

<comment>See Also:</comment>
   * DirectoryIterator::getBasename
   * DirectoryIterator::getPath
   * DirectoryIterator::getPathname
   * <strong>pathinfo()</strong>


id: DirectoryIterator::isDot
type: function
doc:
<comment>Description:</comment>
  Retourne true si l'entrée courante est '.' ou '..'
  
  Vérifie si l'élément courant est un dossier et, est soit <return>.</return>, soit <return>..</return>

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si l'entrée est <return>.</return> ou <return>..</return>, <info>false</info> sinon.

<comment>See Also:</comment>
   * DirectoryIterator::getType
   * DirectoryIterator::isDir
   * DirectoryIterator::isFile
   * DirectoryIterator::isLink


id: DirectoryIterator::key
type: function
doc:
<comment>Description:</comment>
  Retourne l'entrée courante du dossier
  
  Retourne l'entrée courante de l'objet <class>DirectoryIterator</class>.

<comment>Return:</comment>
  <info>mixed</info>  La clé pour l'entrée courante de <class>DirectoryIterator</class> en tant qu'entier.

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


id: DirectoryIterator::next
type: function
doc:
<comment>Description:</comment>
  Se déplace vers la prochaine entrée
  
  Se déplace vers le prochain élément de l'objet <class>DirectoryIterator</class>.

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

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


id: DirectoryIterator::rewind
type: function
doc:
<comment>Description:</comment>
  Revient au début du dossier
  
  Revient au début de l'objet <class>DirectoryIterator</class>.

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

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


id: DirectoryIterator::seek
type: function
doc:
<comment>Description:</comment>
  Déplace le pointeur dans un itérateur DirectoryIterator
  
  Déplace le pointeur dans un itérateur <class>DirectoryIterator</class>.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  La position à atteindre (les positions commencent à zéro).

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

<comment>See Also:</comment>
   * DirectoryIterator::rewind
   * DirectoryIterator::next
   * SeekableIterator::seek


id: DirectoryIterator::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si le répertoire contient encore des entrées
  
  Vérifie si l'objet <class>DirectoryIterator</class> contient encore des fichiers.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la position est valide, et <info>false</info> sinon;

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


id: DocResult::__construct
type: function
doc:
<comment>Description:</comment>
  DocResult constructor
  
  Fetch document results and warnings,  and is instantiated by CollectionFind.


id: DocResult::fetchAll
type: function
doc:
<comment>Description:</comment>
  Get all rows
  
  Fetch all results from a result set.

<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: DocResult::fetchOne
type: function
doc:
<comment>Description:</comment>
  Get one row
  
  Fetch one result from a result set.

<comment>Return:</comment>
  <info>array</info>  The result, as an associative array  or <info>null</info> if no results are present.


id: DocResult::getWarnings
type: function
doc:
<comment>Description:</comment>
  Get warnings from last operation
  
  Fetches warnings generated by MySQL server's last operation.

<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: DocResult::getWarningsCount
type: function
doc:
<comment>Description:</comment>
  Get warning count from last operation
  
  Returns the number of warnings raised by the last operation. Specifically,  these warnings are
  raised by the MySQL server.

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


id: Ds\Collection
type: class
doc:
<comment>Description:</comment>
  <class>Collection</class> is the base interface which covers functionality common to all the data structures in
  this library. It guarantees that all structures are traversable, countable, and can be converted
  to json using <strong>json_encode()</strong>.


id: Ds\Collection::clear
type: function
doc:
<comment>Description:</comment>
  Supprimer toutes les valeurs
  
  Supprimer toutes les valeurs de la collection.

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


id: Ds\Collection::copy
type: function
doc:
<comment>Description:</comment>
  Retourne une copie superficielle de la collection
  
  Retourne une copie superficielle de la collection.

<comment>Return:</comment>
  <info>Ds\Collection</info>  Retourne une copie superficielle de la collection.


id: Ds\Collection::isEmpty
type: function
doc:
<comment>Description:</comment>
  Indique si la collection est vide
  
  Indique si la collection est vide.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la collection est vide, <info>false</info> dans le cas contraire.


id: Ds\Collection::toArray
type: function
doc:
<comment>Description:</comment>
  Convertit la collection en un tableau
    
  
  Convertit la collection en un tableau.
  
  Le casting vers un tableau n'est pas encore supporté.

<comment>Return:</comment>
  <info>array</info>  Un tableau contenant toutes les valeurs dans le même ordre que la collection.


id: Ds\Deque
type: class
doc:
<comment>Description:</comment>
  A Deque (pronounced “deck”) is a sequence of values in a contiguous buffer that grows and shrinks
  automatically. The name is a common abbreviation of “double-ended queue” and is used internally by
  <class>Ds\Queue</class>.
  
  Two pointers are used to keep track of a head and a tail. The pointers can “wrap around” the end
  of the buffer, which avoids the need to move other values around to make room. This makes shift
  and unshift very fast —  something a <class>Ds\Vector</class> can’t compete with.
  
  Accessing a value by index requires a translation between the index and its corresponding position
  in the buffer: ((head + position) % capacity).


id: Ds\Deque::__construct
type: function
doc:
<comment>Description:</comment>
  Creates a new instance
  
  Creates a new instance, using either a <class>traversable</class> object or an tableau for the initial <strong>$values</strong>.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A traversable object or an tableau to use for the initial values.


id: Ds\Deque::allocate
type: function
doc:
<comment>Description:</comment>
  Allocates enough memory for a required capacity
  
  Ensures that enough memory is allocated for a required capacity. This removes the need to
  reallocate the internal as values are added.

<comment>Param:</comment>
  <info>int</info>  <strong>$capacity</strong>  The number of values for which capacity should be allocated.
                  
                  Capacity will stay the same if this value is less than or equal to the current
                  capacity.
                  
                  Capacity will always be rounded up to the nearest power of 2.

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


id: Ds\Deque::apply
type: function
doc:
<comment>Description:</comment>
  Updates all values by applying a callback function to each value
  
  Updates all values by applying a <strong>$callback</strong> function to each value in the deque.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the deque.
                       
                       The callback should return what the value should be replaced by.

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


id: Ds\Deque::capacity
type: function
doc:
<comment>Description:</comment>
  Returns the current capacity
  
  Returns the current capacity.

<comment>Return:</comment>
  <info>int</info>  The current capacity.


id: Ds\Deque::clear
type: function
doc:
<comment>Description:</comment>
  Removes all values from the deque
  
  Removes all values from the deque.

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


id: Ds\Deque::contains
type: function
doc:
<comment>Description:</comment>
  Determines if the deque contains given values
  
  Determines if the deque contains all values.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  Values to check.

<comment>Return:</comment>
  <info>bool</info>  <info>false</info> if any of the provided <strong>$values</strong> are not in the deque, <info>true</info> otherwise.


id: Ds\Deque::copy
type: function
doc:
<comment>Description:</comment>
  Returns a shallow copy of the deque
  
  Returns a shallow copy of the deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A shallow copy of the deque.


id: Ds\Deque::count
type: function
doc:
<comment>Description:</comment>
  Returns the number of values in the collection
  
  See <strong>Countable::count()</strong>


id: Ds\Deque::filter
type: function
doc:
<comment>Description:</comment>
  Creates a new deque using a callable to
      determine which values to include
   
  
  Creates a new deque using a <info>callable</info> to determine which values to include.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>bool</info>callback<info>mixed</info><strong>$value</strong>
                       
                       Optional <info>callable</info> which returns <info>true</info> if the value should be included, <info>false</info>
                       otherwise.
                       
                       If a callback is not provided, only values which are <info>true</info> (see converting to
                       boolean) will be included.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A new deque containing all the values for which either the <strong>$callback</strong> returned <info>true</info>, or
            all values that convert to <info>true</info> if a <strong>$callback</strong> was not provided.


id: Ds\Deque::find
type: function
doc:
<comment>Description:</comment>
  Attempts to find a value's index
    
  
  Returns the index of the <strong>$value</strong>, or <info>false</info> if not found.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  The value to find.

<comment>Return:</comment>
  <info>mixed</info>  The index of the value, or <info>false</info> if not found.
         
         Values will be compared by value and by type.


id: Ds\Deque::first
type: function
doc:
<comment>Description:</comment>
  Returns the first value in the deque
  
  Returns the first value in the deque.

<comment>Return:</comment>
  <info>mixed</info>  The first value in the deque.


id: Ds\Deque::get
type: function
doc:
<comment>Description:</comment>
  Returns the value at a given index
  
  Returns the value at a given index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index to access, starting at 0.

<comment>Return:</comment>
  <info>mixed</info>  The value at the requested index.


id: Ds\Deque::insert
type: function
doc:
<comment>Description:</comment>
  Inserts values at a given index
  
  Inserts values into the deque at a given index.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>   The index at which to insert. 0 \<= index \<= count
                  
                  You can insert at the index equal to the number of values.
  <info>mixed</info>  <strong>$values</strong>  The value or values to insert.

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


id: Ds\Deque::isEmpty
type: function
doc:
<comment>Description:</comment>
  Returns whether the deque is empty
  
  Returns whether the deque is empty.

<comment>Return:</comment>
  <info>bool</info>  Returns <info>true</info> if the deque is empty, <info>false</info> otherwise.


id: Ds\Deque::join
type: function
doc:
<comment>Description:</comment>
  Joins all values together as a string
  
  Joins all values together as a string using an optional separator between each value.

<comment>Param:</comment>
  <info>string</info>  <strong>$glue</strong>  An optional string to separate each value.

<comment>Return:</comment>
  <info>string</info>  All values of the deque joined together as a string.


id: Ds\Deque::jsonSerialize
type: function
doc:
<comment>Description:</comment>
  Returns a representation that can be converted to JSON
  
  See <strong>JsonSerializable::jsonSerialize()</strong>
  
  You should never need to call this directly.


id: Ds\Deque::last
type: function
doc:
<comment>Description:</comment>
  Returns the last value
  
  Returns the last value in the deque.

<comment>Return:</comment>
  <info>mixed</info>  The last value in the deque.


id: Ds\Deque::map
type: function
doc:
<comment>Description:</comment>
  Returns the result of applying a callback to each value
  
  Returns the result of applying a <strong>$callback</strong> function to each value in the deque.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  <info>mixed</info>callback<info>mixed</info><strong>$value</strong>
                       
                       A <info>callable</info> to apply to each value in the deque.
                       
                       The callable should return what the new value will be in the new deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  The result of applying a <strong>$callback</strong> to each value in the deque.
            
            The values of the current instance won't be affected.


id: Ds\Deque::merge
type: function
doc:
<comment>Description:</comment>
  Returns the result of adding all given values to the deque
  
  Returns the result of adding all given values to the deque.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  A <class>traversable</class> object or an tableau.

<comment>Return:</comment>
  <info>Ds\Deque</info>  The result of adding all given values to the deque, effectively the same as adding the
            values to a copy, then returning that copy.
            
            The current instance won't be affected.


id: Ds\Deque::pop
type: function
doc:
<comment>Description:</comment>
  Removes and returns the last value
  
  Removes and returns the last value.

<comment>Return:</comment>
  <info>mixed</info>  The removed last value.


id: Ds\Deque::push
type: function
doc:
<comment>Description:</comment>
  Adds values to the end of the deque
  
  Adds values to the end of the deque.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to add.

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


id: Ds\Deque::reduce
type: function
doc:
<comment>Description:</comment>
  Reduces the deque to a single value using a callback function
  
  Reduces the deque to a single value using a callback function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$callback</strong>  The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
                       
                       The value of the current iteration.
  <info>mixed</info>     <strong>$carry</strong>     The return value of the previous callback, or <strong>$initial</strong> if it's the first
                       iteration.
  <info>mixed</info>     <strong>$value</strong>     The value of the current iteration.
  <info>mixed</info>     <strong>$initial</strong>   The initial value of the carry value. Can be <info>null</info>.

<comment>Return:</comment>
  <info>mixed</info>  The return value of the final callback.


id: Ds\Deque::remove
type: function
doc:
<comment>Description:</comment>
  Removes and returns a value by index
  
  Removes and returns a value by index.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>  The index of the value to remove.

<comment>Return:</comment>
  <info>mixed</info>  The value that was removed.


id: Ds\Deque::reverse
type: function
doc:
<comment>Description:</comment>
  Reverses the deque in-place
    
  
  Reverses the deque in-place.

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


id: Ds\Deque::reversed
type: function
doc:
<comment>Description:</comment>
  Returns a reversed copy
  
  Returns a reversed copy of the deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A reversed copy of the deque.
              The current instance is not affected. 
            
            The current instance is not affected.


id: Ds\Deque::rotate
type: function
doc:
<comment>Description:</comment>
  Rotates the deque by a given number of rotations
  
  Rotates the deque by a given number of rotations, which is equivalent to successively calling
  $deque-&gt;push($deque-&gt;shift()) if the number of rotations is positive, or
  $deque-&gt;unshift($deque-&gt;pop()) if negative.

<comment>Param:</comment>
  <info>int</info>  <strong>$rotations</strong>  The number of times the deque should be rotated.

<comment>Return:</comment>
  <info>void</info>  Aucune valeur n'est retournée.. The deque of the current instance will be rotated.


id: Ds\Deque::set
type: function
doc:
<comment>Description:</comment>
  Updates a value at a given index
  
  Updates a value at a given index.

<comment>Param:</comment>
  <info>int</info>    <strong>$index</strong>  The index of the value to update.
  <info>mixed</info>  <strong>$value</strong>  The new value.

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


id: Ds\Deque::shift
type: function
doc:
<comment>Description:</comment>
  Removes and returns the first value
  
  Removes and returns the first value.

<comment>Return:</comment>
  <info>mixed</info>  The first value, which was removed.


id: Ds\Deque::slice
type: function
doc:
<comment>Description:</comment>
  Returns a sub-deque of a given range
    
  
  Creates a sub-deque of a given range.

<comment>Param:</comment>
  <info>int</info>  <strong>$index</strong>   The index at which the sub-deque starts.
                
                If positive, the deque will start at that index in the deque. If negative, the deque
                will start that far from the end.
  <info>int</info>  <strong>$length</strong>  If a length is given and is positive, the resulting deque will have up to that many
                values in it.
                 If the length results in an overflow, only values up to the end of the deque will
                be included.
                 If a length is given and is negative, the deque will stop that many values from the
                end.
                 If a length is not provided, the resulting deque will contain all values between
                the index and the end of the deque.

<comment>Return:</comment>
  <info>Ds\Deque</info>  A sub-deque of the given range.


id: Ds\Deque::sort
type: function
doc:
<comment>Description:</comment>
  Sorts the deque in-place
   
  
  Sorts the deque in-place, using an optional <strong>$comparator</strong> function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</strong>  La fonction de comparaison doit retourner un entier inférieur à, égal à, ou
                         supérieur
                         à 0 si le premier argument est considéré comme, respectivement, inférieur
                         à, égal à, ou supérieur au second.
                         
                         Retourner des valeurs non-entières à partir de la fonction
                         de comparaison, telles que <info>float</info>, entraînera une conversion interne
                         de la valeur de retour du rappel en <info>int</info>. Ainsi, des valeurs telles que
                         <return>0.99</return> et <return>0.1</return> seront toutes deux converties en une
                         valeur entière de <return>0</return>, ce qui comparera de telles valeurs comme égales.

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


id: Ds\Deque::sorted
type: function
doc:
<comment>Description:</comment>
  Returns a sorted copy
  
  Returns a sorted copy, using an optional <strong>$comparator</strong> function.

<comment>Param:</comment>
  <info>callable</info>  <strong>$comparator</strong>  La fonction de comparaison doit retourner un entier inférieur à, égal à, ou
                         supérieur
                         à 0 si le premier argument est considéré comme, respectivement, inférieur
                         à, égal à, ou supérieur au second.
                         
                         Retourner des valeurs non-entières à partir de la fonction
                         de comparaison, telles que <info>float</info>, entraînera une conversion interne
                         de la valeur de retour du rappel en <info>int</info>. Ainsi, des valeurs telles que
                         <return>0.99</return> et <return>0.1</return> seront toutes deux converties en une
                         valeur entière de <return>0</return>, ce qui comparera de telles valeurs comme égales.

<comment>Return:</comment>
  <info>Ds\Deque</info>  Returns a sorted copy of the deque.


id: Ds\Deque::sum
type: function
doc:
<comment>Description:</comment>
  Returns the sum of all values in the deque
  
  Returns the sum of all values in the deque.
  
  Arrays and objects are considered equal to zero when calculating the sum.

<comment>Return:</comment>
  <info>int|float</info>  The sum of all the values in the deque as either a <info>float</info> or <info>int</info> depending on the values
             in the deque.


id: Ds\Deque::toArray
type: function
doc:
<comment>Description:</comment>
  Converts the deque to an tableau
    
  
  Converts the deque to an tableau.
  
  Casting to an tableau is not supported yet.

<comment>Return:</comment>
  <info>array</info>  An tableau containing all the values in the same order as the deque.


id: Ds\Deque::unshift
type: function
doc:
<comment>Description:</comment>
  Adds values to the front of the deque
  
  Adds values to the front of the deque, moving all the current values forward to make room for the
  new values.

<comment>Param:</comment>
  <info>mixed</info>  <strong>$values</strong>  The values to add to the front of the deque.  Multiple values will be added in the
                  same order that they are passed.
                  
                  Multiple values will be added in the same order that they are passed.

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


