# php_manual

id: SQLSRV_SQLTYPE_VARBINARY
type: constant
doc:
<comment>Description:</comment>
  Décrit le type de données varbinary SQL Server. Cette constante fonctionne comme une fonction et
  accepte un seul paramètre indiquant le nombre d'octets. Pour plus d'informations, reportez-vous à
  Comment spécifier les types SQL.


id: SQLSRV_SQLTYPE_VARCHAR
type: constant
doc:
<comment>Description:</comment>
  Décrit le type de données varchar SQL Server. Cette constante fonctionne comme une fonction et
  accepte un seul paramètre indiquant le nombre de caractères. Pour plus d'informations,
  reportez-vous à Comment spécifier les types SQL.


id: SQLSRV_SQLTYPE_XML
type: constant
doc:
<comment>Description:</comment>
  Décrit le type de données XML SQL Server. Pour plus d'informations, reportez-vous à Comment
  spécifier les types SQL.


id: SQLSRV_TXN_READ_COMMITTED
type: constant
doc:
<comment>Description:</comment>
  Indique un niveau d'isolation de la transaction à READ COMMITTED. Cette valeur est utilisée pour
  définir le niveau de l'isolation de la transaction dans le tableau $connectionOptions passé à la
  fonction <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_READ_SERIALIZABLE
type: constant
doc:
<comment>Description:</comment>
  Indique un niveau d'isolation de la transaction à SERIALIZABLE. Cette valeur est utilisée pour
  définir le niveau de l'isolation de la transaction dans le tableau $connectionOptions passé à la
  fonction <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_READ_UNCOMMITTED
type: constant
doc:
<comment>Description:</comment>
  Indique un niveau d'isolation de la transaction à READ UNCOMMITTED. Cette valeur est utilisée pour
  définir le niveau de l'isolation de la transaction dans le tableau $connectionOptions passé à la
  fonction <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_REPEATABLE_READ
type: constant
doc:
<comment>Description:</comment>
  Indique un niveau d'isolation de la transaction à REPEATABLE READ. Cette valeur est utilisée pour
  définir le niveau de l'isolation de la transaction dans le tableau $connectionOptions passé à la
  fonction <strong>sqlsrv_connect()</strong>.


id: SQLSRV_TXN_SNAPSHOT
type: constant
doc:
<comment>Description:</comment>
  Indique un niveau d'isolation de la transaction à SNAPSHOT. Cette valeur est utilisée pour définir
  le niveau de l'isolation de la transaction dans le tableau $connectionOptions passé à la fonction
  <strong>sqlsrv_connect()</strong>.


id: SQLT_AFC
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>oci_bind_array_by_name()</strong> pour lier les tableaux de CHAR.


id: SQLT_AVC
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>oci_bind_array_by_name()</strong> pour lier les tableaux de VARCHAR2.


id: SQLT_CHR
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>oci_bind_array_by_name()</strong> pour lier les tableaux de VARCHAR2. Utilisé également avec
  <strong>oci_bind_by_name()</strong>.


id: SQLT_FLT
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>oci_bind_array_by_name()</strong> pour lier les tableaux de FLOAT.


id: SQLT_LBI
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>oci_bind_by_name()</strong> pour lier les valeurs LONG RAW.


id: SQLT_LNG
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>oci_bind_by_name()</strong> pour lier les valeurs LONG.


id: SQLT_LVC
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>oci_bind_array_by_name()</strong> pour lier les tableaux de LONG VARCHAR.


id: SQLT_ODT
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>oci_bind_array_by_name()</strong> pour lier les tableaux de LONG.


id: SQLT_STR
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>oci_bind_array_by_name()</strong> pour lier les tableaux de STRING.


id: SQLT_VCS
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>oci_bind_array_by_name()</strong> pour lier les tableaux de VARCHAR.


id: SQLite3::__construct
type: function
doc:
<comment>Description:</comment>
  Instantie un objet SQLite3 et ouvre la base de données SQLite 3
    
  
  Initialise un objet SQLite3 et ouvre une connexion à la base de données SQLite 3. Si le
  chiffrement a été inclus durant la compilation, alors cette fonction tentera d'utiliser la clé
  correspondante.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>       Chemin vers la base de données SQLite, ou <return>:memory:</return> pour utiliser la base
                          de données se trouvant en mémoire vive. Si <strong>$filename</strong> est une chaîne vide,
                          une base de  données temporaire privée sera créée sur le disque. Cette
                          base de données  privée sera automatiquement supprimée dès que la
                          connexion de la base de  données est fermée.
  <info>int</info>     <strong>$flags</strong>          Drapeaux optionnels utilisés pour déterminir la manière d'ouverture de la
                          base de données SQLite. Par défaut, l'ouverture s'effectue en utilisant
                          <return>SQLITE3_OPEN_READWRITE | SQLITE3_OPEN_CREATE</return>. <return>SQLITE3_OPEN_READONLY</return> :
                          Ouvre la base de données en lecture seule. <return>SQLITE3_OPEN_READWRITE</return> : Ouvre
                          la base de données en lecture et en écriture. <return>SQLITE3_OPEN_CREATE</return> : Crée
                          la base de données si elle n'existe pas.
                          
                          <return>SQLITE3_OPEN_READONLY</return> : Ouvre la base de données en lecture seule.
                          
                          <return>SQLITE3_OPEN_READWRITE</return> : Ouvre la base de données en lecture et en
                          écriture.
                          
                          <return>SQLITE3_OPEN_CREATE</return> : Crée la base de données si elle n'existe pas.
  <info>string</info>  <strong>$encryptionKey</strong>  Un clé de cryptage optionnel, à utiliser lors du cryptage/décryptage de la
                          base de données SQLite. Si le module SQLite n'est pas installé, ce
                          paramètre n'aura aucun effet.


id: SQLite3::backup
type: function
doc:
<comment>Description:</comment>
  Backup one database to another database
  
  SQLite3::backup copies the contents of one database into another, overwriting the contents of the
  destination database. It is useful either for creating backups of databases or for copying
  in-memory databases to or from persistent files.
  
  As of SQLite 3.27.0 (2019-02-07), it is also possible to use the statement <return>VACUUM INTO 'file.db';</return>
  to backup the database to a new file.

<comment>Param:</comment>
  <info>SQLite3</info>  <strong>$destination</strong>          A database connection opened with SQLite3::open.
  <info>string</info>   <strong>$sourceDatabase</strong>       The database name is <return>"main"</return> for the main database, <return>"temp"</return> for the
                                 temporary database, or the name specified after the <return>AS</return> keyword in
                                 an <return>ATTACH</return> statement for an attached database.
  <info>string</info>   <strong>$destinationDatabase</strong>  Analogous to <strong>$sourceDatabase</strong> but for the <strong>$destination</strong>.

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


id: SQLite3::busyTimeout
type: function
doc:
<comment>Description:</comment>
  Définit le gestionnaire d'attente de la connexion
  
  Définit le gestionnaire d'attente qui patientera tant que la base de données n'est pas verrouillée
  ou que le délai d'attente ne soit atteint.

<comment>Param:</comment>
  <info>int</info>  <strong>$milliseconds</strong>  Les millisecondes à attendre. Le fait de définir cette valeur à une valeur
                      inférieure ou égale à zéro désactivera un gestionnaire d'attente précédemment
                      défini.

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


id: SQLite3::changes
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de lignes modifiées (ou insérées, effacées) par la
     dernière requête SQL
    
  
  Retourne le nombre de lignes modifiées (ou insérées, effacées) par la dernière requête SQL.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier correspondant au nombre de lignes modifiées (ou insérées, effacées) par la
       dernière requête SQL.


id: SQLite3::close
type: function
doc:
<comment>Description:</comment>
  Ferme la connexion avec la base de données
  
  Ferme la connexion avec la base de donné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: SQLite3::createAggregate
type: function
doc:
<comment>Description:</comment>
  Enregistre une fonction PHP à utiliser comme fonction d'aggrégation SQLite
  
  Enregistre une fonction PHP ou une fonction définie par l'utilisateur à utiliser comme fonction
  d'agrégation SQL, qui sera utilisée dans les requêtes SQL.

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>           Nom de la fonction d'agrégation SQL à créer ou à redéfinir.
  <info>callable</info>  <strong>$stepCallback</strong>   Fonction de rappel appelée pour chaque ligne dans le jeu de résultats.
                            Votre fonction PHP devrait accumuler le résultat et stocker son contexte
                            d'agrégation.
                            
                            Cette fonction doit être définie comme :
                            <info>mixed</info>step<info>mixed</info><strong>$context</strong><info>int</info><strong>$rownumber</strong><info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong> <strong>$context</strong><info>null</info>
                            pour la première ligne ; sur les lignes suivantes ceci aura la valeur
                            qui a été précedement retourné par la fonction step ; vous devriez
                            utiliser ceci pour maintenir l'état d'aggregation. <strong>$rownumber</strong> Le numéro
                            de ligne courante. <strong>$value</strong> Le premier argument à passer à l'agrégateur.
                            <strong>$values</strong> Arguments supplémentaires à passer à l'agrégateur.  La valeur
                            retournée de cette fonction sera utilisée comme argument <strong>$context</strong> lors
                            du prochain appel d'une fonction d'étape ou finale.
                            
                            <info>null</info> pour la première ligne ; sur les lignes suivantes ceci aura la
                            valeur qui a été précedement retourné par la fonction step ; vous
                            devriez utiliser ceci pour maintenir l'état d'aggregation.
                            
                            Le numéro de ligne courante.
                            
                            Le premier argument à passer à l'agrégateur.
                            
                            Arguments supplémentaires à passer à l'agrégateur.
  <info>mixed</info>     <strong>$context</strong>        <info>null</info> pour la première ligne ; sur les lignes suivantes ceci aura la
                            valeur qui a été précedement retourné par la fonction step ; vous
                            devriez utiliser ceci pour maintenir l'état d'aggregation.
  <info>int</info>       <strong>$rownumber</strong>      Le numéro de ligne courante.
  <info>mixed</info>     <strong>$value</strong>          Le premier argument à passer à l'agrégateur.
  <info>mixed</info>     <strong>$values</strong>         Arguments supplémentaires à passer à l'agrégateur.
  <info>callable</info>  <strong>$finalCallback</strong>  Fonction de rappel pour agréger les "étapes" de données de chaque ligne.
                            Une fois que toutes les lignes ont été traitées, la fonction sera
                            appelée, prendra les données du contexte d'agrégation et retournera le
                            résultat. La fonction de rappel doit retourner un type compris par
                            SQLite (i.e. un type scalaire).
                            
                            Cette fonction doit être définie comme :
                            <info>mixed</info>fini<info>mixed</info><strong>$context</strong><info>int</info><strong>$rownumber</strong> <strong>$context</strong> Contient la valeur de
                            retour du tout dernier appel à la fonction step. <strong>$rownumber</strong> Toujours <return>0</return>.
                            La valeur de retour de cette fonction sera utilisée comme valeur de
                            retour pour l'agrégation.
                            
                            Contient la valeur de retour du tout dernier appel à la fonction step.
                            
                            Toujours <return>0</return>.
  <info>mixed</info>     <strong>$context</strong>        Contient la valeur de retour du tout dernier appel à la fonction step.
  <info>int</info>       <strong>$rownumber</strong>      Toujours <return>0</return>.
  <info>int</info>       <strong>$argCount</strong>       Le nombre d'arguments pris par la fonction d'agrégation SQL. Si ce
                            nombre est négatif, alors la fonction d'agrégation SQL pourra prendre un
                            nombre non défini d'arguments.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la création de l'agrégat a réussie,  ou <info>false</info> si une erreur survient.


id: SQLite3::createCollation
type: function
doc:
<comment>Description:</comment>
  Enregistre une fonction PHP pour l'utiliser comme fonction de classement SQL
  
  Enregistre une fonction PHP ou une fonction définie par l'utilisateur pour l'utiliser comme
  fonction de classement dans une requête SQL.

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>      Nom de la fonction de classement SQL à créer ou à re-définir.
  <info>callable</info>  <strong>$callback</strong>  Le nom d'une fonction PHP ou d'une fonction définie par l'utilisateur à
                       appliquer comme fonction de rappel, définissant le comportement du
                       classement. Elle doit accepter deux arguments et retournera la même chose que
                       la fonction <strong>strcmp()</strong>, c'est à dire elle doit retourner -1, 1, ou 0 si la
                       première chaîne trie avant, après, ou est équivalent à la seconde.
                       
                       Cette fonction doit être définit comme : <info>int</info>collation<info>mixed</info><strong>$value1</strong><info>mixed</info><strong>$value2</strong>

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

<comment>See Also:</comment>
   * La documentation sur le classement SQLite : http://sqlite.org/datatype3.html#collation


id: SQLite3::createFunction
type: function
doc:
<comment>Description:</comment>
  Enregistre une fonction PHP à utiliser comme fonction scalaire SQL
  
  Enregistre une fonction PHP ou une fonction utilisateur à utiliser comme fonction scalaire SQL,
  pour utilisation dans les requête SQL.

<comment>Param:</comment>
  <info>string</info>    <strong>$name</strong>      Nom de la fonction SQL à créer ou à redéfinir.
  <info>callable</info>  <strong>$callback</strong>  Le nom de la fonction PHP ou la fonction utilisateur à appliquer comme
                       callback, définissant le comportement de la fonction SQL.
                       
                       Cette fonction doit être définit comme : <info>mixed</info>callback<info>mixed</info><strong>$value</strong><info>mixed</info><strong>$values</strong>
                       <strong>$value</strong> Le premier argument à passer à la fonction SQL. <strong>$values</strong> Arguments
                       supplémentaires à passer à la fonction SQL.
                       
                       Le premier argument à passer à la fonction SQL.
                       
                       Arguments supplémentaires à passer à la fonction SQL.
  <info>mixed</info>     <strong>$value</strong>     Le premier argument à passer à la fonction SQL.
  <info>mixed</info>     <strong>$values</strong>    Arguments supplémentaires à passer à la fonction SQL.
  <info>int</info>       <strong>$argCount</strong>  Nombre d'arguments que la fonction SQL prend. Si ce paramètre est  <return>-1</return>, la
                       fonction SQL peut prendre n'importe quel nombre  d'arguments.
  <info>int</info>       <strong>$flags</strong>     Une conjonction d'opérations de bits d'indicateurs. Actuellement, seul
                       <info>SQLITE3_DETERMINISTIC</info> est pris en charge, ce qui  spécifie que la fonction
                       retourne toujours le même résultat étant donné  les mêmes entrées dans une
                       seule instruction SQL.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la fonction a été créée avec succès, <info>false</info> si une erreur survient.


id: SQLite3::enableExceptions
type: function
doc:
<comment>Description:</comment>
  Active le lancement d'exceptions
    
  
  Contrôle si l'instance <class>SQLite3</class> lancera des exceptions ou des avertissements lors d'une erreur.

<comment>Param:</comment>
  <info>bool</info>  <strong>$enable</strong>  Si <info>true</info>, l'instance <class>SQLite3</class>, et les instances dérivées de <class>SQLite3Stmt</class> et
                 <class>SQLite3Result</class>, lanceront des exceptions en cas d'erreurs.
                 
                 Si <info>false</info>, l'instance <class>SQLite3</class>, et les instances dérivées de <class>SQLite3Stmt</class> et
                 <class>SQLite3Result</class>, lanceront des avertissements en cas d'erreurs.
                 
                 Pour chacun des modes, le code et message d'erreur, s'il y a, seront disponible
                 grâce à SQLite3::lastErrorCode et SQLite3::lastErrorMsg respectivement.

<comment>Return:</comment>
  <info>bool</info>  Retourne l'ancienne valeur ; <info>true</info> si les exceptions étaient activées, <info>false</info> sinon.


id: SQLite3::escapeString
type: function
doc:
<comment>Description:</comment>
  Retourne une chaîne nettoyée
  
  Retourne une chaîne qui a été nettoyée afin de l'inclure sans risque dans les requêtes SQL.
  
  Cette fonction n'est pas capable de gérer les chaînes binaires !
  
  Pour correctement gérer les champs BLOB qui contiennent des caractères NUL, utilisez plutôt la
  fonction <strong>SQLite3Stmt::bindParam()</strong>.

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

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne nettoyée, qui pourra être utilisée sans risque dans une requête SQL.


id: SQLite3::exec
type: function
doc:
<comment>Description:</comment>
  Exécute une requête sur une base de données
  
  Exécute une requête sur une base de données.
  
  SQLite3 doit parfois créer des fichiers temporaires lors de l'exécution des requêtes, donc les
  dossiers respectifs doivent être écrivable.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  La requête SQL à exécuter (typiquement, une requête de type INSERT, UPDATE ou
                  DELETE).

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la requête a été exécutée avec succès, <info>false</info> si une erreur survient.


id: SQLite3::lastErrorCode
type: function
doc:
<comment>Description:</comment>
  Retourne le code erreur de la dernière requête SQL ayant échouée
    
  
  Retourne le code erreur de la dernière requête SQL ayant échouée.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier représentant le code erreur de la dernière requête ayant échouée.


id: SQLite3::lastErrorMsg
type: function
doc:
<comment>Description:</comment>
  Retourne le message d'erreur, en anglais, de la dernière requête ayant échouée
    
  
  Retourne le message d'erreur, en anglais, de la dernière requête ayant échoué.

<comment>Return:</comment>
  <info>string</info>  Retourne le message d'erreur, en anglais, de la dernière requête ayant échoué.


id: SQLite3::lastInsertRowID
type: function
doc:
<comment>Description:</comment>
  Retourne l'identifiant de la ligne correspondant à la dernière requête
    de type INSERT
  
  Retourne l'identifiant de la ligne correspondant à la dernière requête de type INSERT effectuée
  sur la base de données.

<comment>Return:</comment>
  <info>int</info>  Retourne l'identifiant de la ligne correspondant à la dernière requête de type INSERT
       effectuée sur la base de données. Si aucune requête de type INSERT dans les tables rowid n'a
       réussi sur cette connexion de base de données, alors SQLite3::lastInsertRowID retourne <return>0</return>.


id: SQLite3::loadExtension
type: function
doc:
<comment>Description:</comment>
  Tente de charger une extension de la bibliothèque SQLite
  
  Tente de charger une extension de la bibliothèque SQLite.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Le nom de l'extension à charger. L'extension doit se trouver dans le dossier
                 spécifié par l'option de configuration sqlite3.extension_dir.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si l'extension a été chargée avec succès, <info>false</info> si une erreur survient.


id: SQLite3::open
type: function
doc:
<comment>Description:</comment>
  Ouvre une base de données SQLite
  
  Ouvre une base de données SQLite 3. Si le cryptage a été inclus lors de la construction de la base
  de données, la clé correspondante sera utilisée.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>       Chemin vers la base de données SQLite, ou <return>:memory:</return> pour utiliser la base
                          de données se trouvant en mémoire vive.
  <info>int</info>     <strong>$flags</strong>          Drapeaux optionnels à utiliser pour déterminer la manière d'ouverture de
                          la base de données SQLite. Par défaut, ce sera <return>SQLITE3_OPEN_READWRITE |
                          SQLITE3_OPEN_CREATE</return>. <return>SQLITE3_OPEN_READONLY</return> : Ouvre la base de données en
                          lecture seule. <return>SQLITE3_OPEN_READWRITE</return> : Ouvre la base de données en
                          lecture et écriture. <return>SQLITE3_OPEN_CREATE</return> : Crée la base de données si elle
                          n'existe pas.
                          
                          <return>SQLITE3_OPEN_READONLY</return> : Ouvre la base de données en lecture seule.
                          
                          <return>SQLITE3_OPEN_READWRITE</return> : Ouvre la base de données en lecture et écriture.
                          
                          <return>SQLITE3_OPEN_CREATE</return> : Crée la base de données si elle n'existe pas.
  <info>string</info>  <strong>$encryptionKey</strong>  La clé optionnelle de cryptage utilisée lors du cryptage/décryptage de la
                          base de données SQLite. Si le module SQLite de cryptage n'est pas
                          installé, ce paramètre n'aura aucun effet.

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


id: SQLite3::openBlob
type: function
doc:
<comment>Description:</comment>
  Ouvre un flux de ressource pour lire un BLOB
  
  Ouvre un flux de ressource pour lire ou écrire un BLOB, qui serait sélectionné par :
  
  SELECT <strong>$column</strong> FROM <strong>$database</strong>.<strong>$table</strong> WHERE rowid = <strong>$rowid</strong>
  
  Il n'est pas possible de changer la taille d'un BLOB en écrivant vers le flux. À la place, une
  déclaration UPDATE doit être exécuté, en utilisant, éventuellement la fonction zeroblob() de
  SQLite pour définir la taille du BLOB désiré.

<comment>Param:</comment>
  <info>string</info>  <strong>$table</strong>     Le nom de la table.
  <info>string</info>  <strong>$column</strong>    Le nom de la colonne.
  <info>int</info>     <strong>$rowid</strong>     La ligne ID.
  <info>string</info>  <strong>$database</strong>  Le nom symbolic de la base de données.
  <info>int</info>     <strong>$flags</strong>     Soit <info>SQLITE3_OPEN_READONLY</info> ou  <info>SQLITE3_OPEN_READWRITE</info> pour ouvrir le flux en
                     lecture seule, ou en lecture et écriture, respectivement.

<comment>Return:</comment>
  <info>resource|false</info>  Retourne une ressource de flux,  ou <info>false</info> si une erreur survient.


id: SQLite3::prepare
type: function
doc:
<comment>Description:</comment>
  Prépare une requête SQL pour exécution
  
  Prépare une requête SQL pour exécution et retourne un objet <class>SQLite3Stmt</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  La requête SQL à préparer.

<comment>Return:</comment>
  <info>SQLite3Stmt|false</info>  Retourne un objet <class>SQLite3Stmt</class> en cas de succès ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * SQLite3Stmt::paramCount
   * SQLite3Stmt::bindValue
   * SQLite3Stmt::bindParam


id: SQLite3::query
type: function
doc:
<comment>Description:</comment>
  Exécute une requête SQL
  
  Exécute une requête SQL, et retourne un objet <class>SQLite3Result</class>. Si la requête ne génère pas de
  résultat (comme les instructions DML), l'objet  <class>SQLite3Result</class> retourné n'est pas vraiment
  utilisable.    Utilisez sqlite3:: exec pour ces requêtes à la place.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  La requête SQL à exécuter.

<comment>Return:</comment>
  <info>SQLite3Result|false</info>  Retourne un objet <class>SQLite3Result</class>,  ou <info>false</info> si une erreur survient


id: SQLite3::querySingle
type: function
doc:
<comment>Description:</comment>
  Exécute une requête et retourne un seul résultat
  
  Exécute une requête et retourne un seul résultat.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>      La requête SQL à exécuter.
  <info>bool</info>    <strong>$entireRow</strong>  Par défaut, cette fonction retourne la valeur de la première colonne retournée
                      par la requête. Si <strong>$entireRow</strong> vaut <info>true</info>, alors la fonction retournera un
                      tableau contenant toute la première ligne.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur de la première colonne du résultat, ou un tableau contenant toute la
         première ligne (si le paramètre <strong>$entireRow</strong> vaut <info>true</info>).
         
         Si la requête est valide mais ne retourne aucun résultat, <info>null</info> sera retourné si <strong>$entireRow</strong>
         est <info>false</info>, sinon un tableau vide est retourné.
         
         Les requêtes invalides retourneront <info>false</info>.


id: SQLite3::setAuthorizer
type: function
doc:
<comment>Description:</comment>
  Configures a callback to be used as an authorizer to limit what a statement can do
  
  Sets a callback that will be called by SQLite every time an action is performed (reading,
  deleting, updating, etc.). This is used when preparing a SQL statement from an untrusted source to
  ensure that the SQL statements do not try to access data they are not allowed to see, or that they
  do not try to execute malicious statements that damage the database. For example, an application
  may allow a user to enter arbitrary SQL queries for evaluation by a database. But the application
  does not want the user to be able to make arbitrary changes to the database. An authorizer could
  then be put in place while the user-entered SQL is being prepared that disallows everything except
  SELECT statements.
  
  The authorizer callback may be called multiple times for each statement prepared by SQLite. A
  <return>SELECT</return> or <return>UPDATE</return> query will call the authorizer for every column that would be read or updated.
  
  The authorizer is called with up to five parameters. The first parameter is always given, and is
  an <info>int</info> (action code) matching a constant from <return>SQLite3</return>. The other parameters are only passed for
  some actions. The following table describes the second and third parameters according to the
  action: List of action codes and parametersActionSecond parameterThird
  parameter<info>SQLite3::CREATE_INDEX</info>Index NameTable Name<info>SQLite3::CREATE_TABLE</info>Table
  Name<info>null</info><info>SQLite3::CREATE_TEMP_INDEX</info>Index NameTable Name<info>SQLite3::CREATE_TEMP_TABLE</info>Table
  Name<info>null</info><info>SQLite3::CREATE_TEMP_TRIGGER</info>Trigger NameTable Name<info>SQLite3::CREATE_TEMP_VIEW</info>View
  Name<info>null</info><info>SQLite3::CREATE_TRIGGER</info>Trigger NameTable Name<info>SQLite3::CREATE_VIEW</info>View
  Name<info>null</info><info>SQLite3::DELETE</info>Table Name<info>null</info><info>SQLite3::DROP_INDEX</info>Index NameTable
  Name<info>SQLite3::DROP_TABLE</info>Table Name<info>null</info><info>SQLite3::DROP_TEMP_INDEX</info>Index NameTable
  Name<info>SQLite3::DROP_TEMP_TABLE</info>Table Name<info>null</info><info>SQLite3::DROP_TEMP_TRIGGER</info>Trigger NameTable
  Name<info>SQLite3::DROP_TEMP_VIEW</info>View Name<info>null</info><info>SQLite3::DROP_TRIGGER</info>Trigger NameTable
  Name<info>SQLite3::DROP_VIEW</info>View Name<info>null</info><info>SQLite3::INSERT</info>Table Name<info>null</info><info>SQLite3::PRAGMA</info>Pragma NameFirst
  argument passed to the pragma, or <info>null</info><info>SQLite3::READ</info>Table NameColumn
  Name<info>SQLite3::SELECT</info><info>null</info><info>null</info><info>SQLite3::TRANSACTION</info>Operation<info>null</info><info>SQLite3::UPDATE</info>Table NameColumn
  Name<info>SQLite3::ATTACH</info>Filename<info>null</info><info>SQLite3::DETACH</info>Database Name<info>null</info><info>SQLite3::ALTER_TABLE</info>Database
  NameTable Name<info>SQLite3::REINDEX</info>Index Name<info>null</info><info>SQLite3::ANALYZE</info>Table
  Name<info>null</info><info>SQLite3::CREATE_VTABLE</info>Table NameModule Name<info>SQLite3::DROP_VTABLE</info>Table NameModule
  Name<info>SQLite3::FUNCTION</info><info>null</info>Function Name<info>SQLite3::SAVEPOINT</info>OperationSavepoint
  Name<info>SQLite3::RECURSIVE</info><info>null</info><info>null</info>
  
  The 4th parameter will be the name of the database (<return>"main"</return>, <return>"temp"</return>, etc.) if applicable.
  
  The 5th parameter to the authorizer callback is the name of the inner-most trigger or view that is
  responsible for the access attempt or <info>null</info> if this access attempt is directly from top-level SQL
  code.
  
  When the callback returns <info>SQLite3::OK</info>, that means the operation requested is accepted. When the
  callback returns <info>SQLite3::DENY</info>, the call that triggered the authorizer will fail with an error
  message explaining that access is denied.
  
  If the action code is <info>SQLite3::READ</info> and the callback returns <info>SQLite3::IGNORE</info> then the prepared
  statement is constructed to substitute a <info>null</info> value in place of the table column that would have
  been read if <info>SQLite3::OK</info> had been returned. The <info>SQLite3::IGNORE</info> return can be used to deny an
  untrusted user access to individual columns of a table.
  
  When a table is referenced by a <return>SELECT</return> but no column values are extracted from that table (for
  example in a query like <return>"SELECT count(*) FROM table"</return>) then the <info>SQLite3::READ</info> authorizer callback
  is invoked once for that table with a column name that is an empty string.
  
  If the action code is <info>SQLite3::DELETE</info> and the callback returns <info>SQLite3::IGNORE</info> then the DELETE
  operation proceeds but the truncate optimization is disabled and all rows are deleted
  individually.
  
  Only a single authorizer can be in place on a database connection at a time. Each call to
  SQLite3::setAuthorizer overrides the previous call. Disable the authorizer by installing a <info>null</info>
  callback. The authorizer is disabled by default.
  
  The authorizer callback must not do anything that will modify the database connection that invoked
  the authorizer callback.
  
  Note that the authorizer is only called when a statement is prepared, not when it's executed.
  
  More details can be found in the SQLite3 documentation.

<comment>Param:</comment>
  <info>callable|null</info>  <strong>$callback</strong>  The <info>callable</info> to be called.
                            
                            If <info>null</info> is passed instead, this will disable the current authorizer
                            callback.

<comment>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: SQLite3::version
type: function
doc:
<comment>Description:</comment>
  Retourne la version de la bibliothèque SQLite3
    
  
  Retourne la version de la bibliothèque SQLite3.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau associatif contenant les clés "versionString" et "versionNumber".


id: SQLite3Result
type: class
doc:
<comment>Description:</comment>
  Une classe qui représente les résultats d'une base de données SQLite 3.


id: SQLite3Result::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs an SQLite3Result
  
  <class>SQLite3Result</class> instances are created by SQLite3::query and SQLite3Stmt::execute.


id: SQLite3Result::columnName
type: function
doc:
<comment>Description:</comment>
  Retourne le nom d'une colonne
  
  Retourne le nom de la colonne identifiée par le paramètre <strong>$column</strong>. Il est à noter que le nom de la
  colonne de résultat et la valeur de la clause <return>AS</return> pour cette colonne, s'il y a une clause <return>AS</return>. S'il
  n'y a pas de clause alors le nom de la colonne est non-spécifié et peut changer d'une version de
  libsqlite3 à une autre.

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  Le numéro de la colonne, en commençant par 0.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le nom de la colonne identifiée par le paramètre <strong>$column</strong>, ou <info>false</info> si la
                colonne n'existe pas.


id: SQLite3Result::columnType
type: function
doc:
<comment>Description:</comment>
  Retourne le type d'une colonne
  
  Retourne le type de la colonne identifiée par le paramètre <strong>$column</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$column</strong>  Le numéro de la colonne, en commençant par 0.

<comment>Return:</comment>
  <info>int|false</info>  Retourne le type de données de la colonne identifiée par  <strong>$column</strong> (l'un de
             <info>SQLITE3_INTEGER</info>, <info>SQLITE3_FLOAT</info>, <info>SQLITE3_TEXT</info>, <info>SQLITE3_BLOB</info>, ou <info>SQLITE3_NULL</info>), ou <info>false</info>
             si la colonne n'existe pas.


id: SQLite3Result::fetchArray
type: function
doc:
<comment>Description:</comment>
  Récupère un jeu de résultats sous la forme d'un tableau associatif
    
  
  Récupère un jeu de résultats sous la forme d'un tableau associatif ou indexé numériquement, ou les
  deux. Par défaut, ce sera les deux.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Contrôle la façon dont la prochaine ligne doit être retournée à la fonction appelante.
              Cette valeur peut être <return>SQLITE3_ASSOC</return>, <return>SQLITE3_NUM</return>, ou <return>SQLITE3_BOTH</return>. <return>SQLITE3_ASSOC</return> :
              Retourne un tableau indexé par le  nom de la colonne, tel que retourné dans le jeu de
              résultats correspondant. <return>SQLITE3_NUM</return> : Retourne un tableau indexé par le numéro de la
              colonne, tel que retourné dans le jeu de résultats, en commençant par la colonne 0.
              <return>SQLITE3_BOTH</return> : Retourne un tableau indexé par le nom et le numéro de la colonne, tel
              que retourné par le jeu de résultats, en commençant par la colonne 0.
              
              <return>SQLITE3_ASSOC</return> : Retourne un tableau indexé par le  nom de la colonne, tel que retourné
              dans le jeu de résultats correspondant.
              
              <return>SQLITE3_NUM</return> : Retourne un tableau indexé par le numéro de la colonne, tel que retourné
              dans le jeu de résultats, en commençant par la colonne 0.
              
              <return>SQLITE3_BOTH</return> : Retourne un tableau indexé par le nom et le numéro de la colonne, tel
              que retourné par le jeu de résultats, en commençant par la colonne 0.

<comment>Return:</comment>
  <info>array|false</info>  Retourne une ligne du jeu de résultats, sous la forme d'un tableau associatif, ou
               sous la forme d'un tableau indexé, ou les deux. Retourne <info>false</info> s'il n'y a plus de
               lignes.
               
               Les types des valeurs du tableau retourné sont mappés à partir de types  SQLite3
               comme suit : les entiers sont mappés à <info>int</info> s'ils  s'insèrent dans la plage
               <info>PHP_INT_MIN</info>.. <info>PHP_INT_MAX</info>, et à <info>string</info> sinon. Les nombres  à virgule sont mappés à
               <info>float</info>, les valeurs <return>null</return>  sont mappées à <info>null</info>, et les chaînes et les objets BLOB sont
               mappés à <info>string</info>.


id: SQLite3Result::finalize
type: function
doc:
<comment>Description:</comment>
  Ferme un jeu de résultats
  
  Ferme un jeu de résultats.

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


id: SQLite3Result::numColumns
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de colonnes du jeu de résultats
  
  Retourne le nombre de colonnes du jeu de résultats.

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de colonnes du jeu de résultats.


id: SQLite3Result::reset
type: function
doc:
<comment>Description:</comment>
  Repositionne le pointeur sur la première ligne du jeu de résultats
  
  Repositionne le pointeur sur la première ligne du jeu de résultats.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le jeu de résultats a été réinitialisé avec succès, <info>false</info> si une erreur
        survient.


id: SQLite3Stmt
type: class
doc:
<comment>Description:</comment>
  La classe qui représente les commandes préparées  pour une base de données SQLite3.


id: SQLite3Stmt::__construct
type: function
doc:
<comment>Description:</comment>
  Constructs an SQLite3Stmt object
  
  <class>SQLite3Stmt</class> instances are created by SQLite3::prepare.

<comment>Param:</comment>
  <info>SQLite3</info>  <strong>$sqlite3</strong>  
  <info>string</info>   <strong>$query</strong>    


id: SQLite3Stmt::bindParam
type: function
doc:
<comment>Description:</comment>
  Lie un paramètre à une variable de déclaration
  
  Lie un paramètre à une variable de déclaration.
  
  Avant PHP 7.2.14 et 7.3.0, respectivement, SQLite3Stmt::reset doit être appelé après le premier
  appel à SQLite3Stmt::execute si la valeur liée  devrait être correctement mit à jour lors des
  appels suivant à  SQLite3Stmt::execute. Si SQLite3Stmt::reset n'est pas appelé, les valeurs liées
  ne seront pas modifiées, même si la valeur assigné à la variable passée à SQLite3Stmt::bindParam a
  été modifié, ou SQLite3Stmt::bindParam a été appelé une nouvelle fois.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>  Soit une chaîne de caractères (pour les paramètres nommés) ou un entier (pour
                      les paramètres positionnel) identifiant la variable de déclaration à laquelle
                      la valeur doit être liée. Si un paramètre nommé ne débute pas avec un
                      caractère "deux point" (<return>:</return>) ou un arobase (<return>@</return>), "deux point" (<return>:</return>) seront
                      automatiquement préfixé. Les paramètres positionnels commencent avec <return>1</return>.
  <info>mixed</info>       <strong>$var</strong>    Le paramètre à lier à la variable de déclaration.
  <info>int</info>         <strong>$type</strong>   Le type de données du paramètre à lier. <info>SQLITE3_INTEGER</info> : La valeur est un
                      entier signé, stocké sur 1, 2, 3, 4, 6, ou 8 octets, suivant la grandeur de la
                      valeur. <info>SQLITE3_FLOAT</info> : La valeur est un nombre à virgule flottante, stocké
                      sur 8 octets. <info>SQLITE3_TEXT</info> : La valeur est un texte, stocké en utilisant
                      l'encodage de la base de données (UTF-8, UTF-16BE ou UTF-16-LE). <info>SQLITE3_BLOB</info>
                      : La valeur est un BLOB, stocké exactement de la façon dont il a été fourni.
                      <info>SQLITE3_NULL</info> : La valeur est la valeur NULL.
                      
                      <info>SQLITE3_INTEGER</info> : La valeur est un entier signé, stocké sur 1, 2, 3, 4, 6, ou
                      8 octets, suivant la grandeur de la valeur.
                      
                      <info>SQLITE3_FLOAT</info> : La valeur est un nombre à virgule flottante, stocké sur 8
                      octets.
                      
                      <info>SQLITE3_TEXT</info> : La valeur est un texte, stocké en utilisant l'encodage de la
                      base de données (UTF-8, UTF-16BE ou UTF-16-LE).
                      
                      <info>SQLITE3_BLOB</info> : La valeur est un BLOB, stocké exactement de la façon dont il a
                      été fourni.
                      
                      <info>SQLITE3_NULL</info> : La valeur est la valeur NULL.
                      
                      À partir de PHP 7.0.7, si <strong>$type</strong> est omit, il est automatiquement détecté
                      depuis le type de <strong>$var</strong> : booléen et entier sont traités comme <info>SQLITE3_INTEGER</info>,
                      nombre décimal comme <info>SQLITE3_FLOAT</info>, <info>null</info> comme <info>SQLITE3_NULL</info> et tous les autres
                      comme <info>SQLITE3_TEXT</info>. Auparavant, si <strong>$type</strong> était omit, il était par défaut
                      <info>SQLITE3_TEXT</info>.
                      
                      Si <strong>$var</strong> est <info>null</info>, c'était toujours traité comme <info>SQLITE3_NULL</info>, peu importe le
                      <strong>$type</strong> fournie.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le paramètre est lié à la variable de déclaration, <info>false</info> si une erreur
        survient.

<comment>See Also:</comment>
   * SQLite3Stmt::bindValue
   * SQLite3::prepare


id: SQLite3Stmt::bindValue
type: function
doc:
<comment>Description:</comment>
  Lie la valeur d'un paramètre à une variable de déclaration
  
  Lie la valeur d'un paramètre à une variable de déclaration.
  
  Avant PHP 7.2.14 et 7.3.0, respectivement, une fois que la déclaration a été exécuté
  SQLite3Stmt::reset doit être appelé pour pouvoir changer la valeur des paramètres liés.

<comment>Param:</comment>
  <info>string|int</info>  <strong>$param</strong>  Soit une chaîne de caractères (pour les paramètres nommés) ou un entier (pour
                      les paramètres positionnel) identifiant la variable de déclaration à laquelle
                      la valeur doit être liée. Si un paramètre nommé ne débute pas avec un
                      caractère "deux point" (<return>:</return>) ou un arobase (<return>@</return>), "deux point" (<return>:</return>) seront
                      automatiquement préfixé. Les paramètres positionnels commencent avec <return>1</return>.
  <info>mixed</info>       <strong>$value</strong>  La valeur à lier à la variable de déclaration.
  <info>int</info>         <strong>$type</strong>   Le type de données de la valeur à lier. <info>SQLITE3_INTEGER</info> : La valeur est un
                      entier signé, stocké sur 1, 2, 3, 4, 6, ou 8 octets, suivant la grandeur de la
                      valeur. <info>SQLITE3_FLOAT</info> : La valeur est un nombre à virgule flottante, stocké
                      sur 8 octets. <info>SQLITE3_TEXT</info> : La valeur est un texte, stocké en utilisant
                      l'encodage de la base de données (UTF-8, UTF-16BE ou UTF-16-LE). <info>SQLITE3_BLOB</info>
                      : La valeur est un BLOB, stocké exactement de la façon dont il a été fourni.
                      <info>SQLITE3_NULL</info> : La valeur est la valeur NULL.
                      
                      <info>SQLITE3_INTEGER</info> : La valeur est un entier signé, stocké sur 1, 2, 3, 4, 6, ou
                      8 octets, suivant la grandeur de la valeur.
                      
                      <info>SQLITE3_FLOAT</info> : La valeur est un nombre à virgule flottante, stocké sur 8
                      octets.
                      
                      <info>SQLITE3_TEXT</info> : La valeur est un texte, stocké en utilisant l'encodage de la
                      base de données (UTF-8, UTF-16BE ou UTF-16-LE).
                      
                      <info>SQLITE3_BLOB</info> : La valeur est un BLOB, stocké exactement de la façon dont il a
                      été fourni.
                      
                      <info>SQLITE3_NULL</info> : La valeur est la valeur NULL.
                      
                      À partir de PHP 7.0.7, si <strong>$type</strong> est omit, il est automatiquement détecté
                      depuis le type de <strong>$value</strong> : booléen et entier sont traités comme
                      <info>SQLITE3_INTEGER</info>, nombre décimal comme <info>SQLITE3_FLOAT</info>, <info>null</info> comme <info>SQLITE3_NULL</info>
                      et tous les autres comme <info>SQLITE3_TEXT</info>. Auparavant, si <strong>$type</strong> était omit, il
                      était par défaut <info>SQLITE3_TEXT</info>.
                      
                      Si <strong>$value</strong> est <info>null</info>, c'était toujours traité comme <info>SQLITE3_NULL</info>, peu importe le
                      <strong>$type</strong> fournie.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la valeur a été liée à la variable de déclaration,  ou <info>false</info> si une erreur
        survient.

<comment>See Also:</comment>
   * SQLite3Stmt::bindParam
   * SQLite3::prepare


id: SQLite3Stmt::clear
type: function
doc:
<comment>Description:</comment>
  Supprime tous les paramètres actuellement liés
  
  Supprime tous les paramètres actuellement liés (les définit en tant que <info>null</info>).
  
  Cette méthode doit être utilisé avec SQLite3Stmt::reset. Si utilisé seul, tout appel à
  SQLite3Stmt::bindValue ou SQLite3Stmt::bindParam n'aura aucun effet et tous les paramètres liés
  auront comme valeur <info>null</info>.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si tous les paramètres actuellement liés ont été supprimés, <info>false</info> si une
        erreur survient.


id: SQLite3Stmt::close
type: function
doc:
<comment>Description:</comment>
  Ferme une requête préparée
  
  Ferme une requête préparée.
  
  Notez que tous les <class>SQLite3Result</class> qui ont été  récupérés en exécutant cette instruction seront
  invalidés lorsque  l'instruction sera fermée.

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


id: SQLite3Stmt::execute
type: function
doc:
<comment>Description:</comment>
  Exécute une requête préparée
  
  Exécute une requête préparée et retourne un objet représentant le jeu de résultats.
  
  Les objets de jeu de résultats récupérés par l'appel de cette méthode sur le  même objet
  d'instruction ne sont pas indépendants, mais partagent plutôt la  même structure sous-jacente. Par
  conséquent, il est recommandé d'appeler  SQLite3Result::finalize, avant d'appeler de nouveau
  SQLite3Stmt::execute sur le même objet d'instruction.

<comment>Return:</comment>
  <info>SQLite3Result|false</info>  Retourne un objet <class>SQLite3Result</class> si la requête préparée a été exécutée avec
                       succès, ou <info>false</info> si une erreur survient.

<comment>See Also:</comment>
   * SQLite3::prepare
   * SQLite3Stmt::bindValue
   * SQLite3Stmt::bindParam


id: SQLite3Stmt::getSQL
type: function
doc:
<comment>Description:</comment>
  Récupère le SQL d'une déclaration
  
  Récupère le SQL d'une déclaration préparé. Si <strong>$expand</strong> est <info>false</info>, le SQL non modifié est récupéré.
  Si <strong>$expand</strong> est <info>true</info>, tous les paramètres de requête sont remplacés avec leurs valeurs liées, ou
  avec un <return>NULL</return> SQL, si pas encore lié.

<comment>Param:</comment>
  <info>bool</info>  <strong>$expand</strong>  S'il faut récupérer le code SQL étendue. Passer <info>true</info> n'est supporté qu'à partir de
                 libsqlite 3.14.

<comment>Return:</comment>
  <info>string|false</info>  Retourne le SQL de la déclaration préparé,  ou <info>false</info> si une erreur survient.


id: SQLite3Stmt::paramCount
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de paramètres d'une requête préparée
  
  Retourne le nombre de paramètres d'une requête préparée.

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de paramètres d'une requête préparée.

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


id: SQLite3Stmt::readOnly
type: function
doc:
<comment>Description:</comment>
  Détermine si une déclaration est uniquement en lecture seule
  
  Détermine si une déclaration est uniquement en lecture seule. Une déclaration est considéré
  uniquement en lecture seule, si elle ne fait aucun changement direct au contenue du fichier de
  base de donnée. Noter que les fonctions SQL définit par l'utilisateur peuvent indirectement
  changer la base de données en tant qu'effet secondaire.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la déclaration est uniquement en lecture seule, <info>false</info> sinon.


id: SQLite3Stmt::reset
type: function
doc:
<comment>Description:</comment>
  Réinitialise une requête préparée
  
  Réinitialise une requête préparée, de tel sorte à retrouver son état initial, avant exécution.
  Tous les marqueurs resteront intacts après cette opération.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si la requête préaprée a été correctement réinitialisée, ou <info>false</info> si une
        erreur survient.


id: SSH2_DEFAULT_TERMINAL
type: constant
doc:
<comment>Description:</comment>
  Type par défaut du terminal (e.g. <return>"vt102"</return>,  <return>"ansi"</return>, <return>"xterm"</return>,  <return>"vanilla"</return>)  demandé par la fonction
  <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_HEIGHT
type: constant
doc:
<comment>Description:</comment>
  Hauteur par défaut du terminal demandé par la fonction  <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_UNIT
type: constant
doc:
<comment>Description:</comment>
  Unité par défaut du terminal demandé par la fonction  <strong>ssh2_shell()</strong>.


id: SSH2_DEFAULT_TERM_WIDTH
type: constant
doc:
<comment>Description:</comment>
  Largeur par défaut du terminal demandé par la fonction  <strong>ssh2_shell()</strong>.


id: SSH2_FINGERPRINT_HEX
type: constant
doc:
<comment>Description:</comment>
  Flag permettant à la fonction <strong>ssh2_fingerprint()</strong> de demander l'empreinte de la clé de l'hôte en
  tant que chaîne hexits.


id: SSH2_FINGERPRINT_MD5
type: constant
doc:
<comment>Description:</comment>
  Flag permettant à la fonction <strong>ssh2_fingerprint()</strong> de demander l'empreinte de la clé de l'hôte en
  tant que hash MD5.


id: SSH2_FINGERPRINT_RAW
type: constant
doc:
<comment>Description:</comment>
  Flag permettant à la fonction <strong>ssh2_fingerprint()</strong> de demander l'empreinte de la clé de l'hôte en
  tant que chaîne de caractères 8-bit.


id: SSH2_FINGERPRINT_SHA1
type: constant
doc:
<comment>Description:</comment>
  Flag permettant à la fonction <strong>ssh2_fingerprint()</strong> de demander l'empreinte de la clé de l'hôte en
  tant que hash SHA1.


id: SSH2_STREAM_STDERR
type: constant
doc:
<comment>Description:</comment>
  Flag pour que la fonction <strong>ssh2_fetch_stream()</strong>  demande un sous-canal STDERR.


id: SSH2_STREAM_STDIO
type: constant
doc:
<comment>Description:</comment>
  Flag pour que la fonction <strong>ssh2_fetch_stream()</strong>  demande un sous-canal STDIO.


id: SSH2_TERM_UNIT_CHARS
type: constant
doc:
<comment>Description:</comment>
  Flag spécifiant à la fonction <strong>ssh2_shell()</strong> que les paramètres <strong>$width</strong> et  <strong>$height</strong> sont fournis sous
  la forme de taille de caractères.


id: SSH2_TERM_UNIT_PIXELS
type: constant
doc:
<comment>Description:</comment>
  Flag spécifiant à la fonction <strong>ssh2_shell()</strong> que les paramètres <strong>$width</strong> et  <strong>$height</strong> sont fournis sous
  la forme de pixels.


id: STREAM_CAST_AS_STREAM
type: constant
doc:
<comment>Description:</comment>
  Transtypage de flux, lorsque <strong>stream_cast()</strong> est appelé autrement (voir ci-dessus).


id: STREAM_CAST_FOR_SELECT
type: constant
doc:
<comment>Description:</comment>
  Transtypage de flux, lorsque <strong>stream_select()</strong> appelle <strong>stream_cast()</strong>.


id: STREAM_CLIENT_ASYNC_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Ouvre un socket client en mode asynchrone. Cette option doit être utilisée avec l'option
  <info>STREAM_CLIENT_CONNECT</info>. À utiliser avec la fonction <strong>stream_socket_client()</strong>.


id: STREAM_CLIENT_CONNECT
type: constant
doc:
<comment>Description:</comment>
  Ouvre un socket client. Les sockets clients doivent toujours inclure ce flag. À utiliser avec la
  fonction <strong>stream_socket_client()</strong>.


id: STREAM_CLIENT_PERSISTENT
type: constant
doc:
<comment>Description:</comment>
  Le socket client ouvert avec <strong>stream_socket_client()</strong> doit rester persistant entre chaque page
  chargée.


id: STREAM_FILTER_ALL
type: constant
doc:
<comment>Description:</comment>
  Cette constante est équivalente à STREAM_FILTER_READ | STREAM_FILTER_WRITE


id: STREAM_FILTER_READ
type: constant
doc:
<comment>Description:</comment>
  Utilisée avec <strong>stream_filter_append()</strong> et <strong>stream_filter_prepend()</strong> pour indiquer que le filtre
  spécifié ne doit être appliqué qu'après la lecture.


id: STREAM_FILTER_WRITE
type: constant
doc:
<comment>Description:</comment>
  Utilisée avec <strong>stream_filter_append()</strong> et <strong>stream_filter_prepend()</strong> pour indiquer que le filtre
  spécifié ne doit être appliqué qu'après l' écriture.


id: STREAM_META_ACCESS
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>stream_metadata()</strong>, pour spécifier un appel <strong>chmod()</strong>.


id: STREAM_META_GROUP
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>stream_metadata()</strong>, pour spécifier un appel <strong>chgrp()</strong>.


id: STREAM_META_OWNER
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>stream_metadata()</strong>, pour spécifier un appel <strong>chown()</strong>.


id: STREAM_META_TOUCH
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>stream_metadata()</strong>, pour spécifier un appel <strong>touch()</strong>.


id: STREAM_NOTIFY_AUTH_REQUIRED
type: constant
doc:
<comment>Description:</comment>
  Une autorisation supplémentaire est demandée pour accéder à la ressource spécifiée. Typiquement
  utilisé avec le niveau d'alerte <strong>$severity</strong> de la constante <info>STREAM_NOTIFY_SEVERITY_ERR</info>.


id: STREAM_NOTIFY_FAILURE
type: constant
doc:
<comment>Description:</comment>
  Une erreur générique est intervenue sur le flux, consultez les paramètres <strong>$message</strong> et
  <strong>$message_code</strong> pour plus de détails.


id: STREAM_NOTIFY_MIME_TYPE_IS
type: constant
doc:
<comment>Description:</comment>
  Le <return>type mime</return> de la ressource a été identifié : voir le paramètre <strong>$message</strong> pour une description du
  type découvert.


id: STREAM_NOTIFY_PROGRESS
type: constant
doc:
<comment>Description:</comment>
  Indique l'actuelle progression du transfert du flux dans <strong>$bytes_transferred</strong> et peut-être
  <strong>$bytes_max</strong> également.


id: STREAM_NOTIFY_REDIRECTED
type: constant
doc:
<comment>Description:</comment>
  La ressource externe a redirigé le flux vers un endroit différent. Voir le paramètre <strong>$message</strong>.


id: STREAM_NOTIFY_RESOLVE
type: constant
doc:
<comment>Description:</comment>
  Une adresse distante requise pour ce flux a été résolue, ou bien la résolution a échoué. Voir le
  paramètre <strong>$severity</strong> pour avoir une indication sur l'événement survenu.


id: STREAM_NOTIFY_SEVERITY_ERR
type: constant
doc:
<comment>Description:</comment>
  Une erreur critique est survenu. Le traitement ne peut continuer.


id: STREAM_REPORT_ERRORS
type: constant
doc:
<comment>Description:</comment>
  Option indiquant si le gestionnaire est responsable pour la levée des erreurs avec <strong>trigger_error()</strong>
  durant l'ouverture du flux. Si cette constante n'existe pas, vous ne devez pas émettre d'erreurs.


id: STREAM_SERVER_BIND
type: constant
doc:
<comment>Description:</comment>
  Appel un flux créé avec la fonction <strong>stream_socket_server()</strong> pour s'identifier sur la cible définie.
  Les sockets serveur doivent toujours utiliser cette constante.


id: STREAM_SERVER_LISTEN
type: constant
doc:
<comment>Description:</comment>
  Appel un flux créé avec <strong>stream_socket_server()</strong> et utilise la constante <info>STREAM_SERVER_BIND</info> pour
  commencer à écouter le socket. Les connexions orientées transports (comme TCP) doivent utiliser
  cet option sinon le socket serveur ne sera pas activée. Utiliser cette option pour les connexions
  basses de transports, comme UDP, est une erreur.


id: STREAM_SHUT_RD
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>stream_socket_shutdown()</strong> pour désactiver les réceptions futures.


id: STREAM_SHUT_RDWR
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>stream_socket_shutdown()</strong> pour désactiver les réceptions et transmissions futures.


id: STREAM_SHUT_WR
type: constant
doc:
<comment>Description:</comment>
  Utilisé avec <strong>stream_socket_shutdown()</strong> pour désactiver les transmissions futures.


id: STREAM_SOCK_DGRAM
type: constant
doc:
<comment>Description:</comment>
  Fournit des datagrammes, qui sont des messages sans connectivité (UDP, par exemple).


id: STREAM_SOCK_RAW
type: constant
doc:
<comment>Description:</comment>
  Fournit un socket brut, qui fournit un accès aux protocoles et interfaces internes du réseau.
  Habituellement, ce type de socket n'est disponible qu'à l'utilisateur root.


id: STREAM_SOCK_STREAM
type: constant
doc:
<comment>Description:</comment>
  Fournit un flux en séquence bi-directionnel avec un mécanisme de transmission pour les données
  "out-of-band" (TCP par exemple).


id: STREAM_USE_PATH
type: constant
doc:
<comment>Description:</comment>
  Option indiquant si <return>stream</return> a utilisé l'include_path.


id: SVM::C_SVC
type: constant
doc:
<comment>Description:</comment>
  Le type SVM C_SVC basique. C'est le type par défaut, et un bon point de départ.


id: SVM::EPSILON_SVR
type: constant
doc:
<comment>Description:</comment>
  Un type SVM pour la régression (prédiction d'une valeur plutôt que seulement une classe).


id: SVM::KERNEL_LINEAR
type: constant
doc:
<comment>Description:</comment>
  Un noyau très simple, pouvant fonctionner correctement sur un large document de problèmes de
  classification.


id: SVM::KERNEL_RBF
type: constant
doc:
<comment>Description:</comment>
  Un noyau Gaussien RBD commun. Gère parfaitement les problèmes non linéaires, et est un bon noyau
  par défaut pour la classification.


id: SVM::KERNEL_SIGMOID
type: constant
doc:
<comment>Description:</comment>
  Un noyau basé sur la fonction sigmoïde. Son utilisant rend SVM très similaire à une interface
  sigmoïde basée sur un réseau neutre.


id: SVM::NU_SVC
type: constant
doc:
<comment>Description:</comment>
  Le type NU_SVC utilise une pondération différente, plus souple des erreurs.


id: SVM::ONE_CLASS
type: constant
doc:
<comment>Description:</comment>
  Une type de classe SVM. S'entraîne sur une seule classe, en utilisant les valeurs aberrantes comme
  des exemples négatifs.


id: SVM::OPT_C
type: constant
doc:
<comment>Description:</comment>
  L'option pour le paramètre cost qui contrôle les négociations entre les erreurs et les généralités
  - effectivement, la pénalité pour mauvaise classification des exemples d'entrainement.


id: SVM::OPT_EPS
type: constant
doc:
<comment>Description:</comment>
  La clé optionnelle pour le paramètre Epsilon, utilisé pour la régression epsilon.


id: SVM::OPT_GAMMA
type: constant
doc:
<comment>Description:</comment>
  Paramètre de l'algorithme pour les types de noyau Poly, RBF et sigmoïde.


id: SVM::OPT_NU
type: constant
doc:
<comment>Description:</comment>
  La clé optionnelle pour le paramètre NU, uniquement utilisée pour les types NU_ SVM.


id: SVM::OPT_PROBABILITY
type: constant
doc:
<comment>Description:</comment>
  Paramètre d’entraînement, booléen, pour indiquer d'utiliser des estimations des probabilités.


id: SVM::OPT_SHRINKING
type: constant
doc:
<comment>Description:</comment>
  Paramètre d’entraînement, booléen, pour indiquer d'utiliser les heuristiques rétrécis.


id: SVM::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet SVM
  
  Construit un nouvel objet SVM prêt à accepter des données d'entrainement.


id: SVM::crossvalidate
type: function
doc:
<comment>Description:</comment>
  Test les paramètres d'entraînement sur les sous-jeux de données d’entraînement
  
  Peut être utilisé pour tester l'effectivité du jeu de paramètres courant sur les sous-jeux des
  données d'entraînement. En fournissant un problème ainsi que n "plis", la fonction séparera le jeu
  du problème en n sous-jeux, et commence des entraînements successifs sur les sous-jeux. Bien que
  la précision soit généralement plus faible qu'un SVM entraîné  des jeux de données fournies, le
  score de précision retourné devrait être suffisament utile pour être utilisé pour tester
  différents paramètres d'entraînement.

<comment>Param:</comment>
  <info>array</info>  <strong>$problem</strong>          Les données du problème. Peut être sous la forme d'un tableau, d'une URL
                           vers un fichier SVMLight, ou d'un flux vers une ressource de données
                           SVMLight ouverte.
  <info>int</info>    <strong>$number_of_folds</strong>  Le nombre de jeux dans lequel les données doivent être divisées et
                           testées. Un nombre élevé signifie que les jeux d'entraînement seront plus
                           petits et moins fiables. 5 est un bon début.

<comment>Return:</comment>
  <info>float</info>  Le pourcentage correct, exprimé sous la forme d'un nombre à virgule flottante dans
         l'intervalle 0-1. Dans le cas d'un noyau NU_SVC ou EPSILON_SVR, l'erreur quadratique
         moyenne sera retournée.

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


id: SVM::getOptions
type: function
doc:
<comment>Description:</comment>
  Retourne les paramètres courants d’entraînement
  
  Récupère un tableau contenant les paramètres d’entraînement. Ces paramètres auront pour clés les
  constantes SVM prédéfinies.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant les paramètres de configuration.


id: SVM::setOptions
type: function
doc:
<comment>Description:</comment>
  Définit des paramètres d'entraînement
  
  Définit un ou plusieurs paramètres d'entraînement.

<comment>Param:</comment>
  <info>array</info>  <strong>$params</strong>  Un tableau de paramètres d'entraînement, dont les clés sont les constantes SVM.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, et lance une exception SVMException si une erreur survient.


id: SVM::train
type: function
doc:
<comment>Description:</comment>
  Crée un modèle SVMModel suivant les données d'entraînement
  
  Entraîne une machine vectorielle basée sur les données d'entraînement fournies.

<comment>Param:</comment>
  <info>array</info>  <strong>$problem</strong>  Le problème peut être fourni de 3 façons. Un tableau, où les données doivent
                   commencer par le libellé de la classe (habituellement 1 ou -1), suivi par une
                   série de données sous la forme de paires dimensions/données. Une URL vers un
                   fichier contenant un problème SVM Light formaté, dont chaque ligne commence par
                   un nouvel exemple d'entraînement, le début de chaque ligne contient la classe (1
                   ou -1) puis, une série de valeurs de données séparées par une tabulation sous la
                   forme clé:valeur. Un flux ouvert pointant vers une source de données formatée
                   comme dans le fichier ci-dessus.
  <info>array</info>  <strong>$weights</strong>  Les poids sont des ensembles optionnels de paramètres de pondération pour les
                   différentes classes, afin d'aider dans le comptage pour des jeux d'entraînement
                   déséquilibrés. Par exemple, si les classes sont 1 et -1, et que -1 a plus
                   d'exemples significatifs que le premier, le poids pour -1 pourrait être de 0.5.
                   Les poids doivent être dans l'intervalle 0-1.

<comment>Return:</comment>
  <info>SVMModel</info>  Retourne un modèle SVMModel qui peut être utilisé pour classificer les données
            précédemment non vues. Lance une exception SVMException si une erreur survient.


id: SVMModel
type: class
doc:
<comment>Description:</comment>
  SVMModel est le résultat final du processus d'entraînement. Il peut être utilisé pour classifier
  les données non vues précédentes.


id: SVMModel::__construct
type: function
doc:
<comment>Description:</comment>
  Construit un nouvel objet SVMModel
  
  Construit un nouvel objet SVMModel. Les modèles sont généralement construits depuis la fonction
  SVM::train, alors que les modèles sauvegardés peuvent être restaurés directement.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le nom du fichier pour le modèle sauvegardé à charger.

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


id: SVMModel::checkProbabilityModel
type: function
doc:
<comment>Description:</comment>
  Retourne true si le modèle a des informations probablistes
  
  Retourne <info>true</info> si le modèle a probablement des informations.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen.


id: SVMModel::getLabels
type: function
doc:
<comment>Description:</comment>
  Récupère les labels utilisés pour entraîner le modèle
  
  Retourne un tableau de labels utilisés pour entraîner le modèle. Pour les cas de régression et
  pour les classes mobèles seules, un tableau vide est retourné.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau de labels.

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


id: SVMModel::getNrClass
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de classes utilisées pour entraîner le modèle
  
  Retourne le nombre de classes utilisées pour entraîner le modèle ; retournera 2 pour une seule
  classe et pour les modèles de régression.

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de classes, sous la forme d'un entier.


id: SVMModel::getSvmType
type: function
doc:
<comment>Description:</comment>
  Récupère le type SVM utilisé pour entraîner le modèle
  
  Retourne un entier représentant le type du modèle SVM utilisé, i.e. SVM::C_SVC.

<comment>Return:</comment>
  <info>int</info>  Retourne le type SVM sous la forme d'un entier.


id: SVMModel::getSvrProbability
type: function
doc:
<comment>Description:</comment>
  Récupère la valeur sigma pour les types de régression
  
  Pour les modèles de régression, retourne une valeur sigma; S'il n'y a aucune information de
  probabilité ou le modèle n'est pas SVR, 0 sera retourné.

<comment>Return:</comment>
  <info>float</info>  Retourne une valeur sigma.


id: SVMModel::load
type: function
doc:
<comment>Description:</comment>
  Charge un modèle SVM sauvegardé
  
  Charge un fichier de modèle prêt pour une classification ou une régression.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le nom de fichier du modèle.

<comment>Return:</comment>
  <info>bool</info>  Lance une exception SVMException en cas d'erreur. Retourne <info>true</info> en cas de succès.

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


id: SVMModel::predict
type: function
doc:
<comment>Description:</comment>
  Prédit une valeur pour des précédentes données non vues
  
  Cette fonction accepte un tableau de données et tente de prédire la valeur de la classe ou de la
  régression, suivant le modèle extrait depuis les données précédemment entraînées.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>  Le tableau à classifier. Ce peut être une série de paires clé =&gt; valeur dans
                l'ordre croissant des clés, mais non nécessairement continue.

<comment>Return:</comment>
  <info>float</info>  Retourne la valeur prédite. Ce peut être un libellé de classe dans le cas d'une
         classification, une valeur réelle dans le cas d'une régression. Lance une exception
         SVMException si une erreur survient.

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


id: SVMModel::predict_probability
type: function
doc:
<comment>Description:</comment>
  Retourne les probabilités pour les données précédentes non présentées
  
  Cette fonction accepte une tableau de données et tente de prédire la classe, comme avec les
  fonctions de prédiction. De plus, cependant, cette fonction retourne un tableau de probabilités,
  une par classe du modèle, qui représente la chanse estimée que les données fournies soient un
  membre de cette classe. Nécessite que le modèle à utiliser soit traité avec le paramètre de
  probabilité fixé à <info>true</info>.

<comment>Param:</comment>
  <info>array</info>  <strong>$data</strong>           Le tableau à classifier. Ce doit être une série de paires clé=&gt;valeur
                         dont les clés sont en ordre croissant, mais pas nécessairement continue.
  <info></info>       <strong>$probabilities</strong>  La valeur fournie sera complétée avec les probabilités. Ce peut être soit
                         <info>null</info> dans le cas où le modèle ne contient aucune information de
                         probabiblité, ou un tableau dont les index sont les noms de classe, et les
                         valeurs, la probabilité.

<comment>Return:</comment>
  <info>float</info>  Retourne la valeur prédie. Ce sera un libel de classe dans le cas d'une classification, une
         valeur réelle dans le cas d'une régression. Lance une exception de type SVMException si une
         erreur survient.

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


id: SVMModel::save
type: function
doc:
<comment>Description:</comment>
  Sauvegarde un modèle dans un fichier
  
  Sauvegarde le modèle de données dans un fichier, pour une utilisation ultérieure.

<comment>Param:</comment>
  <info>string</info>  <strong>$filename</strong>  Le fichier dans lequel nous souhaitons sauvegarder le modèle.

<comment>Return:</comment>
  <info>bool</info>  Lance une exception SVMException si une erreur survient. Retourne <info>true</info> en cas de succès.

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


id: SVN_AUTH_PARAM_DEFAULT_PASSWORD
type: constant
doc:
<comment>Description:</comment>
  Propriété pour le mot de passe par défaut, à utiliser lors de l'identification de base


id: SVN_AUTH_PARAM_DEFAULT_USERNAME
type: constant
doc:
<comment>Description:</comment>
  Propriété pour le nom d'utilisateur par défaut, à utiliser lors de l'identification de base


id: SVN_FS_CONFIG_FS_TYPE
type: constant
doc:
<comment>Description:</comment>
  Clé de configuration qui détermine le type de système de fichiers


id: SVN_WC_STATUS_CONFLICTED
type: constant
doc:
<comment>Description:</comment>
  Les modifications de l'élément local entrent en conflit avec les modifications du référentiel


id: SVN_WC_STATUS_IGNORED
type: constant
doc:
<comment>Description:</comment>
  L'élément n'est pas versionné mais est configuré pour être ignoré


id: SVN_WC_STATUS_MERGED
type: constant
doc:
<comment>Description:</comment>
  Les modifications de l'élément local ont été fusionnées avec les modifications du référentiel


id: SVN_WC_STATUS_OBSTRUCTED
type: constant
doc:
<comment>Description:</comment>
  L'élément non versionné s'apprête à être une ressource versionnée


id: Schema::__construct
type: function
doc:
<comment>Description:</comment>
  Schema constructor
  
  The Schema object provides full access to the schema (database).


id: Schema::createCollection
type: function
doc:
<comment>Description:</comment>
  Add collection to schema
  
  Create a collection within the schema.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>      Collection name.
  <info>string</info>  <strong>$validate</strong>  Validation definition, as a JSON object.

<comment>Return:</comment>
  <info>mysql_xdevapi\Collection</info>  The Collection object.


id: Schema::dropCollection
type: function
doc:
<comment>Description:</comment>
  Drop collection from schema
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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

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


id: Schema::existsInDatabase
type: function
doc:
<comment>Description:</comment>
  Check if exists in database
  
  Checks if the current object (schema, table, collection, or view) exists in the schema object.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the schema, table, collection, or view still exists in the schema, else <info>false</info>.


id: Schema::getCollection
type: function
doc:
<comment>Description:</comment>
  Get collection from schema
  
  Get a collection from the schema.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Collection name to retrieve.

<comment>Return:</comment>
  <info>mysql_xdevapi\Collection</info>  The Collection object for the selected collection.


id: Schema::getCollectionAsTable
type: function
doc:
<comment>Description:</comment>
  Get collection as a Table object
  
  Get a collection, but as a Table object instead of a Collection object.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the collection to instantiate a Table object from.

<comment>Return:</comment>
  <info>mysql_xdevapi\Table</info>  A <class>mysql_xdevapi\Table</class> object for the collection.


id: Schema::getCollections
type: function
doc:
<comment>Description:</comment>
  Get all schema collections
  
  Fetch a list of collections for this schema.

<comment>Return:</comment>
  <info>array</info>  Array of all collections in this schema, where each array element value is a Collection
         object with the collection name as the key.


id: Schema::getName
type: function
doc:
<comment>Description:</comment>
  Get schema name
  
  Get the name of the schema.

<comment>Return:</comment>
  <info>string</info>  The name of the schema connected to the schema object, as a string.


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

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


id: Schema::getTable
type: function
doc:
<comment>Description:</comment>
  Get schema table
  
  Fetch a Table object for the provided table in the schema.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the table.

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


id: Schema::getTables
type: function
doc:
<comment>Description:</comment>
  Get schema tables
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>array</info>  Array of all tables in this schema, where each array element value is a Table object with
         the table name as the key.


id: SchemaObject::getSchema
type: function
doc:
<comment>Description:</comment>
  Get schema object
  
  Used by other objects to retrieve a schema object.

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  The current Schema object.


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


id: SeasLog::alert
type: function
doc:
<comment>Description:</comment>
  Record alert log information
  
  Record alert log information.  "ALERT" - Action must be taken immediately. Immediate attention
  should be given to relevant personnel for emergency repairs.
  
  "ALERT" - Action must be taken immediately. Immediate attention should be given to relevant
  personnel for emergency repairs.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::analyzerCount
type: function
doc:
<comment>Description:</comment>
  Get log count by level, log_path and key_word
  
  `SeasLog` get count value of `grep -ai '{level}' | grep -aic '{key_word}'`  use system pipe and
  return to PHP (array or int).

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>     String. The log information level.
  <info>string</info>  <strong>$log_path</strong>  String. The log information path.
  <info>string</info>  <strong>$key_word</strong>  String. The search key word for log information.

<comment>Return:</comment>
  <info>mixed</info>  If `level` is SEASLOG_ALL or Empty, return all levels count as `array`. If `level` is
         SEASLOG_INFO or the other level, return count as `int`.

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


id: SeasLog::analyzerDetail
type: function
doc:
<comment>Description:</comment>
  Get log detail by level, log_path, key_word, start, limit, order
  
  `SeasLog` get results of  `grep -ai '{level}' | grep -ai '{key_word}' |  sed -n
  '{start},{limit}'p`  use system pipe and return array to PHP.

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>     String. The log information level.
  <info>string</info>  <strong>$log_path</strong>  String. The log information path.
  <info>string</info>  <strong>$key_word</strong>  String. The search key word for log information.
  <info>int</info>     <strong>$start</strong>     Int. Default is `1`.
  <info>int</info>     <strong>$limit</strong>     Int. Default is `20`.
  <info>int</info>     <strong>$order</strong>     Int. Default is SEASLOG_DETAIL_ORDER_ASC. See also:
                     SEASLOG_DETAIL_ORDER_ASCSEASLOG_DETAIL_ORDER_DESC

<comment>Return:</comment>
  <info>mixed</info>  Return results as array.  When `start`,`limit` is not NULL and in Windows,  SeasLog will
         threw exception with message 'Param start and limit don't support Windows'.
         
         When `start`,`limit` is not NULL and in Windows,  SeasLog will threw exception with message
         'Param start and limit don't support Windows'.

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


id: SeasLog::closeLoggerStream
type: function
doc:
<comment>Description:</comment>
  Manually release stream flow from logger
  
  Manually release stream flow from logger. SeasLog caches the stream handle opened by the log
  logger to save the overhead of creating a stream. The handle will be automatically released at the
  end of the request. If in CLI mode, the process will also automatically release when it exits. Or
  you can use the following functions to manually release(manually release function needs to update
  SeasLog 1.8.6 or updated version).

<comment>Param:</comment>
  <info>int</info>     <strong>$model</strong>   Constant int.
                   SEASLOG_CLOSE_LOGGER_STREAM_MOD_ALLSEASLOG_CLOSE_LOGGER_STREAM_MOD_ASSIGN
  <info>string</info>  <strong>$logger</strong>  The logger name.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on released stream flow success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::setLogger
   * SeasLog::getLastLogger


id: SeasLog::critical
type: function
doc:
<comment>Description:</comment>
  Record critical log information
  
  Record critical log information.  "CRITICAL" - Critical conditions.Need to be repaired
  immediately, and the program component is unavailable.
  
  "CRITICAL" - Critical conditions.Need to be repaired immediately, and the program component is
  unavailable.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::debug
type: function
doc:
<comment>Description:</comment>
  Record debug log information
  
  Record debug log information.  "DEBUG" - Detailed debug information.Fine-grained information
  events.
  
  "DEBUG" - Detailed debug information.Fine-grained information events.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::emergency
type: function
doc:
<comment>Description:</comment>
  Record emergency log information
  
  Record emergency log information.  "EMERGENCY" - System is unusable. 
  
  "EMERGENCY" - System is unusable.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::log


id: SeasLog::error
type: function
doc:
<comment>Description:</comment>
  Record error log information
  
  Record error log information.  "ERROR" - Runtime errors that do not require immediate action but
  should typically.
  
  "ERROR" - Runtime errors that do not require immediate action but should typically.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::flushBuffer
type: function
doc:
<comment>Description:</comment>
  Flush logs buffer, dump to appender file, or send to remote api with tcp/udp
  
  Flush logs buffer by seaslog.appender:  dump to file, or send to remote api with tcp/udp.  See
  also: seaslog.appender_retry seaslog.remote_host seaslog.remote_port
  
  See also: seaslog.appender_retry seaslog.remote_host seaslog.remote_port

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on flush buffer success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBufferEnabled
   * SeasLog::getBuffer


id: SeasLog::getBasePath
type: function
doc:
<comment>Description:</comment>
  Get SeasLog base path.
  
  Use the Function SeasLog::getBasePath will get the value of seaslog.default_basepath what
  configured in php.ini(seaslog.ini).
  
  If you use Seaslog::setBasePath, will change the result.

<comment>Return:</comment>
  <info>string</info>  Return seaslog.default_basepath as string.


id: SeasLog::getBuffer
type: function
doc:
<comment>Description:</comment>
  Get the logs buffer in memory as array

<comment>Return:</comment>
  <info>array</info>  Return an array from logs buffer in memory.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBufferEnabled
   * SeasLog::flushBuffer


id: SeasLog::getBufferEnabled
type: function
doc:
<comment>Description:</comment>
  Determin if buffer enabled
  
  Result join seaslog.use_buffer  and seaslog.buffer_disabled_in_cli.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on seaslog.use_buffer is true. If switch seaslog.buffer_disabled_in_cli on, and
        running in cli,  seaslog.use_buffer setting will be discarded, Seaslog write to the Data
        Store IMMEDIATELY.

<comment>See Also:</comment>
   * seaslog.use_buffer
   * seaslog.buffer_size
   * seaslog.buffer_disabled_in_cli
   * SeasLog::getBuffer
   * SeasLog::flushBuffer


id: SeasLog::getDatetimeFormat
type: function
doc:
<comment>Description:</comment>
  Get SeasLog datetime format style
  
  Get SeasLog datetime format style. Use the Function SeasLog::getDatetimeFormat will  get the value
  of seaslog.default_datetime_format  what configured in php.ini(seaslog.ini).

<comment>Return:</comment>
  <info>string</info>  Get SeasLog datetime format style of  seaslog.default_datetime_format. Use the Function
          SeasLog::setDatetimeFormat  will change this value.

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


id: SeasLog::getLastLogger
type: function
doc:
<comment>Description:</comment>
  Get SeasLog last logger path
  
  Use the Function SeasLog::getLastLogger will  get the value of seaslog.default_logger  what
  configured in php.ini(seaslog.ini).

<comment>Return:</comment>
  <info>string</info>  Use the Function SeasLog::setLogger  will change the value of function
          SeasLog::getLastLogger.

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


id: SeasLog::getRequestID
type: function
doc:
<comment>Description:</comment>
  Get SeasLog request_id differentiated requests
  
  To distinguish a single request, such as not invoking the  SeasLog::setRequestId function， the
  unique value generated by the built-in `static char *get_uniqid ()`  function is used when the
  request is initialized.

<comment>Return:</comment>
  <info>string</info>  Return string generated by the built-in `static char *get_uniqid ()` function, or setted
          by SeasLog::setRequestId function.

<comment>See Also:</comment>
   * SeasLog::setRequestID
   * The Variable `%Q` in 
   Seaslog Default Variable Table.


id: SeasLog::getRequestVariable
type: function
doc:
<comment>Description:</comment>
  Get SeasLog request variable
  
  Get SeasLog request variable.

<comment>Param:</comment>
  <info>int</info>  <strong>$key</strong>  Constant int.
             SEASLOG_REQUEST_VARIABLE_DOMAIN_PORTSEASLOG_REQUEST_VARIABLE_REQUEST_URISEASLOG_REQUEST_VARIABLE_REQUEST_METHODSEASLOG_REQUEST_VARIABLE_CLIENT_IP

<comment>Return:</comment>
  <info>bool</info>  Return request variable value on set success.

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


id: SeasLog::info
type: function
doc:
<comment>Description:</comment>
  Record info log information
  
  Record info log information.  "INFO" - Interesting events.Emphasizes the running process of the
  application.
  
  "INFO" - Interesting events.Emphasizes the running process of the application.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::log
type: function
doc:
<comment>Description:</comment>
  The Common Record Log Function
  
  The Common Record Log Function.

<comment>Param:</comment>
  <info>string</info>  <strong>$level</strong>    Can use level in:
                    SEASLOG_DEBUGSEASLOG_INFOSEASLOG_NOTICESEASLOG_WARNINGSEASLOG_ERRORSEASLOG_CRITICALSEASLOG_ALERTSEASLOG_EMERGENCY
                    Or you can create a new level self-help.
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency


id: SeasLog::notice
type: function
doc:
<comment>Description:</comment>
  Record notice log information
  
  Record notice log information.  "NOTICE" - Normal but significant events.Information that is more
  important than the INFO level during execution.
  
  "NOTICE" - Normal but significant events.Information that is more important than the INFO level
  during execution.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::warning
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeasLog::setBasePath
type: function
doc:
<comment>Description:</comment>
  Set SeasLog base path
  
  Set SeasLog base path.

<comment>Param:</comment>
  <info>string</info>  <strong>$base_path</strong>  String.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on setted base path success, FALSE on failure.


id: SeasLog::setDatetimeFormat
type: function
doc:
<comment>Description:</comment>
  Set SeasLog datetime format style
  
  Set SeasLog datetime format style.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$format</strong>  String. Such as `Y-m-d H:i:s` or `Ymd His`. See also first param `format` at
                   <strong>date()</strong>.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on setted datetime format success, FALSE on failure.

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


id: SeasLog::setLogger
type: function
doc:
<comment>Description:</comment>
  Set SeasLog logger name
  
  Use the Function SeasLog::setLogger will change the value of function SeasLog::getLastLogger.
  Than's mean, SeasLog will record loginfo into the logger directory.

<comment>Param:</comment>
  <info>string</info>  <strong>$logger</strong>  Logger name.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on created logger disectory success, FALSE on failure.

<comment>See Also:</comment>
   * SeasLog::getLastLogger
   * SeasLog::closeLoggerStream


id: SeasLog::setRequestID
type: function
doc:
<comment>Description:</comment>
  Set SeasLog request_id differentiated requests
  
  To distinguish a single request, such as not invoking the  SeasLog::setRequestId function， the
  unique value generated by the built-in `static char *get_uniqid ()`  function is used when the
  request is initialized.

<comment>Param:</comment>
  <info>string</info>  <strong>$request_id</strong>  String.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on set request_id success, FALSE on failure.

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


id: SeasLog::setRequestVariable
type: function
doc:
<comment>Description:</comment>
  Manually set SeasLog request variable
  
  Manually set SeasLog request variable.

<comment>Param:</comment>
  <info>int</info>     <strong>$key</strong>    Constant int.
                  SEASLOG_REQUEST_VARIABLE_DOMAIN_PORTSEASLOG_REQUEST_VARIABLE_REQUEST_URISEASLOG_REQUEST_VARIABLE_REQUEST_METHODSEASLOG_REQUEST_VARIABLE_CLIENT_IP
  <info>string</info>  <strong>$value</strong>  The request variable value.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on set success, FALSE on failure.

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


id: SeasLog::warning
type: function
doc:
<comment>Description:</comment>
  Record warning log information
  
  Record warning log information.  "WARNING" - Exceptional occurrences that are not errors.
  Potentially aberrant information that needs attention and needs to be repaired.
  
  "WARNING" - Exceptional occurrences that are not errors. Potentially aberrant information that
  needs attention and needs to be repaired.

<comment>Param:</comment>
  <info>string</info>  <strong>$message</strong>  The log message.
  <info>array</info>   <strong>$content</strong>  The `message` contain placeholders which implementors replace with values from
                    content array. Sush as `message` is `log info  from {NAME}` and `content` is
                    `array('NAME' =&gt; neeke)`, the log information will `log info from neeke`.
  <info>string</info>  <strong>$logger</strong>   The `logger` cased by the third param would be used right this right now,  like
                    a temp logger, when the function SeasLog::setLogger() called in pre content. If
                    `logger` NULL or "", SeasLog will use lastest logger setted by
                    SeasLog::setLogger.

<comment>Return:</comment>
  <info>bool</info>  Return TRUE on record log information success, FALSE on failure.

<comment>See Also:</comment>
   * seaslog.default_template
   * SeasLog::debug
   * SeasLog::info
   * SeasLog::notice
   * SeasLog::error
   * SeasLog::critical
   * SeasLog::alert
   * SeasLog::emergency
   * SeasLog::log


id: SeekableIterator::seek
type: function
doc:
<comment>Description:</comment>
  Recherche une position
  
  Recherche la position donnée dans l'itérateur.

<comment>Param:</comment>
  <info>int</info>  <strong>$offset</strong>  La position à atteindre.

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

<comment>See Also:</comment>
   * <class>SeekableIterator</class>
   * <class>Iterator</class>


id: SensitiveParameter
type: class
doc:
<comment>Description:</comment>
   Cet attribut est utilisé pour indiquer qu'un paramètre est sensible et que sa valeur doit être
  expurgée s'il est présent dans une trace de pile.


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


id: SensitiveParameterValue
type: class
doc:
<comment>Description:</comment>
  La classe <class>SensitiveParameterValue</class> permet d'envelopper des valeurs pour les protéger contre une
  exposition accidentelle.
  
  Les valeurs des paramètres ayant l'attribut <class>SensitiveParameter</class>  seront automatiquement enveloppées
  dans un objet <class>SensitiveParameterValue</class> dans les traces de pile.


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

<comment>Param:</comment>
  <info>mixed</info>  <strong>$value</strong>  Une valeur arbitraire qui doit être stockée dans l'objet <class>SensitiveParameterValue</class>.


id: SensitiveParameterValue::__debugInfo
type: function
doc:
<comment>Description:</comment>
  Protège la valeur sensible contre une exposition accidentelle
  
  Retourne un tableau vide pour protéger la valeur sensible contre une exposition accidentelle lors
  de l'utilisation de <strong>var_dump()</strong>.

<comment>Return:</comment>
  <info>array</info>  Un tableau vide.


id: SensitiveParameterValue::getValue
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur sensible
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>mixed</info>  La valeur sensible.


id: Serializable
type: class
doc:
<comment>Description:</comment>
  Interface permettant de personnaliser la sérialisation.
  
  Les classes implémentant cette interface ne supportent plus __sleep() et __wakeup(). La méthode de
  sérialisation est appelée chaque fois qu'une instance doit être sérialisée. Elle n'appelle pas la
  méthode __destruct() et n'a aucun effet sur le contenu de cette méthode. Lorsque les données sont
  sérialisées, la classe est connue et la méthode unserialize() appropriée est appelée comme
  constructeur au lieu d'appeler __construct(). Si vous devez appeler le constructeur standard, vous
  pouvez le faire dans la méthode.
  
  À partir de PHP 8.1.0, une classe qui implémente Serializable sans aussi implémenter __serialize()
  et __unserialize() génèrera une notice de dépréciation.


id: Serializable::serialize
type: function
doc:
<comment>Description:</comment>
  Représentation linéaire de l'objet
  
  Retourne la représentation en chaîne de caractères de l'objet.

<comment>Return:</comment>
  <info>string|null</info>  Retourne la représentation de l'objet en chaîne de caractères, ou bien <info>null</info>.

<comment>See Also:</comment>
   * __sleep()
   * __serialize()


id: Serializable::unserialize
type: function
doc:
<comment>Description:</comment>
  Construit un objet
  
  Appelé lors de la désérialisation de l'objet.
  
  Cette méthode se comporte comme un  constructeur d'objet. La méthode __construct() ne sera pas
  appelée après cette méthode.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>  La représentation en chaîne de l'objet.

<comment>Return:</comment>
  <info>void</info>  La valeur de retour est ignorée.

<comment>See Also:</comment>
   * __wakeup()
   * __unserialize()


id: Session::__construct
type: function
doc:
<comment>Description:</comment>
  Description constructor
  
  A Session object, as initiated by getSession().


id: Session::close
type: function
doc:
<comment>Description:</comment>
  Close session
  
  Close the session with the server.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the session closed.


id: Session::commit
type: function
doc:
<comment>Description:</comment>
  Commit transaction
  
  Commit the transaction.

<comment>Return:</comment>
  <info>Object</info>  An SqlStatementResult object.


id: Session::createSchema
type: function
doc:
<comment>Description:</comment>
  Create new schema
  
  Creates a new schema.

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Name of the schema to create.

<comment>Return:</comment>
  <info>mysql_xdevapi\Schema</info>  A Schema object on success, and emits an exception on failure.


id: Session::dropSchema
type: function
doc:
<comment>Description:</comment>
  Drop a schema
  
  Drop a schema (database).

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Name of the schema to drop.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> if the schema is dropped, or <info>false</info> if it does not exist or can't be dropped.
        
        An <info>E_WARNING</info> level error is generated if the  schema does not exist.


id: Session::generateUUID
type: function
doc:
<comment>Description:</comment>
  Get new UUID
  
  Generate a Universal Unique IDentifier (UUID) generated according to  RFC 4122.

<comment>Return:</comment>
  <info>string</info>  The UUID; a string with a length of 32.


id: Session::getDefaultSchema
type: function
doc:
<comment>Description:</comment>
  Get default schema name
  
  Retrieve name of the default schema that's typically set in the connection URI.

<comment>Return:</comment>
  <info>string</info>  Name of the default schema defined by the connection, or <info>null</info> if one was not set.


id: Session::getSchema
type: function
doc:
<comment>Description:</comment>
  Get a new schema object
  
  A new Schema object for the provided schema name.

<comment>Param:</comment>
  <info>string</info>  <strong>$schema_name</strong>  Name of the schema (database) to fetch a Schema object for.

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


id: Session::getSchemas
type: function
doc:
<comment>Description:</comment>
  Get the schemas
  
  Get schema objects for all schemas available to the session.

<comment>Return:</comment>
  <info>array</info>  An array containing objects that represent all of the schemas  available to the session.


id: Session::getServerVersion
type: function
doc:
<comment>Description:</comment>
  Get server version
  
  Retrieve the MySQL server version for the session.

<comment>Return:</comment>
  <info>int</info>  The MySQL server version for the session, as an integer such as "80012".


id: Session::listClients
type: function
doc:
<comment>Description:</comment>
  Get client list
  
  Get a list of client connections to the session's MySQL server.

<comment>Return:</comment>
  <info>array</info>  An array containing the currently logged clients. The array elements are "client_id",
         "user", "host", and "sql_session".


id: Session::quoteName
type: function
doc:
<comment>Description:</comment>
  Add quotes
  
  A quoting function to escape SQL names and identifiers. It escapes the identifier  given in
  accordance to the settings of the current connection. This escape  function should not be used to
  escape values.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The string to quote.

<comment>Return:</comment>
  <info>string</info>  The quoted string.


id: Session::releaseSavepoint
type: function
doc:
<comment>Description:</comment>
  Release set savepoint
  
  Release a previously set savepoint.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the savepoint to release.

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: Session::rollback
type: function
doc:
<comment>Description:</comment>
  Rollback transaction
  
  Rollback the transaction.

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: Session::rollbackTo
type: function
doc:
<comment>Description:</comment>
  Rollback transaction to savepoint
  
  Rollback the transaction back to the savepoint.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Name of the savepoint to rollback to; case-insensitive.

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: Session::setSavepoint
type: function
doc:
<comment>Description:</comment>
  Create savepoint
  
  Create a new savepoint for the transaction.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  The name of the savepoint. The name is auto-generated if the optional <return>name</return>
                 parameter is not defined as 'SAVEPOINT1', 'SAVEPOINT2', and so on.

<comment>Return:</comment>
  <info>string</info>  The name of the save point.


id: Session::sql
type: function
doc:
<comment>Description:</comment>
  Create SQL query
  
  Create a native SQL statement. Placeholders are supported using the native "?" syntax. Use the
  <return>execute</return> method to execute the SQL statement.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  SQL statement to execute.

<comment>Return:</comment>
  <info>mysql_xdevapi\SqlStatement</info>  An SqlStatement object.


id: Session::startTransaction
type: function
doc:
<comment>Description:</comment>
  Start transaction
  
  Start a new transaction.

<comment>Return:</comment>
  <info>void</info>  An SqlStatementResult object.


id: SessionHandler
type: class
doc:
<comment>Description:</comment>
  La classe <class>SessionHandler</class> est une classe spéciale qui peut être utilisée pour exposer le
  gestionnaire de sauvegarde de session courant en interne de PHP, par héritage. Il y a sept
  méthodes qui représentent les sept fonctions de rappel du gestionnaire de sauvegarde de session
  interne (<strong>$open</strong>, <strong>$close</strong>, <strong>$read</strong>, <strong>$write</strong>, <strong>$destroy</strong>, <strong>$gc</strong> et <strong>$create_sid</strong>). Par défaut, cette classe va
  représenter ce qui est défini dans le gestionnaire de sauvegarde interne, tel que défini par la
  directive de configuration session.save_handler, qui vaut habituellement <strong>$files</strong> par défaut.
  D'autres gestionnaires de sauvegarde de session interne sont fournis par des extensions PHP, comme
  SQLite (avec le paramètre <strong>$sqlite</strong>), Memcache (avec le paramètre <strong>$memcache</strong>), et Memcached (avec le
  paramètre <strong>$memcached</strong>).
  
  Lorsqu'une instance complète de <class>SessionHandler</class> est définie comme gestionnaire de sauvegarde en
  utilisant <strong>session_set_save_handler()</strong>, elle remplacera le gestionnaire de sauvegarde courant. Une
  classe étendue depuis la classe <class>SessionHandler</class> vous permet d'écraser les méthodes, de les
  intercepter, ou de les filtrer en appelant la méthode de la classe parent qui remplace en dernier
  lieu le gestionnaire de session interne de PHP.
  
  Ceci vous permet, par exemple, d'interception les méthodes <strong>$read</strong> et <strong>$write</strong> pour crypter/décrypter
  les données de session, et de passer le résultat à la classe parente. Alternativement, vous pouvez
  aussi choisir d'écraser totalement une méthode comme la fonction de rappel de collection des
  gabarits <strong>$gc</strong>.
  
  En raison du fait que la classe <class>SessionHandler</class> se comporte comme les méthodes du gestionnaire
  courant de sauvegarde de sessions interne, l'exemple ci-dessus de cryptage peut être appliqué à
  n'importe quel gestionnaire de sauvegarde sans avoir besoin de connaître les gestionnaires
  internes.
  
  Pour utiliser cette classe, vous devez commencer par définir un gestionnaire de sauvegarde que
  vous souhaitez exposer en utilisant session.save_handler puis, passer une instance de la classe
  <class>SessionHandler</class> ou une étendue à la fonction <strong>session_set_save_handler()</strong>.
  
  Veuillez noter que les méthodes de rappel de cette classe sont destinées à être appelées en
  interne par PHP, et ne sont pas prévues pour être appelées depuis le code de l'espace utilisateur.
  Les valeurs retournées seront utilisées de la même façon en interne par PHP. Pour plus
  d'informations sur le mécanisme des sessions, référez-vous à la documentation sur la fonction
  <strong>session_set_save_handler()</strong>.


id: SessionHandler::close
type: function
doc:
<comment>Description:</comment>
  Ferme la session
  
  Ferme la session courante. Cette méthode est exécutée automatiquement lors de la fermeture de la
  session ou explicitement via la fonction <strong>session_write_close()</strong> (qui appèle en premier la méthode
  <strong>SessionHandler::write()</strong>).
  
  Cette méthode se substitue au gestionnaire interne de sauvegarde de PHP défini via l'option de
  configuration session.save_handler qui a été défini avant que ce gestionnaire ne soit activé via
  la fonction <strong>session_set_save_handler()</strong>.
  
  Si cette classe est étendue par héritage, l'appel de la méthode parente <strong>$close</strong> invoquera la
  nouvelle méthode, et ainsi, la fonction de rappel interne associée. Ce mécanisme autorise la
  surcharge et/ou l'interception  de cette méthode.
  
  Pour plus d'informations sur le fonctionnement de cette méthode et ses attendus, référez-vous à la
  documentation sur la fonction <strong>SessionHandlerInterface::close()</strong>.

<comment>Return:</comment>
  <info>bool</info>  La valeur retournée (habituellement <info>true</info> en cas de succès, <info>false</info> si une erreur survient).
        Notez que cette valeur est retournée en interne à PHP pour analyse.


id: SessionHandler::create_sid
type: function
doc:
<comment>Description:</comment>
  Retourne un nouvel ID de session
  
  Génère et retourne un nouvel ID de session.

<comment>Return:</comment>
  <info>string</info>  Un ID de session valide pour le gestionnaire de session par défaut.

<comment>See Also:</comment>
   * <strong>session_id()</strong>
   * <strong>session_create_id()</strong>


id: SessionHandler::destroy
type: function
doc:
<comment>Description:</comment>
  Détruit une session
  
  Détruit une session. Cette fonction est appelée en interne par PHP au moyen de
  <strong>session_regenerate_id()</strong> (en supposant que <strong>$destory</strong> est mis à <info>true</info>) <strong>session_destroy()</strong> ou lorsque la
  fonction <strong>session_decode()</strong> échoue.
  
  Cette méthode se substitut au gestionnaire interne de sauvegarde de PHP défini via l'option de
  configuration session.save_handler qui a été définie avant celui défini via la fonction
  <strong>session_set_save_handler()</strong>.
  
  Si cette classe est étendue, appeler la méthode parente <strong>$destroy</strong> invoquera le gestionnaire de
  cette méthode et donc la fonction interne à PHP.
  
  Pour plus d'informations sur l'attendu de cette méthode, référez-vous à la documentation de la
  fonction <strong>SessionHandlerInterface::destroy()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  L'ID de la session à détruire.

<comment>Return:</comment>
  <info>bool</info>  La valeur retournée (habituellement <info>true</info> en cas de succès, <info>false</info> si une erreur survient).
        Notez que cette valeur est retournée en interne à PHP pour analyse.


id: SessionHandler::gc
type: function
doc:
<comment>Description:</comment>
  Nettoie les anciennes sessions
  
  Nettoie les sessions expirées. Appelé aléatoirement en interne par PHP lorsqu'une session démarre
  ou lorsque la fonction <strong>session_start()</strong> est appelée. La fréquence d'appel est basée sur les
  directives de configuration session.gc_divisor et session.gc_probability.
  
  Cette méthode se substitue au gestionnaire interne de sauvegarde PHP défini via l'option de
  configuration session.save_handler qui a été définie avant que ce dernier ne le soit via la
  fonction <strong>session_set_save_handler()</strong>.
  
  Si cette classe est étendue par héritage, l'appel à la méthode parente <strong>$gc</strong> invoquera le wrapper
  pour cette méthode, mais aussi, invoquera en interne la fonction de rappel associée. Ce
  comportement permet à cette méthode d'être surchargée ou bien d'être interceptée et filtrée.
  
  Pour plus d'informations sur l'attendu de cette méthode, référez-vous à la documentation sur la
  fonction <strong>SessionHandlerInterface::gc()</strong>.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  Les sessions qui n'auront pas été mises à jour les dernières <strong>$max_lifetime</strong>
                      secondes seront supprimées.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of deleted sessions on success,  ou <info>false</info> si une erreur survient.
             Note this value is returned internally to PHP for processing.


id: SessionHandler::open
type: function
doc:
<comment>Description:</comment>
  Initialise une session
  
  Crée une nouvelle session ou réinitialise une session existante. Cette fonction est appelée en
  interne par PHP lorsque la session démarre,  automatiquement, ou via <strong>session_start()</strong>.
  
  Cette méthode se substitue au gestionnaire interne de sauvegarde de PHP, défini via l'option de
  configuration session.save_handler qui a été définie avant que ce gestionnaire ne soit modifié via
  la fonction <strong>session_set_save_handler()</strong>.
  
  Si cette classe est étendue par héritage, l'appel de la méthode parente <strong>$open</strong> invoquera ce
  gestionnaire pour cette méthode, mais aussi, la fonction de rappel interne associée. Ce mécanisme
  permet à cette méthode de surcharger, intercepter et/ou filtrer les données.
  
  Pour plus d'informations sur l'attendu de cette méthode, référez-vous à la documentation sur la
  fonction <strong>SessionHandlerInterface::open()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Le chemin vers l'endroit de stockage ou de récupération de la session.
  <info>string</info>  <strong>$name</strong>  Le nom de la session.

<comment>Return:</comment>
  <info>bool</info>  La valeur retournée (habituellement <info>true</info> en cas de succès, <info>false</info> si une erreur survient).
        Notez que cette valeur est retournée en interne à PHP pour analyse.

<comment>See Also:</comment>
   * 
     La directive de configuration session.auto-start.
    


id: SessionHandler::read
type: function
doc:
<comment>Description:</comment>
  Lit les données de session
  
  Lit les données de session depuis son lieu de stockage, et retourne le résultat pour que PHP le
  traite. Cette fonction est appelée par PHP lorsque la session est démarrée automatiquement ou au
  moyen de <strong>session_start()</strong>, elle est précédée d'un appel à <strong>SessionHandler::open()</strong>.
  
  Cette méthode se substitue au gestionnaire interne de sauvegarde de PHP, défini via l'option de
  configuration session.save_handler qui a été définie avant que ce gestionnaire ne soit modifié via
  la fonction <strong>session_set_save_handler()</strong>.
  
  Si cette classe est étendue par héritage, l'appel de la méthode parente <strong>$read</strong> invoquera ce
  gestionnaire pour cette méthode, mais aussi, la fonction de rappel interne associée. Ce mécanisme
  permet à cette méthode de surcharger, intercepter et/ou filtrer les données (par exemple, le
  décryptage de la valeur <strong>$data</strong> retournée par la méthode parente <strong>$read</strong>).
  
  Pour plus d'informations sur cette méthode, référez-vous à la documentation sur la fonction
  <strong>SessionHandlerInterface::read()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  L'ID de la session depuis laquelle les données seront lues.

<comment>Return:</comment>
  <info>string|false</info>  Retourne les données lues sous forme encodée. Si rien n'a été lu <info>false</info> doit être
                retournée. Cette valeur est utilisée en interne par PHP.

<comment>See Also:</comment>
   * 
     La directive de configuration session.serialize_handler
    


id: SessionHandler::write
type: function
doc:
<comment>Description:</comment>
  Ecrit des données dans la session
  
  Écrit les données de session vers le support de stockage. Cette fonction est appelée par la
  fonction <strong>session_write_close()</strong>, lorsque la fonction <strong>session_register_shutdown()</strong> échoue, et durant
  le processus d'arrêt. PHP va appeler <strong>SessionHandler::close()</strong> juste après cette fonction.
  
  Cette méthode se substitue au gestionnaire interne de sauvegarde de PHP, défini via l'option de
  configuration session.save_handler qui a été définie avant que ce gestionnaire ne soit modifié via
  la fonction <strong>session_set_save_handler()</strong>.
  
  Si cette classe est étendue par héritage, l'appel de la méthode parente <strong>$write</strong> invoquera ce
  gestionnaire pour cette méthode, mais aussi, la fonction de rappel interne associée. Ce mécanisme
  permet à cette méthode de surcharger, intercepter et/ou filtrer les données (par exemple, crypter
  la valeur du paramètre <strong>$data</strong> value avant de l'envoyer à la méthode parente <strong>$write</strong>).
  
  Pour plus d'informations sur l'attendu de cette méthode, référez-vous à la documentation sur la
  fonction <strong>SessionHandlerInterface::write()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    L'ID de session.
  <info>string</info>  <strong>$data</strong>  Les données de session, encodées. Les données sont le résultat de l'encodage de
                 $_SESSION en une chaine sérialisée avec un algorithme spécial.

<comment>Return:</comment>
  <info>bool</info>  La valeur retournée (habituellement <info>true</info> en cas de succès, <info>false</info> si une erreur survient).
        Notez que cette valeur est retournée en interne à PHP pour analyse.

<comment>See Also:</comment>
   * 
     La directive de configuration session.serialize_handler.
    


id: SessionHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionHandlerInterface</class> est une interface qui définit un prototype minimal pour la création d'un
  gestionnaire de session personnalisé. Afin de passer un gestionnaire de session personnalisé à la
  fonction <strong>session_set_save_handler()</strong> en utilisant son invocation OOP, la classe peut implémenter
  cette interface.
  
  Notez que ces méthodes sont destinées à être appelées de manière interne par PHP, et non depuis
  l'espace utilisateur.


id: SessionHandlerInterface::close
type: function
doc:
<comment>Description:</comment>
  Ferme la session
  
  Ferme la session courante. Cette fonction est appelée automatiquement lors de la fermeture de la
  session, ou explicitement grâce à <strong>session_write_close()</strong>.

<comment>Return:</comment>
  <info>bool</info>  La valeur retournée (habituellement <info>true</info> en cas de succès, <info>false</info> si une erreur survient).
        Notez que cette valeur est retournée en interne à PHP pour analyse.


id: SessionHandlerInterface::destroy
type: function
doc:
<comment>Description:</comment>
  Détruit une session
  
  Détruit une session. Appelée par <strong>session_regenerate_id()</strong> (avec $destroy = <info>true</info>), <strong>session_destroy()</strong>
  et lorsque <strong>session_decode()</strong> échoue.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  L'identifiant de la session à détruire.

<comment>Return:</comment>
  <info>bool</info>  La valeur retournée (habituellement <info>true</info> en cas de succès, <info>false</info> si une erreur survient).
        Notez que cette valeur est retournée en interne à PHP pour analyse.


id: SessionHandlerInterface::gc
type: function
doc:
<comment>Description:</comment>
  Nettoie les vieilles sessions
  
  Nettoie les vieilles sessions expirées. Appelée par <strong>session_start()</strong>, en fonction de
  session.gc_divisor, session.gc_probability et session.gc_maxlifetime.

<comment>Param:</comment>
  <info>int</info>  <strong>$max_lifetime</strong>  Les sessions qui n'ont pas été mit à jour durant les <strong>$max_lifetime</strong> dernières
                      secondes seront supprimées.

<comment>Return:</comment>
  <info>int|false</info>  Returns the number of deleted sessions on success,  ou <info>false</info> si une erreur survient.
             Note this value is returned internally to PHP for processing.


id: SessionHandlerInterface::open
type: function
doc:
<comment>Description:</comment>
  Initialise la session
  
  Ré-initialise une session existante ou en crée une nouvelle. Appelé lorsqu'une session est
  démarrée ou lors de l'appel à <strong>session_start()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$path</strong>  Le chemin où la session est stockée/récupérée.
  <info>string</info>  <strong>$name</strong>  Le nom de la session.

<comment>Return:</comment>
  <info>bool</info>  La valeur retournée (habituellement <info>true</info> en cas de succès, <info>false</info> si une erreur survient).
        Notez que cette valeur est retournée en interne à PHP pour analyse.

<comment>See Also:</comment>
   * <strong>session_name()</strong>
   * 
     La directive de configuration
     session.auto-start
    


id: SessionHandlerInterface::read
type: function
doc:
<comment>Description:</comment>
  Lit les données de session
  
  Lit les données de session depuis le support de stockage et retourne le résultat. Appelé juste
  après que la session démarre ou lorsque <strong>session_start()</strong> est appelée. Notez qu'avant que cette
  méthode ne soit appelée, <strong>SessionHandlerInterface::open()</strong> est invoquée.
  
  Cette méthode est appelée par PHP lui-même lorsque la session démarre. Cette méthode devrait
  retourner les données de session lues depuis le support de stockage en fonction de l'ID de
  session. La chaine retournée devrait être encodée par le même mécanisme de sérialisation que celui
  utilisé pour écrire les données lors de <strong>SessionHandlerInterface::write()</strong>. Si rien n'est lu, une
  chaine vide est retournée.
  
  Les données retournées par cette méthode seront décodées en interne par PHP en utilisant le
  mécanisme de désérialisation spécifié dans session.serialize_handler. Les données résultantes
  seront utilisées pour peupler $_SESSION.
  
  Notez que l'algorithme de sérialisation peut être différent de <strong>unserialize()</strong> et peut être utilisé
  manuellement au moyen de <strong>session_decode()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  L'identifiant de session.

<comment>Return:</comment>
  <info>string|false</info>  Retourne les données lues encodées. Si rien n'est lu <info>false</info> doit être retourné. Notez
                que cette valeur est destiné aux processus internes à PHP.

<comment>See Also:</comment>
   * 
     La directive de configuration
     session.serialize_handler
    


id: SessionHandlerInterface::write
type: function
doc:
<comment>Description:</comment>
  Ecrit les données de session
  
  Écrit les données de session dans le stockage de session. Appelé par <strong>session_write_close()</strong>,
  lorsque <strong>session_register_shutdown()</strong> échoue, ou lors d'un arrêt normal. Note :
  <strong>SessionHandlerInterface::close()</strong> est appelée immédiatement après cette fonction.
  
  PHP appellera cette fonction lorsque la session est prête à être sauvegardée et fermée. Il encode
  les données issues de $_SESSION vers une chaine sérialisée et la passe avec l'ID de session au
  support de stockage. La méthode de sérialisation utilisée est définie dans le paramètre
  session.serialize_handler.
  
  Cette méthode est normalement appelée par PHP après que les tampons de sortie ont été fermé sauf
  si <strong>session_write_close()</strong> est explicitement appelé.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    L'identifiant de session.
  <info>string</info>  <strong>$data</strong>  Les données de session encodées. Ces données sont le résultat de l'encodage interne
                 par PHP de la superglobale $_SESSION à une chaine sérialisée et le passer en tant
                 que ce paramètre. Veuillez noter que les sessions utilise une méthode de
                 sérialisation alternative.

<comment>Return:</comment>
  <info>bool</info>  La valeur retournée (habituellement <info>true</info> en cas de succès, <info>false</info> si une erreur survient).
        Notez que cette valeur est retournée en interne à PHP pour analyse.

<comment>See Also:</comment>
   * 
     La directive de configuration
     session.serialize_handler
    


id: SessionIdInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionIdInterface</class> est une interface qui définit des méthodes optionelles pour la création d'un
  gestionnaire de session personnalisé. Afin de passer un gestionnaire de session personnalisé à la
  fonction <strong>session_set_save_handler()</strong> en utilisant son invocation OOP, la classe peut implémenter
  cette interface.
  
  Notez que ces méthodes sont destinées à être appelées de manière interne par PHP, et non depuis
  l'espace utilisateur.


id: SessionIdInterface::create_sid
type: function
doc:
<comment>Description:</comment>
  Créer un ID de session
  
  Crée un nouvel ID de session. Cette fonction est automatiquement exécutée quand un nouvel ID de
  session doit être créé.

<comment>Return:</comment>
  <info>string</info>  Le nouvel ID de session. Il est à noter que cette valeur est retourné internellement à PHP
          pour du traitement.

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


id: SessionUpdateTimestampHandlerInterface
type: class
doc:
<comment>Description:</comment>
  <class>SessionUpdateTimestampHandlerInterface</class> est une interface qui définit des méthodes optionelles pour
  la création d'un gestionnaire de session personnalisé. Afin de passer un gestionnaire de session
  personnalisé à la fonction <strong>session_set_save_handler()</strong> en utilisant son invocation OOP, la classe
  peut implémenter cette interface.
  
  Notez que ces méthodes sont destinées à être appelées de manière interne par PHP, et non depuis
  l'espace utilisateur.


id: SessionUpdateTimestampHandlerInterface::updateTimestamp
type: function
doc:
<comment>Description:</comment>
  Mettre à jour l'horodatage
  
  Met à jour l'horodatage de dernière modification de la session. Cette fonction est automatiquement
  exécutée quand une session est mise à jour.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>    L'ID de session.
  <info>string</info>  <strong>$data</strong>  Les données de session.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si l'horodatage a été mis à jour, <info>false</info> sinon. Il est à noter que cette valeur
        est retourné internellement à PHP pour du traitement.


id: SessionUpdateTimestampHandlerInterface::validateId
type: function
doc:
<comment>Description:</comment>
  Valider l'ID
  
  Valide un ID de session donnée. Un ID de session est valide, si une session avec cet ID existe
  déjà. Cette fonction est automatiquement exécutée quand une session est démarrée, un ID de session
  est fournie et que session.use_strict_mode est activé.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  L'ID de session

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> pour un ID valide, <info>false</info> sinon. Il est à noter que cette valeur est retourné
        internellement à PHP pour du traitement.


id: Shmop
type: class
doc:
<comment>Description:</comment>
  A fully opaque class which replaces <return>shmop</return> resources as of PHP 8.0.0.


id: SimdJsonException
type: class
doc:
<comment>Description:</comment>
  Exception thrown if <strong>simdjson_decode()</strong>, <strong>simdjson_key_count()</strong>, <strong>simdjson_key_exists()</strong>, or
  <strong>simdjson_key_value()</strong>.
   For possible values see the simdjson error codes constants.


id: SimdJsonValueError
type: class
doc:
<comment>Description:</comment>
  A <class>SimdJsonValueError</class> is thrown when the type of an argument to a function from simdjson is correct
  but the value of it is incorrect. E.g. when the JSON decoding $depth is not positive or the $depth
  is too large.


id: SimpleXMLElement::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un nouvel objet SimpleXMLElement
    
  
  Crée un nouvel objet <class>SimpleXMLElement</class>.

<comment>Param:</comment>
  <info>string</info>  <strong>$data</strong>               Une chaîne de caractères XML bien formée ou le chemin d'accès ou un
                              URL pointant à un document XML si <strong>$dataIsURL</strong> vaut <info>true</info>.
  <info>int</info>     <strong>$options</strong>            Optionnellement utilisé pour spécifier des paramètres Libxml
                              additionnels, qui affecte la lecture de documents XML. Les options
                              affectant la sortie des documents XML (par exemple <info>LIBXML_NOEMPTYTAG</info>)
                              sont ignorée silencieusement.
                              
                              Il peut être nécessaire de passer <info>LIBXML_PARSEHUGE</info> pour pouvoir
                              traiter des nœuds de texte profondément imbriqués ou très volumineux.
  <info>bool</info>    <strong>$dataIsURL</strong>          Par défaut, <strong>$dataIsURL</strong> vaut <info>false</info>. Utilisez <info>true</info> pour spécifier que le
                              paramètre <strong>$data</strong> est un chemin d'accès ou un URL pointant à un document
                              XML au lieu d'une chaîne de caractères de données.
  <info>string</info>  <strong>$namespaceOrPrefix</strong>  Préfixe d'espace de noms ou URI.
  <info>bool</info>    <strong>$isPrefix</strong>           <info>true</info> si <strong>$namespaceOrPrefix</strong> est un préfix, <info>false</info> sinon. Valeur par
                              défaut : <info>false</info>.

<comment>See Also:</comment>
   * 
   * <strong>simplexml_load_string()</strong>
   * <strong>simplexml_load_file()</strong>
   * 
   * <strong>libxml_use_internal_errors()</strong>
   * <strong>libxml_set_streams_context()</strong>


id: SimpleXMLElement::__toString
type: function
doc:
<comment>Description:</comment>
  Retourne le contenu sous forme de chaine
  
  Retourne le contenu texte stocké directement dans l'élément. Ne retourne pas le contenu texte
  stocké dans les éléments enfants.

<comment>Return:</comment>
  <info>string</info>  Retourne le contenu sous forme de chaine de caractères, ou retourne une chaine vide en cas
          d'erreur.

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


id: SimpleXMLElement::addAttribute
type: function
doc:
<comment>Description:</comment>
  Ajoute un attribut à l'élément SimpleXML
    
  
  Ajoute un attribut à l'élément SimpleXML.

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  Le nom de l'attribut à ajouter.
  <info>string</info>       <strong>$value</strong>          La valeur de l'attribut.
  <info>string|null</info>  <strong>$namespace</strong>      Si spécifié, l'espace de nom auquel l'attribut appartient.

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

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


id: SimpleXMLElement::addChild
type: function
doc:
<comment>Description:</comment>
  Ajoute un élément enfant au nœud XML
    
  
  Ajoute un élément enfant au nœud et retourne un SimpleXMLElement de l'enfant.

<comment>Param:</comment>
  <info>string</info>       <strong>$qualifiedName</strong>  Le nom de l'élément enfant à ajouter.
  <info>string|null</info>  <strong>$value</strong>          Si spécifié, la valeur de l'élément enfant.
  <info>string|null</info>  <strong>$namespace</strong>      Si spécifié, l'espace de nom auquel l'élément enfant appartient.

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  La méthode <return>addChild</return> retourne un objet <info>SimpleXMLElement</info> représentant
                         l'enfant à ajouter au nœud XML en cas de succès; <info>null</info> en cas d'échec.

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


id: SimpleXMLElement::asXML
type: function
doc:
<comment>Description:</comment>
  Retourne une chaîne XML basée sur un élément SimpleXML
    
  
  Formate les données de l'objet parent en XML 1.0.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$filename</strong>  Si une chaîne de caractères est spécifié, la fonction écrit les données au
                          fichier au lieu de les retourner.

<comment>Return:</comment>
  <info>string|bool</info>  Si le paramètre <strong>$filename</strong> n'est pas spécifié, la fonction retourne une chaîne de
               caractères en cas de succès et <info>false</info> en cas d'erreur. Si le paramètre est spécifié,
               elle retourne <info>true</info> si le fichier a été écrit correctement et <info>false</info> autrement.

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


id: SimpleXMLElement::attributes
type: function
doc:
<comment>Description:</comment>
  Identifie les attributs d'un élément
  
  Fournit les attributs et les valeurs définies dans une balise XML.
  
  SimpleXML ajoute des propriétés itératives pour presque toutes ses méthodes. Celles-ci ne peuvent
  être vues en utilisant <strong>var_dump()</strong> ou tout autre fonction qui examine les objets.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespaceOrPrefix</strong>  Un espace de noms optionnel pour les attributs récupérés
  <info>bool</info>         <strong>$isPrefix</strong>           Par défaut, vaut <info>false</info>

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Retourne un objet <class>SimpleXMLElement</class> permettant de retrouver tous les
                         attributs d'une balise.
                         
                         Retourne <info>null</info> si appelé sur un objet <class>SimpleXMLElement</class> qui représente déjà
                         un attribut et non une balise.

<comment>See Also:</comment>
   * 


id: SimpleXMLElement::children
type: function
doc:
<comment>Description:</comment>
  Cherche les fils d'un nœud donné
  
  Cette méthode cherche les fils d'un élément. Le résultat suit les règles de l'itération normale.
  
  SimpleXML ajoute des propriétés itératives pour presque toutes ses méthodes. Celles-ci ne peuvent
  être vues en utilisant <strong>var_dump()</strong> ou tout autre fonction qui examine les objets.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$namespaceOrPrefix</strong>  Un espace de noms XML.
  <info>bool</info>         <strong>$isPrefix</strong>           Si <strong>$isPrefix</strong> vaut <info>true</info>, <strong>$namespaceOrPrefix</strong> sera considéré comme
                                   un préfixe. S'il vaut <info>false</info>, <strong>$namespaceOrPrefix</strong> sera considéré
                                   comme une URL vers un espace de noms.

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Retourne un élément <class>SimpleXMLElement</class> que le nœud possède un fils ou pas,
                         sauf si le noeud représente un attribut, auquel cas <info>null</info> est retourné.

<comment>See Also:</comment>
   * SimpleXMLElement::count
   * <strong>count()</strong>


id: SimpleXMLElement::count
type: function
doc:
<comment>Description:</comment>
  Compte le nombre de fils pour un élément
  
  Cette méthode compte le nombre de fils d'un élément.

<comment>Return:</comment>
  <info>int</info>  Retourne le nombre de fils d'un élément.

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


id: SimpleXMLElement::current
type: function
doc:
<comment>Description:</comment>
  Retourne l'entrée courante
  
  Antérieur à PHP 8.0, SimpleXMLElement::current n'était déclarée que sur la sous-classe
  <class>SimpleXMLIterator</class>.
  
  Cette méthode retourne l'élément courant comme un objet <class>SimpleXMLElement</class>.

<comment>Return:</comment>
  <info>SimpleXMLElement</info>  Retourne l'élément courant comme un objet  <class>SimpleXMLElement</class>.

<comment>See Also:</comment>
   * SimpleXMLElement::key
   * SimpleXMLElement::next
   * SimpleXMLElement::rewind
   * SimpleXMLElement::valid
   * <class>SimpleXMLElement</class>


id: SimpleXMLElement::getChildren
type: function
doc:
<comment>Description:</comment>
  Renvoie les sous-éléments de l'élément courant
  
  Antérieur à PHP 8.0, SimpleXMLElement::getChildren n'était déclarée que sur la sous-classe
  <class>SimpleXMLIterator</class>.
  
  Cette méthode retourne un objet <class>SimpleXMLElement</class>  contenant les sous-éléments de l'élémenmt
  courant <class>SimpleXMLElement</class>.

<comment>Return:</comment>
  <info>SimpleXMLElement|null</info>  Retourne un objet <class>SimpleXMLElement</class> contenant les sous-éléments de l'objet
                         courant.


id: SimpleXMLElement::getDocNamespaces
type: function
doc:
<comment>Description:</comment>
  Retourne les espaces de noms déclarés dans un document
    
  
  Retourne les espaces de noms déclarés dans un document.

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  Si spécifié, retourne tous les espaces de noms déclarés dans les nœuds parents
                    et enfants. Sinon, retourne uniquement les espaces de noms déclarés dans le nœud
                    racine.
  <info>bool</info>  <strong>$fromRoot</strong>   Vous permet de vérifier récursivement les espaces de noms sous un nœud fils au
                    lieu d'effectuer cette vérification depuis la racine du document XML.

<comment>Return:</comment>
  <info>array|false</info>  La méthode <return>getDocNamespaces</return> retourne un tableau d'espaces de noms avec leurs URL
               associées.

<comment>See Also:</comment>
   * SimpleXMLElement::getNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::getName
type: function
doc:
<comment>Description:</comment>
  Récupère le nom d'un élément XML
  
  Récupère le nom d'un élément XML.

<comment>Return:</comment>
  <info>string</info>  La méthode <return>getName</return> retourne un nom sous la forme de chaîne de caractères d'une balise XML
          référencé par l'objet SimpleXMLElement.


id: SimpleXMLElement::getNamespaces
type: function
doc:
<comment>Description:</comment>
  Retourne les espaces de noms utilisés dans un document
    
  
  Retourne les espaces de noms utilisés dans un document.

<comment>Param:</comment>
  <info>bool</info>  <strong>$recursive</strong>  Si spécifié, retourne tous les espaces de noms utilisés dans les nœuds parents
                    et enfants. Sinon, retourne uniquement les espaces de noms utilisés dans le nœud
                    racine.

<comment>Return:</comment>
  <info>array</info>  La méthode <return>getNamespaces</return> retourne un tableau d'espaces de noms avec leurs URL associés.

<comment>See Also:</comment>
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::registerXPathNamespace


id: SimpleXMLElement::hasChildren
type: function
doc:
<comment>Description:</comment>
  Vérifie si l'élément actuel a des sous-éléments
  
  Antérieur à PHP 8.0, SimpleXMLElement::hasChildren n'était déclarée que sur la sous-classe
  <class>SimpleXMLIterator</class>.
  
  Cette méthode vérifie si l'objet courant  <class>SimpleXMLElement</class> a des sous-éléments.

<comment>Return:</comment>
  <info>bool</info>  <info>true</info> si l'entrée courante a des sous-éléments, <info>false</info> sinon.


id: SimpleXMLElement::key
type: function
doc:
<comment>Description:</comment>
  Retourne la clé courante
  
  Antérieur à PHP 8.0, SimpleXMLElement::key n'était déclarée que sur la sous-classe
  <class>SimpleXMLIterator</class>.
  
  Cette méthode lit le nom de la balise XML courante.

<comment>Return:</comment>
  <info>string</info>  Retourne le nom de la balise XML dans l'objet courant de l'itéraeur <class>SimpleXMLElement</class>.


id: SimpleXMLElement::next
type: function
doc:
<comment>Description:</comment>
  Se déplace sur l'élément suivant
  
  Antérieur à PHP 8.0, SimpleXMLElement::next n'était déclarée que sur la sous-classe
  <class>SimpleXMLIterator</class>.
  
  Cette méthode déplace l'itérateur  <class>SimpleXMLElement</class> à l'élément suivant.

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


id: SimpleXMLElement::registerXPathNamespace
type: function
doc:
<comment>Description:</comment>
  Crée un contexte préfixe/ns pour la prochaine requête XPath
    
  
  Crée un contexte préfixe/ns pour la prochaine requête XPath. En particulier, ceci est utile si le
  fournisseur du document XML donné modifie les préfixes d'espace de nom. <return>registerXPathNamespace</return>
  créera un préfixe pour l'espace de nom associé, autorisant l'accès aux nœuds dans cet espace de
  nom sans avoir besoin de changer le code pour autoriser les nouveaux préfixes dictés par le
  fournisseur.

<comment>Param:</comment>
  <info>string</info>  <strong>$prefix</strong>     Le préfixe d'espace de nom à utiliser dans la requête XPath pour l'espace de
                      nom donnée dans <strong>$namespace</strong>.
  <info>string</info>  <strong>$namespace</strong>  L'espace de nom à utiliser pour la requête XPath. Ceci doit concorder avec un
                      espace de nom qui est utilisé par le document XML, sinon la requête XPath qui
                      utilise <strong>$prefix</strong> ne retournera aucun résultat.

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

<comment>See Also:</comment>
   * SimpleXMLElement::xpath
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces


id: SimpleXMLElement::rewind
type: function
doc:
<comment>Description:</comment>
  Replace le pointeur au début
  
  Antérieur à PHP 8.0, SimpleXMLElement::rewind n'était déclarée que sur la sous-classe
  <class>SimpleXMLIterator</class>.
  
  Cette méthode remet l'itérateur <class>SimpleXMLElement</class>  au premier élément.

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


id: SimpleXMLElement::saveXML
type: function
doc:
<comment>Description:</comment>
  Alias de SimpleXMLElement::asXML
  
  Cette méthode est un alias de:  SimpleXMLElement::asXML


id: SimpleXMLElement::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si l'élément actuel est valide
  
  Antérieur à PHP 8.0, SimpleXMLElement::valid n'était déclarée que sur la sous-classe
  <class>SimpleXMLIterator</class>.
  
  Cette méthode vérifie si l'élément courant est valide, après un appel à SimpleXMLElement::rewind
  ou SimpleXMLElement::next.

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


id: SimpleXMLElement::xpath
type: function
doc:
<comment>Description:</comment>
  Exécute une requête Xpath sur des données XML
  
  La méthode <return>xpath</return> cherche dans le nœud SimpleXML des enfants qui correspondent au <strong>$expression</strong>
  Xpath.

<comment>Param:</comment>
  <info>string</info>  <strong>$expression</strong>  Un chemin XPath

<comment>Return:</comment>
  <info>array|null|false</info>  Retourne un tableau d'objets SimpleXMLElement en cas de succès ou <info>null</info> ou <info>false</info>
                    si une erreur survient.

<comment>See Also:</comment>
   * SimpleXMLElement::registerXPathNamespace
   * SimpleXMLElement::getDocNamespaces
   * SimpleXMLElement::getNamespaces
   * 


id: SimpleXMLIterator
type: class
doc:
<comment>Description:</comment>
  La classe <class>SimpleXMLIterator</class> fournit des itérations récursives sur tous les éléments d'un objet
  <class>SimpleXMLElement</class>.


id: SoapClient
type: class
doc:
<comment>Description:</comment>
  La classe <class>SoapClient</class> fournit un client pour les serveurs SOAP 1.1 et SOAP 1.2.  Il peut être
  utilisé avec ou sans mode WSDL.


id: SoapClient::__call
type: function
doc:
<comment>Description:</comment>
  Appelle une fonction SOAP (obsolète)
  
  L'appel direct à cette méthode est obsolète. Habituellement, les fonctions SOAP peuvent être
  appelées comme méthodes de l'objet <class>SoapClient</class> ; dans les cas où ce n'est pas possible, ou bien
  qu'il est nécessaire de passer plus d'options, utilisez la méthode SoapClient::__soapCall.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>  Le nom de la fonction SOAP à appeler.
  <info>array</info>   <strong>$args</strong>  Un tableau des arguments à passer à la fonction. Cela peut être soit un tableau
                 ordonné, soit un tableau associatif. Notez que la plupart des serveurs SOAP exigent
                 que les noms des paramètres soient fournis, auquel cas cela doit être un tableau
                 associatif.

<comment>Return:</comment>
  <info>mixed</info>  Les fonctions SOAP peuvent renvoyer une ou plusieurs valeurs. Si seule une valeur est
         renvoyée par la fonction SOAP, la valeur de retour sera un scalaire. Si plusieurs valeurs
         sont renvoyées, un tableau associatif de paramètres de sortie nommés est renvoyé à la
         place.
         
         En cas d'erreur, si l'objet <class>SoapClient</class> a été construit avec l'option <return>exceptions</return> définie sur
         <info>false</info>, un objet <class>SoapFault</class> sera renvoyé.


id: SoapClient::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur SoapClient
  
  Crée un objet <class>SoapClient</class> pour se connecter à un service SOAP.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$wsdl</strong>                URI du fichier <return>WSDL</return> ou <info>null</info> s'il travaille en mode <return>non-WSDL</return>.
                                    
                                    Par défaut, le fichier WSDL sera mis en cache pour des raisons
                                    de performance. Pour désactiver ou configurer cette mise en
                                    cache, consultez la section SOAP Options de configuration et
                                    l'option <return>cache_wsdl</return>
  <info>array</info>        <strong>$options</strong>             Un tableau associatif spécifiant des options supplémentaires
                                    pour le client SOAP. Si le paramètre <strong>$wsdl</strong> est fourni, ceci est
                                    facultatif ; sinon, au moins les paramètres <return>location</return> et <return>url</return>
                                    doivent être fournis. <strong>$location</strong><info>string</info> L'URL du serveur SOAP
                                    auquel envoyer la requête.  Requis si le paramètre <strong>$wsdl</strong> n'est
                                    pas fourni. Si à la fois un paramètre <strong>$wsdl</strong> et l'option <return>location</return>
                                    sont fournis, l'option <return>location</return> remplacera toute location
                                    spécifiée dans le fichier WSDL. <strong>$uri</strong><info>string</info> L'espace de noms
                                    cible du service SOAP.  Requis si le paramètre <strong>$wsdl</strong> n'est pas
                                    fourni; sinon ignoré. <strong>$style</strong><info>int</info> Spécifie le style de liaison à
                                    utiliser pour ce client, en utilisant les constantes <info>SOAP_RPC</info> et
                                    <info>SOAP_DOCUMENT</info>. <info>SOAP_RPC</info> indique une liaison de style RPC, où le
                                    corps de la requête SOAP contient un encodage standard d'un
                                    appel de fonction. <info>SOAP_DOCUMENT</info> indique une liaison de style
                                    document, où le corps de la requête SOAP contient un document
                                    XML avec une signification définie par le service.  Si le
                                    paramètre <strong>$wsdl</strong> est fourni, cette option est ignorée et le style
                                    est lu à partir du fichier WSDL.  Si ni cette option ni le
                                    paramètre <strong>$wsdl</strong> ne sont fournis, le style RPC est utilisé.
                                    <strong>$use</strong><info>int</info> Spécifie le style d'encodage à utiliser pour ce client,
                                    en utilisant les constantes <info>SOAP_ENCODED</info> ou <info>SOAP_LITERAL</info>.
                                    <info>SOAP_ENCODED</info> indique un encodage utilisant les types définis
                                    dans la spécification SOAP. <info>SOAP_LITERAL</info> indique un encodage
                                    utilisant un schéma défini.  Si le paramètre <strong>$wsdl</strong> est fourni,
                                    cette option est ignorée et l'encodage est lu à partir du
                                    fichier WSDL.  Si cette option et le paramètre <strong>$wsdl</strong> ne sont pas
                                    fournis, le style "encoded" est utilisé. <strong>$soap_version</strong><info>int</info>
                                    Spécifie la version du protocole SOAP à utiliser : <info>SOAP_1_1</info> pour
                                    SOAP 1.1, ou <info>SOAP_1_2</info> pour SOAP 1.2.  Si omis, SOAP 1.1 est
                                    utilisé. <strong>$authentication</strong><info>int</info> Spécifie la méthode
                                    d'authentification lors de l'utilisation de l'authentification
                                    HTTP dans les requêtes. La valeur peut être soit
                                    <info>SOAP_AUTHENTICATION_BASIC</info> ou <info>SOAP_AUTHENTICATION_DIGEST</info>.  Si
                                    omis et que l'option <return>login</return> est fournie, l'authentification HTTP
                                    Basic est utilisée. <strong>$login</strong><info>string</info> Nom d'utilisateur à utiliser
                                    avec l'authentification HTTP Basic ou HTTP Digest.
                                    <strong>$password</strong><info>string</info> Mot de passe à utiliser avec l'authentification
                                    HTTP Basic ou HTTP Digest.  À ne pas confondre avec <return>passphrase</return>,
                                    qui est utilisé avec l'authentification par certificat client
                                    HTTPS. <strong>$local_cert</strong><info>string</info> Chemin vers un certificat client à
                                    utiliser avec l'authentification HTTPS. Il doit s'agir d'un
                                    fichier encodé en PEM contenant votre certificat et votre clé
                                    privée.  Le fichier peut également inclure une chaîne
                                    d'émetteurs, qui doit venir après le certificat client.  Peut
                                    également être défini via <strong>$stream_context</strong>, qui permet également
                                    de spécifier un fichier de clé privée distinct.
                                    <strong>$passphrase</strong><info>string</info> Passphrase pour le certificat client spécifié
                                    dans l'option <return>local_cert</return>.  À ne pas confondre avec <return>password</return>, qui
                                    est utilisé avec l'authentification HTTP Basic ou HTTP Digest.
                                    Peut également être défini via <strong>$stream_context</strong>.
                                    <strong>$proxy_host</strong><info>string</info> Nom d'hôte à utiliser comme serveur mandataire
                                    pour les requêtes HTTP.  L'option <return>proxy_port</return> doit également être
                                    spécifiée. <strong>$proxy_port</strong><info>int</info> Port TCP à utiliser lors de la
                                    connexion au serveur mandataire spécifié dans <return>proxy_host</return>.
                                    <strong>$proxy_login</strong><info>string</info> Nom d'utilisateur facultatif pour
                                    s'authentifier auprès du serveur mandataire spécifié dans
                                    <return>proxy_host</return>, en utilisant l'authentification HTTP Basic.
                                    <strong>$proxy_password</strong><info>string</info> Mot de passe facultatif pour
                                    s'authentifier auprès du serveur mandataire spécifié dans
                                    <return>proxy_host</return>, en utilisant l'authentification HTTP Basic.
                                    <strong>$compression</strong><info>int</info> Active la compression des requêtes et des
                                    réponses SOAP HTTP.  La valeur doit être le résultat de
                                    l'opération OR binaire de trois parties : un
                                    <info>SOAP_COMPRESSION_ACCEPT</info> optionnel, pour envoyer l'en-tête
                                    "Accept-Encoding" ; soit <info>SOAP_COMPRESSION_GZIP</info> ou
                                    <info>SOAP_COMPRESSION_DEFLATE</info> pour indiquer l'algorithme de
                                    compression à utiliser ; et un nombre entre 1 et 9 pour indiquer
                                    le niveau de compression à utiliser dans la requête. Par
                                    exemple, pour activer la compression gzip bidirectionnelle avec
                                    le niveau de compression maximal, utilisez
                                    <return>SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP | 9</return>.
                                    <strong>$encoding</strong><info>string</info> Définit l'encodage de caractères interne. Les
                                    requêtes sont toujours envoyées en UTF-8 et converties depuis et
                                    vers cet encodage. <strong>$trace</strong><info>bool</info> Capture les informations de
                                    requête et de réponse, qui peuvent ensuite être consultées à
                                    l'aide des méthodes SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse, et
                                    SoapClient::__getLastResponseHeaders.  Si omis, la valeur par
                                    défaut est <info>false</info> <strong>$classmap</strong><info>array</info> Utilisé pour associer les types
                                    définis dans le WSDL aux classes PHP. Il doit être spécifié sous
                                    la forme d'un tableau associatif avec les noms de types du WSDL
                                    en tant que clés et les noms de classes PHP en tant que valeurs.
                                    Notez que les noms de types d'un élément ne correspondent pas
                                    nécessairement au nom de l'élément (balise).  Les noms de classe
                                    fournis doivent toujours être entièrement qualifiés avec tous
                                    les espaces de noms, et ne jamais commencer par un <return>\</return>. La forme
                                    correcte peut être générée en utilisant ::class.  Notez que lors
                                    de la création d'une classe, le constructeur ne sera pas appelé,
                                    mais les méthodes magiques __set() et __get() pour les
                                    propriétés individuelles le seront. <strong>$typemap</strong><info>array</info> Utilisé pour
                                    définir des correspondances de types à l'aide de fonctions de
                                    rappel définies par l'utilisateur. Chaque correspondance de type
                                    doit être un tableau avec les clés <return>type_name</return> (une <info>chaîne de
                                    caractères</info> spécifiant le type d'élément XML), <return>type_ns</return> (une
                                    <info>chaîne de caractères</info> contenant l'URI de l'espace de noms),
                                    <return>from_xml</return> (un <info>appelable</info> acceptant un paramètre de type chaîne de
                                    caractères et renvoyant un objet) et <return>to_xml</return> (un <info>appelable</info>
                                    acceptant un paramètre de type objet et renvoyant une chaîne de
                                    caractères). <strong>$exceptions</strong><info>bool</info> Définit si les erreurs génèrent des
                                    exceptions de type <class>SoapFault</class>.  Par défaut, c'est <info>true</info>
                                    <strong>$connection_timeout</strong><info>int</info> Définit un délai d'attente en secondes
                                    pour la connexion au service SOAP. Cette option ne définit pas
                                    un délai d'attente pour les services ayant une réponse lente.
                                    Pour limiter le temps d'attente des appels, l'option de
                                    configuration default_socket_timeout est disponible.
                                    <strong>$cache_wsdl</strong><info>int</info> Si le paramètre <strong>$wsdl</strong> est spécifié et que
                                    l'option de configuration soap.wsdl_cache_enabled est activée,
                                    cette option détermine le type de mise en cache. L'une des
                                    constantes <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>, <info>WSDL_CACHE_MEMORY</info>
                                    ou <info>WSDL_CACHE_BOTH</info>.  Deux types de cache sont disponibles : le
                                    cache en mémoire, qui met en cache le WSDL dans la mémoire du
                                    processus en cours, et le cache sur disque, qui met en cache le
                                    WSDL dans un fichier sur le disque partagé entre tous les
                                    processus. Le répertoire à utiliser pour le cache sur disque est
                                    déterminé par l'option de configuration soap.wsdl_cache_dir. Les
                                    deux caches ont la même durée de vie, déterminée par l'option de
                                    configuration soap.wsdl_cache_ttl. Le cache en mémoire a
                                    également un nombre maximum d'entrées déterminé par l'option de
                                    configuration soap.wsdl_cache_limit.  Si non spécifié, l'option
                                    de configuration  soap.wsdl_cache sera utilisée.
                                    <strong>$user_agent</strong><info>string</info> La valeur à utiliser dans l'en-tête HTTP
                                    <return>User-Agent</return> lors des requêtes.  Peut également être définie via
                                    <strong>$stream_context</strong>.  Si non spécifié, l'agent utilisateur sera
                                    <return>"PHP-SOAP/"</return> suivi de la valeur de <info>PHP_VERSION</info>.
                                    <strong>$stream_context</strong><info>resource</info> Un contexte de flux créé par
                                    <strong>stream_context_create()</strong>, qui permet de définir des options
                                    supplémentaires.  Le contexte peut inclure des options de
                                    contexte socket, des options de contexte SSL, ainsi que
                                    certaines options de contexte HTTP sélectionnées : <return>content_type</return>,
                                    <return>header</return>, <return>max_redirects</return>, <return>protocol_version</return>, et <return>user_agent</return>.  Notez
                                    que les en-têtes HTTP suivants sont générés automatiquement ou à
                                    partir d'autres options, et seront ignorés s'ils sont spécifiés
                                    dans l'option de contexte <return>'header'</return> : <return>host</return>, <return>connection</return>,
                                    <return>user-agent</return>, <return>content-length</return>, <return>content-type</return>, <return>cookie</return>, <return>authorization</return>
                                    et <return>proxy-authorization</return>. <strong>$features</strong><info>int</info> Un masque de bits pour
                                    activer une ou plusieurs des fonctionnalités suivantes :
                                    <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> Lors du décodage d'une réponse en
                                    tableau, le comportement par défaut consiste à détecter si un
                                    nom d'élément apparaît une seule fois ou plusieurs fois dans un
                                    élément parent particulier. Pour les éléments qui n'apparaissent
                                    qu'une fois, une propriété d'objet permet un accès direct au
                                    contenu ; pour les éléments qui apparaissent plus d'une fois, la
                                    propriété contient un tableau avec le contenu de chaque élément
                                    correspondant.  Si la fonctionnalité <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>
                                    est activée, les éléments qui n'apparaissent qu'une seule fois
                                    sont placés dans un tableau à un seul élément, de sorte que
                                    l'accès soit cohérent pour tous les éléments. Cela n'a d'effet
                                    que lors de l'utilisation d'un WSDL contenant un schéma pour la
                                    réponse. Consultez la section des examples pour une
                                    illustration. <info>SOAP_USE_XSI_ARRAY_TYPE</info> Lorsque l'option <return>use</return>
                                    option ou la propriété WSDL est définie sur <return>encoded</return>, force les
                                    tableaux à utiliser un type <return>SOAP-ENC:Array</return>, plutôt qu'un type
                                    spécifique au schéma. <info>SOAP_WAIT_ONE_WAY_CALLS</info> Attendre une
                                    réponse même si le WSDL indique une requête à sens unique.
                                    <strong>$keep_alive</strong><info>bool</info> une valeur booléenne définissant si envoyer
                                    l'en-tête <return>Connection: Keep-Alive</return> ou <return>Connection: close</return>.  Par
                                    défaut, c'est <info>true</info> <strong>$ssl_method</strong><info>string</info> Spécifie la version du
                                    protocole SSL ou TLS à utiliser avec les connexions HTTP
                                    sécurisées, au lieu de la négociation par défaut. Spécifier
                                    <info>SOAP_SSL_METHOD_SSLv2</info> ou <info>SOAP_SSL_METHOD_SSLv3</info> forcera
                                    l'utilisation de SSL 2 ou SSL 3, respectivement. Spécifier
                                    <info>SOAP_SSL_METHOD_SSLv23</info> n'a aucun effet ; cette constante
                                    n'existe que pour des raisons de compatibilité ascendante. À
                                    partir de PHP 7.2, spécifier <info>SOAP_SSL_METHOD_TLS</info> n'a également
                                    aucun effet ; dans les versions antérieures, cela forçait
                                    l'utilisation de TLS 1.0.  Il est à noter que les versions SSL 2
                                    et 3 sont considérées comme non sécurisées et peuvent ne pas
                                    être prises en charge par la bibliothèque OpenSSL installée.
                                    Cette option est obsolète à partir de PHP 8.1.0. Une alternative
                                    plus flexible, qui permet de spécifier des versions
                                    individuelles de TLS, consiste à utiliser l'option
                                    <strong>$contexte_de_flux</strong> avec le paramètre de contexte 'crypto_method'.
                                    Spécifier l'utilisation de TLS 1.3 uniquement [ 'crypto_method'
                                    => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]> 
                                    
                                    L'URL du serveur SOAP auquel envoyer la requête.
                                    
                                    Requis si le paramètre <strong>$wsdl</strong> n'est pas fourni. Si à la fois un
                                    paramètre <strong>$wsdl</strong> et l'option <return>location</return> sont fournis, l'option
                                    <return>location</return> remplacera toute location spécifiée dans le fichier
                                    WSDL.
                                    
                                    L'espace de noms cible du service SOAP.
                                    
                                    Requis si le paramètre <strong>$wsdl</strong> n'est pas fourni; sinon ignoré.
                                    
                                    Spécifie le style de liaison à utiliser pour ce client, en
                                    utilisant les constantes <info>SOAP_RPC</info> et <info>SOAP_DOCUMENT</info>. <info>SOAP_RPC</info>
                                    indique une liaison de style RPC, où le corps de la requête SOAP
                                    contient un encodage standard d'un appel de fonction.
                                    <info>SOAP_DOCUMENT</info> indique une liaison de style document, où le corps
                                    de la requête SOAP contient un document XML avec une
                                    signification définie par le service.
                                    
                                    Si le paramètre <strong>$wsdl</strong> est fourni, cette option est ignorée et le
                                    style est lu à partir du fichier WSDL.
                                    
                                    Si ni cette option ni le paramètre <strong>$wsdl</strong> ne sont fournis, le
                                    style RPC est utilisé.
                                    
                                    Spécifie le style d'encodage à utiliser pour ce client, en
                                    utilisant les constantes <info>SOAP_ENCODED</info> ou <info>SOAP_LITERAL</info>.
                                    <info>SOAP_ENCODED</info> indique un encodage utilisant les types définis
                                    dans la spécification SOAP. <info>SOAP_LITERAL</info> indique un encodage
                                    utilisant un schéma défini.
                                    
                                    Si le paramètre <strong>$wsdl</strong> est fourni, cette option est ignorée et
                                    l'encodage est lu à partir du fichier WSDL.
                                    
                                    Si cette option et le paramètre <strong>$wsdl</strong> ne sont pas fournis, le
                                    style "encoded" est utilisé.
                                    
                                    Spécifie la version du protocole SOAP à utiliser : <info>SOAP_1_1</info> pour
                                    SOAP 1.1, ou <info>SOAP_1_2</info> pour SOAP 1.2.
                                    
                                    Si omis, SOAP 1.1 est utilisé.
                                    
                                    Spécifie la méthode d'authentification lors de l'utilisation de
                                    l'authentification HTTP dans les requêtes. La valeur peut être
                                    soit <info>SOAP_AUTHENTICATION_BASIC</info> ou <info>SOAP_AUTHENTICATION_DIGEST</info>.
                                    
                                    Si omis et que l'option <return>login</return> est fournie, l'authentification
                                    HTTP Basic est utilisée.
                                    
                                    Nom d'utilisateur à utiliser avec l'authentification HTTP Basic
                                    ou HTTP Digest.
                                    
                                    Mot de passe à utiliser avec l'authentification HTTP Basic ou
                                    HTTP Digest.
                                    
                                    À ne pas confondre avec <return>passphrase</return>, qui est utilisé avec
                                    l'authentification par certificat client HTTPS.
                                    
                                    Chemin vers un certificat client à utiliser avec
                                    l'authentification HTTPS. Il doit s'agir d'un fichier encodé en
                                    PEM contenant votre certificat et votre clé privée.
                                    
                                    Le fichier peut également inclure une chaîne d'émetteurs, qui
                                    doit venir après le certificat client.
                                    
                                    Peut également être défini via <strong>$stream_context</strong>, qui permet
                                    également de spécifier un fichier de clé privée distinct.
                                    
                                    Passphrase pour le certificat client spécifié dans l'option
                                    <return>local_cert</return>.
                                    
                                    À ne pas confondre avec <return>password</return>, qui est utilisé avec
                                    l'authentification HTTP Basic ou HTTP Digest.
                                    
                                    Peut également être défini via <strong>$stream_context</strong>.
                                    
                                    Nom d'hôte à utiliser comme serveur mandataire pour les requêtes
                                    HTTP.
                                    
                                    L'option <return>proxy_port</return> doit également être spécifiée.
                                    
                                    Port TCP à utiliser lors de la connexion au serveur mandataire
                                    spécifié dans <return>proxy_host</return>.
                                    
                                    Nom d'utilisateur facultatif pour s'authentifier auprès du
                                    serveur mandataire spécifié dans <return>proxy_host</return>, en utilisant
                                    l'authentification HTTP Basic.
                                    
                                    Mot de passe facultatif pour s'authentifier auprès du serveur
                                    mandataire spécifié dans <return>proxy_host</return>, en utilisant
                                    l'authentification HTTP Basic.
                                    
                                    Active la compression des requêtes et des réponses SOAP HTTP.
                                    
                                    La valeur doit être le résultat de l'opération OR binaire de
                                    trois parties : un <info>SOAP_COMPRESSION_ACCEPT</info> optionnel, pour
                                    envoyer l'en-tête "Accept-Encoding" ; soit <info>SOAP_COMPRESSION_GZIP</info>
                                    ou <info>SOAP_COMPRESSION_DEFLATE</info> pour indiquer l'algorithme de
                                    compression à utiliser ; et un nombre entre 1 et 9 pour indiquer
                                    le niveau de compression à utiliser dans la requête. Par
                                    exemple, pour activer la compression gzip bidirectionnelle avec
                                    le niveau de compression maximal, utilisez
                                    <return>SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP | 9</return>.
                                    
                                    Définit l'encodage de caractères interne. Les requêtes sont
                                    toujours envoyées en UTF-8 et converties depuis et vers cet
                                    encodage.
                                    
                                    Capture les informations de requête et de réponse, qui peuvent
                                    ensuite être consultées à l'aide des méthodes
                                    SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse, et
                                    SoapClient::__getLastResponseHeaders.
                                    
                                    Si omis, la valeur par défaut est <info>false</info>
                                    
                                    Utilisé pour associer les types définis dans le WSDL aux classes
                                    PHP. Il doit être spécifié sous la forme d'un tableau associatif
                                    avec les noms de types du WSDL en tant que clés et les noms de
                                    classes PHP en tant que valeurs. Notez que les noms de types
                                    d'un élément ne correspondent pas nécessairement au nom de
                                    l'élément (balise).
                                    
                                    Les noms de classe fournis doivent toujours être entièrement
                                    qualifiés avec tous les espaces de noms, et ne jamais commencer
                                    par un <return>\</return>. La forme correcte peut être générée en utilisant
                                    ::class.
                                    
                                    Notez que lors de la création d'une classe, le constructeur ne
                                    sera pas appelé, mais les méthodes magiques __set() et __get()
                                    pour les propriétés individuelles le seront.
                                    
                                    Utilisé pour définir des correspondances de types à l'aide de
                                    fonctions de rappel définies par l'utilisateur. Chaque
                                    correspondance de type doit être un tableau avec les clés
                                    <return>type_name</return> (une <info>chaîne de caractères</info> spécifiant le type d'élément
                                    XML), <return>type_ns</return> (une <info>chaîne de caractères</info> contenant l'URI de
                                    l'espace de noms), <return>from_xml</return> (un <info>appelable</info> acceptant un paramètre
                                    de type chaîne de caractères et renvoyant un objet) et <return>to_xml</return>
                                    (un <info>appelable</info> acceptant un paramètre de type objet et renvoyant
                                    une chaîne de caractères).
                                    
                                    Définit si les erreurs génèrent des exceptions de type
                                    <class>SoapFault</class>.
                                    
                                    Par défaut, c'est <info>true</info>
                                    
                                    Définit un délai d'attente en secondes pour la connexion au
                                    service SOAP. Cette option ne définit pas un délai d'attente
                                    pour les services ayant une réponse lente. Pour limiter le temps
                                    d'attente des appels, l'option de configuration
                                    default_socket_timeout est disponible.
                                    
                                    Si le paramètre <strong>$wsdl</strong> est spécifié et que l'option de
                                    configuration soap.wsdl_cache_enabled est activée, cette option
                                    détermine le type de mise en cache. L'une des constantes
                                    <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>, <info>WSDL_CACHE_MEMORY</info> ou
                                    <info>WSDL_CACHE_BOTH</info>.
                                    
                                    Deux types de cache sont disponibles : le cache en mémoire, qui
                                    met en cache le WSDL dans la mémoire du processus en cours, et
                                    le cache sur disque, qui met en cache le WSDL dans un fichier
                                    sur le disque partagé entre tous les processus. Le répertoire à
                                    utiliser pour le cache sur disque est déterminé par l'option de
                                    configuration soap.wsdl_cache_dir. Les deux caches ont la même
                                    durée de vie, déterminée par l'option de configuration
                                    soap.wsdl_cache_ttl. Le cache en mémoire a également un nombre
                                    maximum d'entrées déterminé par l'option de configuration
                                    soap.wsdl_cache_limit.
                                    
                                    Si non spécifié, l'option de configuration  soap.wsdl_cache sera
                                    utilisée.
                                    
                                    La valeur à utiliser dans l'en-tête HTTP <return>User-Agent</return> lors des
                                    requêtes.
                                    
                                    Peut également être définie via <strong>$stream_context</strong>.
                                    
                                    Si non spécifié, l'agent utilisateur sera <return>"PHP-SOAP/"</return> suivi de
                                    la valeur de <info>PHP_VERSION</info>.
                                    
                                    Un contexte de flux créé par <strong>stream_context_create()</strong>, qui permet
                                    de définir des options supplémentaires.
                                    
                                    Le contexte peut inclure des options de contexte socket, des
                                    options de contexte SSL, ainsi que certaines options de contexte
                                    HTTP sélectionnées : <return>content_type</return>, <return>header</return>, <return>max_redirects</return>,
                                    <return>protocol_version</return>, et <return>user_agent</return>.
                                    
                                    Notez que les en-têtes HTTP suivants sont générés
                                    automatiquement ou à partir d'autres options, et seront ignorés
                                    s'ils sont spécifiés dans l'option de contexte <return>'header'</return> : <return>host</return>,
                                    <return>connection</return>, <return>user-agent</return>, <return>content-length</return>, <return>content-type</return>, <return>cookie</return>,
                                    <return>authorization</return> et <return>proxy-authorization</return>.
                                    
                                    Un masque de bits pour activer une ou plusieurs des
                                    fonctionnalités suivantes : <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> Lors du
                                    décodage d'une réponse en tableau, le comportement par défaut
                                    consiste à détecter si un nom d'élément apparaît une seule fois
                                    ou plusieurs fois dans un élément parent particulier. Pour les
                                    éléments qui n'apparaissent qu'une fois, une propriété d'objet
                                    permet un accès direct au contenu ; pour les éléments qui
                                    apparaissent plus d'une fois, la propriété contient un tableau
                                    avec le contenu de chaque élément correspondant.  Si la
                                    fonctionnalité <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> est activée, les
                                    éléments qui n'apparaissent qu'une seule fois sont placés dans
                                    un tableau à un seul élément, de sorte que l'accès soit cohérent
                                    pour tous les éléments. Cela n'a d'effet que lors de
                                    l'utilisation d'un WSDL contenant un schéma pour la réponse.
                                    Consultez la section des examples pour une illustration.
                                    <info>SOAP_USE_XSI_ARRAY_TYPE</info> Lorsque l'option <return>use</return> option ou la
                                    propriété WSDL est définie sur <return>encoded</return>, force les tableaux à
                                    utiliser un type <return>SOAP-ENC:Array</return>, plutôt qu'un type spécifique au
                                    schéma. <info>SOAP_WAIT_ONE_WAY_CALLS</info> Attendre une réponse même si le
                                    WSDL indique une requête à sens unique.
                                    
                                    Lors du décodage d'une réponse en tableau, le comportement par
                                    défaut consiste à détecter si un nom d'élément apparaît une
                                    seule fois ou plusieurs fois dans un élément parent particulier.
                                    Pour les éléments qui n'apparaissent qu'une fois, une propriété
                                    d'objet permet un accès direct au contenu ; pour les éléments
                                    qui apparaissent plus d'une fois, la propriété contient un
                                    tableau avec le contenu de chaque élément correspondant.
                                    
                                    Si la fonctionnalité <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> est activée, les
                                    éléments qui n'apparaissent qu'une seule fois sont placés dans
                                    un tableau à un seul élément, de sorte que l'accès soit cohérent
                                    pour tous les éléments. Cela n'a d'effet que lors de
                                    l'utilisation d'un WSDL contenant un schéma pour la réponse.
                                    Consultez la section des examples pour une illustration.
                                    
                                    Lorsque l'option <return>use</return> option ou la propriété WSDL est définie sur
                                    <return>encoded</return>, force les tableaux à utiliser un type <return>SOAP-ENC:Array</return>,
                                    plutôt qu'un type spécifique au schéma.
                                    
                                    Attendre une réponse même si le WSDL indique une requête à sens
                                    unique.
                                    
                                    une valeur booléenne définissant si envoyer l'en-tête
                                    <return>Connection: Keep-Alive</return> ou <return>Connection: close</return>.
                                    
                                    Par défaut, c'est <info>true</info>
                                    
                                    Spécifie la version du protocole SSL ou TLS à utiliser avec les
                                    connexions HTTP sécurisées, au lieu de la négociation par
                                    défaut. Spécifier <info>SOAP_SSL_METHOD_SSLv2</info> ou <info>SOAP_SSL_METHOD_SSLv3</info>
                                    forcera l'utilisation de SSL 2 ou SSL 3, respectivement.
                                    Spécifier <info>SOAP_SSL_METHOD_SSLv23</info> n'a aucun effet ; cette
                                    constante n'existe que pour des raisons de compatibilité
                                    ascendante. À partir de PHP 7.2, spécifier <info>SOAP_SSL_METHOD_TLS</info>
                                    n'a également aucun effet ; dans les versions antérieures, cela
                                    forçait l'utilisation de TLS 1.0.
                                    
                                    Il est à noter que les versions SSL 2 et 3 sont considérées
                                    comme non sécurisées et peuvent ne pas être prises en charge par
                                    la bibliothèque OpenSSL installée.
                                    
                                    Cette option est obsolète à partir de PHP 8.1.0. Une alternative
                                    plus flexible, qui permet de spécifier des versions
                                    individuelles de TLS, consiste à utiliser l'option
                                    <strong>$contexte_de_flux</strong> avec le paramètre de contexte 'crypto_method'.
                                    Spécifier l'utilisation de TLS 1.3 uniquement [ 'crypto_method'
                                    => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]>
  <info></info>             <strong>$location</strong>            L'URL du serveur SOAP auquel envoyer la requête.
                                    
                                    Requis si le paramètre <strong>$wsdl</strong> n'est pas fourni. Si à la fois un
                                    paramètre <strong>$wsdl</strong> et l'option <return>location</return> sont fournis, l'option
                                    <return>location</return> remplacera toute location spécifiée dans le fichier
                                    WSDL.
  <info></info>             <strong>$uri</strong>                 L'espace de noms cible du service SOAP.
                                    
                                    Requis si le paramètre <strong>$wsdl</strong> n'est pas fourni; sinon ignoré.
  <info></info>             <strong>$style</strong>               Spécifie le style de liaison à utiliser pour ce client, en
                                    utilisant les constantes <info>SOAP_RPC</info> et <info>SOAP_DOCUMENT</info>. <info>SOAP_RPC</info>
                                    indique une liaison de style RPC, où le corps de la requête SOAP
                                    contient un encodage standard d'un appel de fonction.
                                    <info>SOAP_DOCUMENT</info> indique une liaison de style document, où le corps
                                    de la requête SOAP contient un document XML avec une
                                    signification définie par le service.
                                    
                                    Si le paramètre <strong>$wsdl</strong> est fourni, cette option est ignorée et le
                                    style est lu à partir du fichier WSDL.
                                    
                                    Si ni cette option ni le paramètre <strong>$wsdl</strong> ne sont fournis, le
                                    style RPC est utilisé.
  <info></info>             <strong>$use</strong>                 Spécifie le style d'encodage à utiliser pour ce client, en
                                    utilisant les constantes <info>SOAP_ENCODED</info> ou <info>SOAP_LITERAL</info>.
                                    <info>SOAP_ENCODED</info> indique un encodage utilisant les types définis
                                    dans la spécification SOAP. <info>SOAP_LITERAL</info> indique un encodage
                                    utilisant un schéma défini.
                                    
                                    Si le paramètre <strong>$wsdl</strong> est fourni, cette option est ignorée et
                                    l'encodage est lu à partir du fichier WSDL.
                                    
                                    Si cette option et le paramètre <strong>$wsdl</strong> ne sont pas fournis, le
                                    style "encoded" est utilisé.
  <info></info>             <strong>$soap_version</strong>        Spécifie la version du protocole SOAP à utiliser : <info>SOAP_1_1</info> pour
                                    SOAP 1.1, ou <info>SOAP_1_2</info> pour SOAP 1.2.
                                    
                                    Si omis, SOAP 1.1 est utilisé.
  <info></info>             <strong>$authentication</strong>      Spécifie la méthode d'authentification lors de l'utilisation de
                                    l'authentification HTTP dans les requêtes. La valeur peut être
                                    soit <info>SOAP_AUTHENTICATION_BASIC</info> ou <info>SOAP_AUTHENTICATION_DIGEST</info>.
                                    
                                    Si omis et que l'option <return>login</return> est fournie, l'authentification
                                    HTTP Basic est utilisée.
  <info></info>             <strong>$login</strong>               Nom d'utilisateur à utiliser avec l'authentification HTTP Basic
                                    ou HTTP Digest.
  <info></info>             <strong>$password</strong>            Mot de passe à utiliser avec l'authentification HTTP Basic ou
                                    HTTP Digest.
                                    
                                    À ne pas confondre avec <return>passphrase</return>, qui est utilisé avec
                                    l'authentification par certificat client HTTPS.
  <info></info>             <strong>$local_cert</strong>          Chemin vers un certificat client à utiliser avec
                                    l'authentification HTTPS. Il doit s'agir d'un fichier encodé en
                                    PEM contenant votre certificat et votre clé privée.
                                    
                                    Le fichier peut également inclure une chaîne d'émetteurs, qui
                                    doit venir après le certificat client.
                                    
                                    Peut également être défini via <strong>$stream_context</strong>, qui permet
                                    également de spécifier un fichier de clé privée distinct.
  <info></info>             <strong>$passphrase</strong>          Passphrase pour le certificat client spécifié dans l'option
                                    <return>local_cert</return>.
                                    
                                    À ne pas confondre avec <return>password</return>, qui est utilisé avec
                                    l'authentification HTTP Basic ou HTTP Digest.
                                    
                                    Peut également être défini via <strong>$stream_context</strong>.
  <info></info>             <strong>$proxy_host</strong>          Nom d'hôte à utiliser comme serveur mandataire pour les requêtes
                                    HTTP.
                                    
                                    L'option <return>proxy_port</return> doit également être spécifiée.
  <info></info>             <strong>$proxy_port</strong>          Port TCP à utiliser lors de la connexion au serveur mandataire
                                    spécifié dans <return>proxy_host</return>.
  <info></info>             <strong>$proxy_login</strong>         Nom d'utilisateur facultatif pour s'authentifier auprès du
                                    serveur mandataire spécifié dans <return>proxy_host</return>, en utilisant
                                    l'authentification HTTP Basic.
  <info></info>             <strong>$proxy_password</strong>      Mot de passe facultatif pour s'authentifier auprès du serveur
                                    mandataire spécifié dans <return>proxy_host</return>, en utilisant
                                    l'authentification HTTP Basic.
  <info></info>             <strong>$compression</strong>         Active la compression des requêtes et des réponses SOAP HTTP.
                                    
                                    La valeur doit être le résultat de l'opération OR binaire de
                                    trois parties : un <info>SOAP_COMPRESSION_ACCEPT</info> optionnel, pour
                                    envoyer l'en-tête "Accept-Encoding" ; soit <info>SOAP_COMPRESSION_GZIP</info>
                                    ou <info>SOAP_COMPRESSION_DEFLATE</info> pour indiquer l'algorithme de
                                    compression à utiliser ; et un nombre entre 1 et 9 pour indiquer
                                    le niveau de compression à utiliser dans la requête. Par
                                    exemple, pour activer la compression gzip bidirectionnelle avec
                                    le niveau de compression maximal, utilisez
                                    <return>SOAP_COMPRESSION_ACCEPT | SOAP_COMPRESSION_GZIP | 9</return>.
  <info></info>             <strong>$encoding</strong>            Définit l'encodage de caractères interne. Les requêtes sont
                                    toujours envoyées en UTF-8 et converties depuis et vers cet
                                    encodage.
  <info></info>             <strong>$trace</strong>               Capture les informations de requête et de réponse, qui peuvent
                                    ensuite être consultées à l'aide des méthodes
                                    SoapClient::__getLastRequest,
                                    SoapClient::__getLastRequestHeaders,
                                    SoapClient::__getLastResponse, et
                                    SoapClient::__getLastResponseHeaders.
                                    
                                    Si omis, la valeur par défaut est <info>false</info>
  <info></info>             <strong>$classmap</strong>            Utilisé pour associer les types définis dans le WSDL aux classes
                                    PHP. Il doit être spécifié sous la forme d'un tableau associatif
                                    avec les noms de types du WSDL en tant que clés et les noms de
                                    classes PHP en tant que valeurs. Notez que les noms de types
                                    d'un élément ne correspondent pas nécessairement au nom de
                                    l'élément (balise).
                                    
                                    Les noms de classe fournis doivent toujours être entièrement
                                    qualifiés avec tous les espaces de noms, et ne jamais commencer
                                    par un <return>\</return>. La forme correcte peut être générée en utilisant
                                    ::class.
                                    
                                    Notez que lors de la création d'une classe, le constructeur ne
                                    sera pas appelé, mais les méthodes magiques __set() et __get()
                                    pour les propriétés individuelles le seront.
  <info></info>             <strong>$typemap</strong>             Utilisé pour définir des correspondances de types à l'aide de
                                    fonctions de rappel définies par l'utilisateur. Chaque
                                    correspondance de type doit être un tableau avec les clés
                                    <return>type_name</return> (une <info>chaîne de caractères</info> spécifiant le type d'élément
                                    XML), <return>type_ns</return> (une <info>chaîne de caractères</info> contenant l'URI de
                                    l'espace de noms), <return>from_xml</return> (un <info>appelable</info> acceptant un paramètre
                                    de type chaîne de caractères et renvoyant un objet) et <return>to_xml</return>
                                    (un <info>appelable</info> acceptant un paramètre de type objet et renvoyant
                                    une chaîne de caractères).
  <info></info>             <strong>$exceptions</strong>          Définit si les erreurs génèrent des exceptions de type
                                    <class>SoapFault</class>.
                                    
                                    Par défaut, c'est <info>true</info>
  <info></info>             <strong>$connection_timeout</strong>  Définit un délai d'attente en secondes pour la connexion au
                                    service SOAP. Cette option ne définit pas un délai d'attente
                                    pour les services ayant une réponse lente. Pour limiter le temps
                                    d'attente des appels, l'option de configuration
                                    default_socket_timeout est disponible.
  <info></info>             <strong>$cache_wsdl</strong>          Si le paramètre <strong>$wsdl</strong> est spécifié et que l'option de
                                    configuration soap.wsdl_cache_enabled est activée, cette option
                                    détermine le type de mise en cache. L'une des constantes
                                    <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>, <info>WSDL_CACHE_MEMORY</info> ou
                                    <info>WSDL_CACHE_BOTH</info>.
                                    
                                    Deux types de cache sont disponibles : le cache en mémoire, qui
                                    met en cache le WSDL dans la mémoire du processus en cours, et
                                    le cache sur disque, qui met en cache le WSDL dans un fichier
                                    sur le disque partagé entre tous les processus. Le répertoire à
                                    utiliser pour le cache sur disque est déterminé par l'option de
                                    configuration soap.wsdl_cache_dir. Les deux caches ont la même
                                    durée de vie, déterminée par l'option de configuration
                                    soap.wsdl_cache_ttl. Le cache en mémoire a également un nombre
                                    maximum d'entrées déterminé par l'option de configuration
                                    soap.wsdl_cache_limit.
                                    
                                    Si non spécifié, l'option de configuration  soap.wsdl_cache sera
                                    utilisée.
  <info></info>             <strong>$user_agent</strong>          La valeur à utiliser dans l'en-tête HTTP <return>User-Agent</return> lors des
                                    requêtes.
                                    
                                    Peut également être définie via <strong>$stream_context</strong>.
                                    
                                    Si non spécifié, l'agent utilisateur sera <return>"PHP-SOAP/"</return> suivi de
                                    la valeur de <info>PHP_VERSION</info>.
  <info></info>             <strong>$stream_context</strong>      Un contexte de flux créé par <strong>stream_context_create()</strong>, qui permet
                                    de définir des options supplémentaires.
                                    
                                    Le contexte peut inclure des options de contexte socket, des
                                    options de contexte SSL, ainsi que certaines options de contexte
                                    HTTP sélectionnées : <return>content_type</return>, <return>header</return>, <return>max_redirects</return>,
                                    <return>protocol_version</return>, et <return>user_agent</return>.
                                    
                                    Notez que les en-têtes HTTP suivants sont générés
                                    automatiquement ou à partir d'autres options, et seront ignorés
                                    s'ils sont spécifiés dans l'option de contexte <return>'header'</return> : <return>host</return>,
                                    <return>connection</return>, <return>user-agent</return>, <return>content-length</return>, <return>content-type</return>, <return>cookie</return>,
                                    <return>authorization</return> et <return>proxy-authorization</return>.
  <info></info>             <strong>$features</strong>            Un masque de bits pour activer une ou plusieurs des
                                    fonctionnalités suivantes : <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> Lors du
                                    décodage d'une réponse en tableau, le comportement par défaut
                                    consiste à détecter si un nom d'élément apparaît une seule fois
                                    ou plusieurs fois dans un élément parent particulier. Pour les
                                    éléments qui n'apparaissent qu'une fois, une propriété d'objet
                                    permet un accès direct au contenu ; pour les éléments qui
                                    apparaissent plus d'une fois, la propriété contient un tableau
                                    avec le contenu de chaque élément correspondant.  Si la
                                    fonctionnalité <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> est activée, les
                                    éléments qui n'apparaissent qu'une seule fois sont placés dans
                                    un tableau à un seul élément, de sorte que l'accès soit cohérent
                                    pour tous les éléments. Cela n'a d'effet que lors de
                                    l'utilisation d'un WSDL contenant un schéma pour la réponse.
                                    Consultez la section des examples pour une illustration.
                                    <info>SOAP_USE_XSI_ARRAY_TYPE</info> Lorsque l'option <return>use</return> option ou la
                                    propriété WSDL est définie sur <return>encoded</return>, force les tableaux à
                                    utiliser un type <return>SOAP-ENC:Array</return>, plutôt qu'un type spécifique au
                                    schéma. <info>SOAP_WAIT_ONE_WAY_CALLS</info> Attendre une réponse même si le
                                    WSDL indique une requête à sens unique.
                                    
                                    Lors du décodage d'une réponse en tableau, le comportement par
                                    défaut consiste à détecter si un nom d'élément apparaît une
                                    seule fois ou plusieurs fois dans un élément parent particulier.
                                    Pour les éléments qui n'apparaissent qu'une fois, une propriété
                                    d'objet permet un accès direct au contenu ; pour les éléments
                                    qui apparaissent plus d'une fois, la propriété contient un
                                    tableau avec le contenu de chaque élément correspondant.
                                    
                                    Si la fonctionnalité <info>SOAP_SINGLE_ELEMENT_ARRAYS</info> est activée, les
                                    éléments qui n'apparaissent qu'une seule fois sont placés dans
                                    un tableau à un seul élément, de sorte que l'accès soit cohérent
                                    pour tous les éléments. Cela n'a d'effet que lors de
                                    l'utilisation d'un WSDL contenant un schéma pour la réponse.
                                    Consultez la section des examples pour une illustration.
                                    
                                    Lorsque l'option <return>use</return> option ou la propriété WSDL est définie sur
                                    <return>encoded</return>, force les tableaux à utiliser un type <return>SOAP-ENC:Array</return>,
                                    plutôt qu'un type spécifique au schéma.
                                    
                                    Attendre une réponse même si le WSDL indique une requête à sens
                                    unique.
  <info></info>             <strong>$keep_alive</strong>          une valeur booléenne définissant si envoyer l'en-tête
                                    <return>Connection: Keep-Alive</return> ou <return>Connection: close</return>.
                                    
                                    Par défaut, c'est <info>true</info>
  <info></info>             <strong>$ssl_method</strong>          Spécifie la version du protocole SSL ou TLS à utiliser avec les
                                    connexions HTTP sécurisées, au lieu de la négociation par
                                    défaut. Spécifier <info>SOAP_SSL_METHOD_SSLv2</info> ou <info>SOAP_SSL_METHOD_SSLv3</info>
                                    forcera l'utilisation de SSL 2 ou SSL 3, respectivement.
                                    Spécifier <info>SOAP_SSL_METHOD_SSLv23</info> n'a aucun effet ; cette
                                    constante n'existe que pour des raisons de compatibilité
                                    ascendante. À partir de PHP 7.2, spécifier <info>SOAP_SSL_METHOD_TLS</info>
                                    n'a également aucun effet ; dans les versions antérieures, cela
                                    forçait l'utilisation de TLS 1.0.
                                    
                                    Il est à noter que les versions SSL 2 et 3 sont considérées
                                    comme non sécurisées et peuvent ne pas être prises en charge par
                                    la bibliothèque OpenSSL installée.
                                    
                                    Cette option est obsolète à partir de PHP 8.1.0. Une alternative
                                    plus flexible, qui permet de spécifier des versions
                                    individuelles de TLS, consiste à utiliser l'option
                                    <strong>$contexte_de_flux</strong> avec le paramètre de contexte 'crypto_method'.
                                    Spécifier l'utilisation de TLS 1.3 uniquement [ 'crypto_method'
                                    => STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT ]
                                    ]);
                                    $client = new SoapClient("some.wsdl", ['context' => $context]);
                                    ]]>


id: SoapClient::__doRequest
type: function
doc:
<comment>Description:</comment>
  Exécute une requête SOAP
  
  Exécute une requête SOAP.
  
  Cette méthode peut être écrasée dans les sous-classes pour implémenter différents transporteurs,
  effectuer des opérations XML supplémentaires ou toute autre chose.

<comment>Param:</comment>
  <info>string</info>  <strong>$request</strong>   La requête SOAP en XML.
  <info>string</info>  <strong>$location</strong>  L'URL de la requête.
  <info>string</info>  <strong>$action</strong>    L'action SOAP.
  <info>int</info>     <strong>$version</strong>   La version SOAP.
  <info>bool</info>    <strong>$oneWay</strong>    Si <strong>$oneWay</strong> prend la valeur de <info>true</info>, cette méthode ne retourne rien. Utilisez
                     cette valeur quand une réponse n'est pas attendue.

<comment>Return:</comment>
  <info>string|null</info>  La réponse SOAP en XML.


id: SoapClient::__getCookies
type: function
doc:
<comment>Description:</comment>
  Get list of cookies
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: SoapClient::__getFunctions
type: function
doc:
<comment>Description:</comment>
  Retourne une liste de fonctions SOAP publiées
  
  <strong>SoapClient::__getFunctions()</strong> retourne un tableau de  fonctions SOAP publiées décrites dans le
  WSDL.
  
  Cette fonction n'est disponible qu'en mode WSDL.

<comment>Return:</comment>
  <info>array|null</info>  Le <info>array</info> de fonctions SOAP avec le type de retour, le nom de la fonction et les types
              des paramètres qu'accepte celle-ci.

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


id: SoapClient::__getLastRequest
type: function
doc:
<comment>Description:</comment>
  Retourne la dernière requête SOAP
  
  Retourne le code XML de la dernière requête SOAP émise.
  
  Cette méthode fonctionne uniquement si l'objet <class>SoapClient</class> a été créé avec l'option <return>trace</return> configuré
  à <info>true</info>.

<comment>Return:</comment>
  <info>string|null</info>  La dernière requête SOAP, sous forme de chaîne de code XML.

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastResponse
   * SoapClient::__getLastResponseHeaders


id: SoapClient::__getLastRequestHeaders
type: function
doc:
<comment>Description:</comment>
  Retourne les en-têtes de la dernière requête SOAP
  
  Retourne les en-têtes de la dernière requête SOAP
  
  Cette fonction n'est disponible que si l'objet  <class>SoapClient</class> a été créé avec l'option  <return>trace</return> à <info>true</info>

<comment>Return:</comment>
  <info>string|null</info>  Les dernieres entêtes SOAP.

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getLastResponse
type: function
doc:
<comment>Description:</comment>
  Retourne la dernière réponse SOAP
  
  Retourne le code XML de la dernière réponse SOAP.
  
  Cette fonction n'est disponible que si l'objet  <class>SoapClient</class> a été créé avec l'option  <return>trace</return> à <info>true</info>

<comment>Return:</comment>
  <info>string|null</info>  La dernière réponse SOAP, sous forme de chaîne XML.

<comment>See Also:</comment>
   * SoapClient::__getLastResponseHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastRequestHeaders


id: SoapClient::__getLastResponseHeaders
type: function
doc:
<comment>Description:</comment>
  Retourne les en-têtes de la dernière réponse SOAP
  
  Retourne les entêtes de la dernière réponse SOAP.
  
  Cette fonction n'est disponible que si l'objet  <class>SoapClient</class> a été créé avec l'option  <return>trace</return> à <info>true</info>

<comment>Return:</comment>
  <info>string|null</info>  Les en-têtes de la dernière réponse SOAP.

<comment>See Also:</comment>
   * SoapClient::__getLastRequestHeaders
   * SoapClient::__getLastRequest
   * SoapClient::__getLastResponse


id: SoapClient::__getTypes
type: function
doc:
<comment>Description:</comment>
  Retourne une liste des types SOAP
  
  <strong>SoapClient::__getTypes()</strong> retourne la liste des types SOAP décrits dans le fichier WSDL  du service
  Web courant.
  
  Cette fonction n'est disponible qu'en mode WSDL.

<comment>Return:</comment>
  <info>array|null</info>  Un <info>array</info> de types SOAP détaillant toutes les structures et les types

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


id: SoapClient::__setCookie
type: function
doc:
<comment>Description:</comment>
  Définit un cookie pour les requêtes SOAP
  
  Définit le cookie qui sera envoyé avec la requête SOAP.
  
  L'appel à cette méthode affectera tous les appels suivants aux méthodes <class>SoapClient</class>.

<comment>Param:</comment>
  <info>string</info>       <strong>$name</strong>   Le nom du cookie.
  <info>string|null</info>  <strong>$value</strong>  La valeur du cookie. Si non spécifié, le cookie sera effacé.

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


id: SoapClient::__setLocation
type: function
doc:
<comment>Description:</comment>
  Configure l'URL du service Web à utiliser
  
  Configure l'URL cible, à qui seront envoyés les requêtes SOAP. Ce revient à spécifier l'option
  <return>location</return> lors de  la construction du client <class>SoapClient</class>.
  
  Cette méthode est optionnelle. <class>SoapClient</class> utilise  l'URL indiquée dans le fichier WDSL par défaut.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$location</strong>  La nouvelle URL.

<comment>Return:</comment>
  <info>string|null</info>  L'ancienne URL.

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


id: SoapClient::__setSoapHeaders
type: function
doc:
<comment>Description:</comment>
  Ajoute un en-tête SOAP pour les requêtes suivantes
  
  Définit un en-tête à utiliser dans les requêtes SOAP.
  
  Cette méthode va remplacer la valeur précédente.

<comment>Param:</comment>
  <info>SoapHeader|array|null</info>  <strong>$headers</strong>  L'en-tête à configurer. Il peut être un objet <class>SoapHeader</class> ou un
                                   tableau d'objetcs <class>SoapHeader</class>. Si ce paramètre n'est pas spécifié
                                   ou défini à <info>null</info>, les en-têtes seront supprimés.

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


id: SoapClient::__soapCall
type: function
doc:
<comment>Description:</comment>
  Appelle une fonction SOAP
  
  Ceci est une fonction bas niveau de l'API qui est utilisée pour faire des appels SOAP.
  Habituellement, en mode WSDL, vous pouvez appeler simplement les fonctions SOAP comme des méthodes
  <class>SoapClient</class>. Cette méthode est pratique en mode non-WSDL lorsque <return>soapaction</return> est inconnu, <return>uri</return> est
  différente de la valeur par défaut ou lors de l'envoi et/ou de la réception d'en-têtes SOAP.
  
  En cas d'erreur, un appel à une fonction SOAP peut causer un lancement d'exception par PHP ou
  retourner un objet <class>SoapFault</class> si les exceptions sont désactivées. Pour vérifier si l'appel à cette
  fonction n'arrive pas à attraper les exceptions <class>SoapFault</class>,  vérifiez le résultat avec la fonction
  <strong>is_soap_fault()</strong>.

<comment>Param:</comment>
  <info>string</info>                 <strong>$name</strong>           Le nom de la fonction SOAP à appeler.
  <info>array</info>                  <strong>$args</strong>           Un tableau d'arguments à passer à la fonction. Cela peut
                                         être un tableau associatif ou ordonné. Notez que la plupart
                                         des serveurs SOAP nécessite des noms de paramètres, auquel
                                         cas, ce doit être un tableau associatif.
  <info>array|null</info>             <strong>$options</strong>        Un tableau associatif d'options à passer au client.
                                         
                                         Une option de <return>location</return> pour le service Web distant.
                                         
                                         Une option <return>uri</return> avec l'espace de noms cible du service SOAP.
                                         
                                         L'option <return>soapaction</return> est l'action à appeler.
  <info>SoapHeader|array|null</info>  <strong>$inputHeaders</strong>   Un tableau d'entêtes à envoyer avec la requête SOAP.
  <info>array</info>                  <strong>$outputHeaders</strong>  Si fourni, ce tableau sera rempli avec les entêtes de  la
                                         réponse SOAP retournée.

<comment>Return:</comment>
  <info>mixed</info>  Les fonctions SOAP retournent une ou plusieurs valeurs. Si une seule valeur est retournée
         par la fonction SOAP, la valeur retournée de <return>__soapCall</return> sera une valeur simple (e.g. un
         entier, une chaîne de caractères, etc.). Si plusieurs valeurs sont retournées, <return>__soapCall</return>
         retournera un tableau associatif contenant les noms des paramètres affichés.
         
         En cas d'erreur, si l'objet <class>SoapClient</class> a été construit avec l'option <return>exceptions</return> qui valait
         <info>false</info>, un objet  <class>SoapFault</class> sera retourné.

<comment>See Also:</comment>
   * SoapClient::__construct
   * SoapParam::__construct
   * SoapVar::__construct
   * SoapHeader::__construct
   * SoapFault::__construct
   * <strong>is_soap_fault()</strong>


id: SoapFault::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur SoapFault
  
  <class>SoapFault</class> sert à envoyer des erreurs SOAP depuis le PHP.<strong>$faultcode</strong>, <strong>$faultstring</strong>, <strong>$faultactor</strong> et
  <strong>$detail</strong> sont les éléments standards SOAP.

<comment>Param:</comment>
  <info></info>  <strong>$faultcode</strong>    Le code erreur de <class>SoapFault</class>.
  <info></info>  <strong>$faultstring</strong>  Le message d'erreur de <class>SoapFault</class>.
  <info></info>  <strong>$faultactor</strong>   Une chaîne identifiant l'acteur qui a causé l'erreur.
  <info></info>  <strong>$detail</strong>       
  <info></info>  <strong>$faultname</strong>    Peut être utilisé pour sélectionner l'encodage qui convient depuis WSDL.
  <info></info>  <strong>$headerfault</strong>  Peut être utilisé durant la gestion de l'entête SOAP pour rapporter une erreur
                  dans l'en-tête de réponse.

<comment>See Also:</comment>
   * SoapServer::fault
   * <strong>is_soap_fault()</strong>


id: SoapFault::__toString
type: function
doc:
<comment>Description:</comment>
  Produit une représentation chaîne d'un objet SoapFault
  
  Retourne une représentation en chaîne de l'objet <class>SoapFault</class>.

<comment>Return:</comment>
  <info>string</info>  Une chaîne décrivant l'objet <class>SoapFault</class>.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$namespace</strong>       L'espace de noms de l'élément d'entête SOAP.
  <info>string</info>  <strong>$name</strong>            Le nom de l'élément d'entête SOAP.
  <info>mixed</info>   <strong>$data</strong>            Un contenu de l'en-tête SOAP. Il peut être une valeur PHP ou un objet
                           <class>SoapVar</class>.
  <info></info>        <strong>$mustUnderstand</strong>  Valeur de l'attribut <return>mustUnderstand</return> de l'élément d'entête SOAP.
  <info>string</info>  <strong>$actor</strong>           Valeur de l'attribut <return>actor</return> de l'élément d'entête SOAP.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::__construct
   * SoapParam::__construct
   * SoapServer::addSoapHeader


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

<comment>Param:</comment>
  <info>mixed</info>   <strong>$data</strong>  Les données à passer ou à retourner. Vous pouvez passer ce paramètre directement en
                 tant qu'une valeur PHP, mais dans ce cas, il sera nommé <return>paramN</return> et le service SOAP
                 ne le comprendra pas.
  <info>string</info>  <strong>$name</strong>  Le nom du paramètre.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapVar::__construct


id: SoapServer
type: class
doc:
<comment>Description:</comment>
  La classe <class>SoapServer</class> fournit un serveur pour les protocoles SOAP 1.1 et SOAP 1.2. Il peut être
  utilisé avec ou sans le service de description WSDL.


id: SoapServer::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur SoapServer
  
  Ce constructeur permet la création d'objets <class>SoapServer</class> en mode WSDL ou non-WSDL.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$wsdl</strong>     Pour utiliser le mode WSDL, il faut définir l'URI du fichier WSDL dans ce
                         paramètre. Avec les autres situations, il faut définir ce paramètre à <info>null</info>
                         et définir l'option <return>uri</return>.
  <info>array</info>        <strong>$options</strong>  Permet de définir une version SOAP par défaut (<return>soap_version</return>), un jeu de
                         caractères d'encodage interne (<return>encoding</return>) et un URI acteur (<return>actor</return>).
                         
                         L'option <return>classmap</return> peut être utilisée pour lier quelques types WSDL à des
                         classes PHP. Cette option doit être un tableau avec les types WSDL en tant
                         que clés et les noms des classes PHP en tant que valeurs.
                         
                         L'option <return>typemap</return> est un tableau dont les clés sont <return>type_name</return>, <return>type_ns</return> (URI
                         de l'espace de noms), <return>from_xml</return> (fonction de rappel acceptant un paramètre
                         de type chaîne de caractères) et <return>to_xml</return> (fonction de rappel acceptant un
                         paramètre de type objet).
                         
                         L'option <return>cache_wsdl</return> prend une des valeurs <info>WSDL_CACHE_NONE</info>, <info>WSDL_CACHE_DISK</info>,
                         <info>WSDL_CACHE_MEMORY</info> ou <info>WSDL_CACHE_BOTH</info>.
                         
                         La dernière option est <return>features</return> qui peut être défini à
                         <info>SOAP_WAIT_ONE_WAY_CALLS</info>, <info>SOAP_SINGLE_ELEMENT_ARRAYS</info>,
                         <info>SOAP_USE_XSI_ARRAY_TYPE</info>.
                         
                         L'option <return>send_errors</return> peut être défini à <info>false</info> pour envoyer un message
                         d'erreur générique ("Internal error") au lieu du message d'erreur
                         spécifique.

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


id: SoapServer::addFunction
type: function
doc:
<comment>Description:</comment>
  Ajoute une ou plusieurs fonctions qui vont gérer les requêtes SOAP
  
  Exporte une ou plusieurs fonctions pour les clients distants.

<comment>Param:</comment>
  <info>array|string|int</info>  <strong>$functions</strong>  Pour exporter une seule fonction, il faut passer son nom dans ce
                                paramètre en tant que chaîne de caractères.
                                
                                Pour exporter plusieurs fonctions, il faut utiliser un tableau de
                                noms de fonctions.
                                
                                Pour exporter toutes les fonctions, il faut utiliser la constante
                                spéciale <info>SOAP_FUNCTIONS_ALL</info>.
                                
                                <strong>$functions</strong> doit recevoir tous les arguments d'entrée dans le même
                                ordre que celui défini dans le fichier WSDL (il ne doit recevoir
                                aucun paramètre de sortie en tant qu'argument) et retourne une ou
                                plusieurs valeurs. Pour retourner plusieurs valeurs, il doit
                                retourner un tableau contenant le nom des paramètres de sortie.

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

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::setClass


id: SoapServer::addSoapHeader
type: function
doc:
<comment>Description:</comment>
  Ajoute un en-tête SOAP à une réponse
  
  Ajoute un en-tête SOAP à la réponse courante.

<comment>Param:</comment>
  <info>SoapHeader</info>  <strong>$header</strong>  L'en-tête à renvoyer.

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


id: SoapServer::fault
type: function
doc:
<comment>Description:</comment>
  Emet une erreur SoapServer
  
  Envoie une réponse au client de la requête courante, avec un message d'erreur.
  
  Cela n'est possible que durant l'exécution de la requête.

<comment>Param:</comment>
  <info>string</info>  <strong>$code</strong>     Le code d'erreur à retourner.
  <info>string</info>  <strong>$string</strong>   Une description de l'erreur.
  <info>string</info>  <strong>$actor</strong>    Une chaîne identifiant l'acteur en cause.
  <info>mixed</info>   <strong>$details</strong>  Plus de détails sur la faute.
  <info>string</info>  <strong>$name</strong>     Le nom de l'erreur. Cela peut être utilisé pour sélectionner un nom dans un
                    fichier WSDL.

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

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


id: SoapServer::getFunctions
type: function
doc:
<comment>Description:</comment>
  Retourne la liste des fonctions définies
  
  <strong>SoapServer::getFunctions()</strong> retourne la liste  de toutes les fonctions ajoutées à l'objet serveur
  <class>SoapServer</class>. Elle retourne la liste de toutes les fonctions ajoutées à l'aide des méthodes
  <strong>SoapServer::addFunction()</strong> et <strong>SoapServer::setClass()</strong>.

<comment>Return:</comment>
  <info>array</info>  Un tableau de toutes les fonctions.

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::addFunction
   * SoapServer::setClass


id: SoapServer::handle
type: function
doc:
<comment>Description:</comment>
  Traite une requête SOAP
  
  Effectue une requête SOAP, appelle les fonctions nécessaires et envoie une réponse en retour.

<comment>Param:</comment>
  <info>string|null</info>  <strong>$request</strong>  La requête SOAP. Si cet argument est omis, la requête est supposée être
                         dans les données POST brûtes de la requête HTTP.

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

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


id: SoapServer::setClass
type: function
doc:
<comment>Description:</comment>
  Configure la classe qui sera utilisée pour gérer les requêtes SOAP
  
  Exporte toute les méthodes de la classe spécifiée.
  
  <strong>SoapServer::setClass()</strong> configure une classe qui servira de gestionnaire aux requêtes SOAP. L'objet
  pourra alors être rendu persistant à travers les requêtes pour une session PHP, avec la méthode
  <strong>SoapServer::setPersistence()</strong>.

<comment>Param:</comment>
  <info>string</info>  <strong>$class</strong>  Le nom de la classe exportée.
  <info>mixed</info>   <strong>$args</strong>   Ces paramètres optionnels seront passé par défaut au  constructeur de la classe,
                  durant la phase de création de l'objet.

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

<comment>See Also:</comment>
   * SoapServer::__construct
   * SoapServer::addFunction
   * SoapServer::setPersistence


id: SoapServer::setObject
type: function
doc:
<comment>Description:</comment>
  Configure l'objet qui sera utilisé pour gérer les requêtes SOAP
  
  <strong>SoapServer::setObject()</strong> configure un objet qui servira de gestionnaire aux requêtes SOAP, plutôt
  qu'une simple classe, comme avec <strong>SoapServer::setClass()</strong>.

<comment>Param:</comment>
  <info>object</info>  <strong>$object</strong>  L'objet qui va gérer les requêtes.

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

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


id: SoapServer::setPersistence
type: function
doc:
<comment>Description:</comment>
  Active le mode persistant de SoapServer
  
  Cette fonction permet de changer la persistance d'un objet SoapServer entre les requêtes. Elle
  permet de sauvegarder les données entre les requêtes, au moyen des sessions PHP. Cette fonction
  n'a d'effet qu'après avoir exporté la liste des fonctions au moyen de SoapServer::setClass.
  
  La constante de persistence <info>SOAP_PERSISTENCE_SESSION</info>  rend uniquement les objets de la classe
  donnée persistants, mais non pas les données statiques. Dans ce cas, $this-&gt;bar  au lieu de
  self::$bar.
  
  <info>SOAP_PERSISTENCE_SESSION</info> serialise les données de l'objet entre les requêtes. Dans le cas des
  ressources, (par exemple <class>PDO</class>), __wakeup() et __sleep() devraient être utilisées.

<comment>Param:</comment>
  <info>int</info>  <strong>$mode</strong>  Une des constantes suivantes :
              
              <info>SOAP_PERSISTENCE_REQUEST</info> - Les données de SoapServer ne sont pas persistantes entre
              les requêtes. C'est le comportement par défaut de tout objet SoapServer après appel à
              setClass().
              
              <info>SOAP_PERSISTENCE_SESSION</info> - Les données de SoapServer persistent entre les requêtes.
              Ceci est réalisé en sérialisant les données de la classe SoapServer dans
              $_SESSION['_bogus_session_name'], et ainsi <strong>session_start()</strong> doit être appelée avant de
              passer sous ce mode de persistance.

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

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


id: SoapVar
type: class
doc:
<comment>Description:</comment>
  Une classe représentant une variable ou un objet qui utilise des services SOAP.


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

<comment>Param:</comment>
  <info>mixed</info>     <strong>$data</strong>            Les données à passer ou à retourner.
  <info>int|null</info>  <strong>$encoding</strong>        L'ID d'encodage, une des constantes <return>XSD_...</return>.
  <info></info>          <strong>$type_name</strong>       Le nom du type.
  <info></info>          <strong>$type_namespace</strong>  Le type de l'espace de noms.
  <info></info>          <strong>$node_name</strong>       Le nom du nœud XML.
  <info></info>          <strong>$node_namespace</strong>  L'espace de noms du nœud XML.

<comment>See Also:</comment>
   * SoapClient::__soapCall
   * SoapParam::__construct


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


id: SolrClient
type: class
doc:
<comment>Description:</comment>
  Utilisée pour envoyer des requêtes au serveur Solr. Actuellement, le clonage et la sérialisation
  des instances SolrClient ne sont pas supportés.


id: SolrClient::DEFAULT_SYSTEM_SERVLET
type: constant
doc:
<comment>Description:</comment>
  Ceci est la valeur initiale pour le servlet système utilisé pour obtenir les informations du
  serveur Solr.


id: SolrClient::DEFAULT_TERMS_SERVLET
type: constant
doc:
<comment>Description:</comment>
  Ceci est la valeur initiale pour le servlet de termes utilisé pour le TermsComponent.


id: SolrClient::SYSTEM_SERVLET_TYPE
type: constant
doc:
<comment>Description:</comment>
  Utilisé lors de la récupération des informations systèmes depuis le servlet système.


id: SolrClient::__construct
type: function
doc:
<comment>Description:</comment>
  Constructeur de l'objet SolrClient
  
  Constructeur de l'objet SolrClient.

<comment>Param:</comment>
  <info>array</info>  <strong>$clientOptions</strong>  Tableau contenant les clés suivantes :
                         
                         

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


id: SolrClient::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructeur pour SolrClient
  
  Destructeur.

<comment>Return:</comment>
  <info>unknown</info>  Destructeur pour SolrClient.

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


id: SolrClient::addDocument
type: function
doc:
<comment>Description:</comment>
  Ajoute un document à l'index
  
  Cette méthode ajoute un document à l'index.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$doc</strong>           L'instance SolrInputDocument.
  <info>bool</info>               <strong>$overwrite</strong>     Si l'on doit ou non écraser un document existant. Si vaut <info>false</info>,
                                    il sera dupliqué (plusieurs documents avec le même ID).
                                    
                                    PECL Solr
                                    \< 2.0 $allowDups était utilisé à la place de $overwrite ; il s'agit de la même fonctionnalité, mais avec une valeur opposée.
                                    
                                    $allowDups = false est identique à $overwrite = true
  <info>int</info>                <strong>$commitWithin</strong>  Nombre de millisecondes après lequel le document doit être
                                    valié. Disponible depuis Solr 1.4. Par défaut, vaut 0
                                    (désactivé).
                                    
                                    Lorsque cette valeur est spécifiée, elle laisse le contrôle à
                                    Solr sur le moment où la validation doit être réalisée,
                                    permettant ainsi d'optimiser le nombre de validations, et donc,
                                    de mieux contrôler les eigences de latence des mises à jour ;
                                    Solr va automatiquement réaliser une validation lorsque le plus
                                    vieille ajout du buffer est atteint.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Retourne un objet <info>SolrUpdateResponse</info> et lance une exception si une erreur
                      survient.

<comment>See Also:</comment>
   * SolrClient::addDocuments
   * SolrClient::commit


id: SolrClient::addDocuments
type: function
doc:
<comment>Description:</comment>
  Ajoute une collection d'instances SolrInputDocument à l'index
  
  Ajoute une collection de documents à l'index.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs</strong>          Un tableau contenant la collection d'instances SolrInputDocument. Ce tableau
                        doit être une variable réelle.
  <info>bool</info>   <strong>$overwrite</strong>     Si l'on doit écraser les documents ou non. Si vaut <info>false</info>, les documents
                        seront dupliqués (plusieurs documents avec le même ID).
                        
                        PECL Solr
                        \< 2.0 $allowDups était utilisé au lieu de $overwrite, qui remplissait exactement la même fonctionnalité, mais à l'opposé.
                        
                        $allowDups = false est identique à $overwrite = true
  <info>int</info>    <strong>$commitWithin</strong>  Nombre de millisecondes d'attente avant de valider automatiquement ce
                        document. Disponible depuis Solr 1.4. Par défaut, vaut 0, ce qui signifie
                        que ce mécanisme est désactivé.
                        
                        Lorsque cette valeur est spécifiée, le contrôle du moment de la validation
                        est laissé à Solr, cherchant à optimiser le nombre de validations à son
                        minimum, tout en gardant une exigence forte concernant la latence des mises
                        à jour, et Solr fera automatiquement une validation lorsque le plus vielle
                        ajout du buffer est atteint.

<comment>Return:</comment>
  <info>void</info>  Retourne un objet <info>SolrUpdateResponse</info> en cas de succès, et lance une exception si une erreur
        survient.

<comment>See Also:</comment>
   * SolrClient::addDocument
   * SolrClient::commit


id: SolrClient::commit
type: function
doc:
<comment>Description:</comment>
  Commit tous les ajouts/modifications effectués sur l'index
  
  Commit tous les ajouts/modifications effectués sur l'index.

<comment>Param:</comment>
  <info>bool</info>  <strong>$softCommit</strong>      Va rafraîchir la vue de l'index d'une façon plus performante, mais sans
                         aucune garantie d'être sur le disque. (Solr4.0+)
                         
                         Un commit "soft" est plus rapide sachant qu'il ne modifie que l'index, et
                         ne synchronise pas les fichiers d'index, ni n'écrit de nouveaux
                         descripteurs d'index. Si le JVM crash ou s'il y a un perte d'énergie, les
                         modificiations qui sont survenues après le dernier commit "hard" seront
                         perdues. Les collections de recherche, qui ont des besoins proches du temps
                         réel (qui nécessitent donc que les modifications soient rapidement
                         visibles) doivent avoir des commit soft régulièrement, et moins de commit
                         hard.
  <info>bool</info>  <strong>$waitSearcher</strong>    Attend jusqu'à ce qu'un nouvel objet de recherche soit ouvert et enregistré
                         comme objet de recherche principal, rendant visible les modifications.
  <info>bool</info>  <strong>$expungeDeletes</strong>  Supprime définitivement les effacements. (Solr1.4+)

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Retourne un objet <class>SolrUpdateResponse</class> en cas de succès, et lance une exception
                      si une erreur survient.

<comment>See Also:</comment>
   * SolrClient::optimize
   * SolrClient::rollback


id: SolrClient::deleteById
type: function
doc:
<comment>Description:</comment>
  Effacement par Id
  
  Efface un document en spécifiant son ID. L'ID est la valeur du champ uniqueKey déclaré dans le
  schéma.

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  La valeur du champ uniqueKey déclaré dans le schéma.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Retourne un objet <info>SolrUpdateResponse</info> en cas de succès, et lance une exception
                      en cas d'échec.

<comment>See Also:</comment>
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByIds
type: function
doc:
<comment>Description:</comment>
  Effacement par Ids
  
  Efface une collection de documents représentée par le jeu d'Ids spécifié.

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  Un tableau d'Ids, représentant le champ uniqueKey déclaré dans le schéma de chaque
               document.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Retourne un objet <info>SolrUpdateResponse</info> en cas de succès, et lance une exception
                      en cas d'échec.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByQuery
   * SolrClient::deleteByQueries


id: SolrClient::deleteByQueries
type: function
doc:
<comment>Description:</comment>
  Efface tous les documents correspondant à des requêtes
  
  Efface tous les documents correspondant à des requêtes.

<comment>Param:</comment>
  <info>array</info>  <strong>$queries</strong>  Un tableau de requêtes.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Retourne un objet SolrUpdateResponse en cas de succès, et lance une exception
                      SolrClientException en cas d'échec.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQuery


id: SolrClient::deleteByQuery
type: function
doc:
<comment>Description:</comment>
  Efface tous les documents correspondant à une requête
  
  Efface tous les documents correspondant à la requête fournie.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  La requête.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Retourne un objet <info>SolrUpdateResponse</info> en cas de succès, et lance une exception
                      en cas d'échec.

<comment>See Also:</comment>
   * SolrClient::deleteById
   * SolrClient::deleteByIds
   * SolrClient::deleteByQueries


id: SolrClient::getById
type: function
doc:
<comment>Description:</comment>
  Get Document By Id. Utilizes Solr Realtime Get (RTG)
  
  Get Document By Id. Utilizes Solr Realtime Get (RTG).

<comment>Param:</comment>
  <info>string</info>  <strong>$id</strong>  Document ID

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

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


id: SolrClient::getByIds
type: function
doc:
<comment>Description:</comment>
  Get Documents by their Ids. Utilizes Solr Realtime Get (RTG)
  
  Get Documents by their Ids. Utilizes Solr Realtime Get (RTG).

<comment>Param:</comment>
  <info>array</info>  <strong>$ids</strong>  Document ids

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  <info>SolrQueryResponse</info>

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


id: SolrClient::getDebug
type: function
doc:
<comment>Description:</comment>
  Récupère les données de débogage de la dernière tentative de connexion
  
  Retourne les données de débogage de la dernière tentative de connexion.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> s'il n'y a aucune donnée à
          retourner.


id: SolrClient::getOptions
type: function
doc:
<comment>Description:</comment>
  Récupère les options clientes définies en interne
  
  Récupère les options clientes définies en interne. Très utile pour déboguer. Les valeurs
  retournées sont en lecture seule et ne peuvent être définies que lors de l'instanciation de
  l'objet.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant toutes les options de l'objet SolrClient définies en interne.

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


id: SolrClient::optimize
type: function
doc:
<comment>Description:</comment>
  Défragmente l'index
  
  Défragmente l'index afin de rendre la recherche plus performante.

<comment>Param:</comment>
  <info>int</info>   <strong>$maxSegments</strong>   Optimise jusqu'à ce nombre de fragments. Disponible depuis Solr 1.3.
  <info>bool</info>  <strong>$softCommit</strong>    Permet de rafraîchir la vue de l'index de manière plus performante, mais sans
                       garantie "sur le disque". (Solr4.0+)
  <info>bool</info>  <strong>$waitSearcher</strong>  S'interrompt jusqu'à ce qu'un nouvel objet de recherche soit ouvert et
                       enregistré comme objet principal, rendant les modifications visibles.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Retourne un objet SolrUpdateResponse en cas de succès, ou lance une exception
                      en cas d'échec.

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::rollback


id: SolrClient::ping
type: function
doc:
<comment>Description:</comment>
  Vérifie si le serveur Solr est disponible
  
  Vérifie si le serveur Solr est toujours disponible. Envoi une requête HEAD au serveur Apache Solr.

<comment>Return:</comment>
  <info>SolrPingResponse</info>  Retourne un objet <info>SolrPingResponse</info> en cas de succès, et lance une exception
                    SolrClientException en cas d'échec.


id: SolrClient::query
type: function
doc:
<comment>Description:</comment>
  Envoi une requête au serveur
  
  Envoi une requête au serveur.

<comment>Param:</comment>
  <info>SolrParams</info>  <strong>$query</strong>  Un objet <info>SolrParams</info>. Il est recommandé d'utiliser un objet <info>SolrQuery</info> pour des
                      requêtes avancées.

<comment>Return:</comment>
  <info>SolrQueryResponse</info>  Retourne un objet <info>SolrQueryResponse</info> en cas de succès, et lance une exception en
                     cas d'échec.


id: SolrClient::request
type: function
doc:
<comment>Description:</comment>
  Envoi une requête brute de mise à jour
  
  Envoi une requête XML brute de mise à jour au serveur.

<comment>Param:</comment>
  <info>string</info>  <strong>$raw_request</strong>  Une chaîne XML contenant la requête brute vers le serveur.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Retourne un objet <info>SolrUpdateResponse</info> en cas de succès. Lance une exception en
                      cas d'échec.


id: SolrClient::rollback
type: function
doc:
<comment>Description:</comment>
  Annule les ajouts/effacements effectués sur l'index depuis le dernier commit
  
  Annule les ajouts/effacements effectués sur l'index depuis le dernier commit. Cette méthode
  n'appelle aucun événement, ni ne crée de nouvelle recherche.

<comment>Return:</comment>
  <info>SolrUpdateResponse</info>  Retourne un objet SolrUpdateResponse en cas de succès, ou lance une exception
                      SolrClientException si une erreur survient.

<comment>See Also:</comment>
   * SolrClient::commit
   * SolrClient::optimize


id: SolrClient::setResponseWriter
type: function
doc:
<comment>Description:</comment>
  Définit le gestionnaire à utiliser pour préparer la réponse depuis Solr
  
  Définit le gestionnaire à utiliser pour préparer la réponse depuis Solr.

<comment>Param:</comment>
  <info>string</info>  <strong>$responseWriter</strong>  Un parmi les suivants :

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


id: SolrClient::setServlet
type: function
doc:
<comment>Description:</comment>
  Modifie le type d'un servlet en une nouvelle valeur
  
  Modifie le type d'un servlet en une nouvelle valeur.

<comment>Param:</comment>
  <info>int</info>     <strong>$type</strong>   Une constante parmi :
                  
                  
  <info>string</info>  <strong>$value</strong>  La nouvelle valeur du servlet

<comment>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: SolrClient::system
type: function
doc:
<comment>Description:</comment>
  Retrieve Solr Server information
  
  Retrieve Solr Server information

<comment>Return:</comment>
  <info>void</info>  Returns a <info>SolrGenericResponse</info> object on success.


id: SolrClient::threads
type: function
doc:
<comment>Description:</comment>
  Vérifie le statut des threads
  
  Vérifie le statut des threads.

<comment>Return:</comment>
  <info>void</info>  Retourne un objet SolrGenericResponse.


id: SolrClientException
type: class
doc:
<comment>Description:</comment>
  Une exception est lancée lorsqu'une erreur survient pendant l'exécution d'une requête vers le
  serveur depuis le client.


id: SolrClientException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Retourne des informations internes sur l'endroit d'où est lancée l'exception
  
  Retourne des informations internes sur l'endroit d'où est lancée l'exception.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant des informations internes sur l'endroit d'où est lancée
         l'exception. Utilisé uniquement par les developpeurs de l'extension.


id: SolrCollapseFunction::__construct
type: function
doc:
<comment>Description:</comment>
  Constructor
  
  Collapse Function constructor

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The field name to collapse on.
                  
                  In order to collapse a result. The field type must be a single valued String, Int
                  or Float.

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


id: SolrCollapseFunction::__toString
type: function
doc:
<comment>Description:</comment>
  Returns a string representing the constructed collapse function
  
  Returns a string representing the constructed collapse function

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


id: SolrCollapseFunction::getField
type: function
doc:
<comment>Description:</comment>
  Returns the field that is being collapsed on
  
  Returns the field that is being collapsed on.

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

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


id: SolrCollapseFunction::getHint
type: function
doc:
<comment>Description:</comment>
  Returns collapse hint
  
  Returns collapse hint

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

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


id: SolrCollapseFunction::getMax
type: function
doc:
<comment>Description:</comment>
  Returns max parameter
  
  Returns max parameter

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

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


id: SolrCollapseFunction::getMin
type: function
doc:
<comment>Description:</comment>
  Returns min parameter
  
  Returns min parameter

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

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


id: SolrCollapseFunction::getNullPolicy
type: function
doc:
<comment>Description:</comment>
  Returns null policy
  
  Returns null policy used or null

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

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


id: SolrCollapseFunction::getSize
type: function
doc:
<comment>Description:</comment>
  Returns size parameter
  
  Gets the initial size of the collapse data structures when collapsing on a numeric field only

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

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


id: SolrCollapseFunction::setField
type: function
doc:
<comment>Description:</comment>
  Sets the field to collapse on
  
  The field name to collapse on.  In order to collapse a result. The field type must be a single
  valued String, Int or Float.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setHint
type: function
doc:
<comment>Description:</comment>
  Sets collapse hint
  
  Sets collapse hint

<comment>Param:</comment>
  <info>string</info>  <strong>$hint</strong>  Currently there is only one hint available "top_fc", which stands for top level
                 FieldCache

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMax
type: function
doc:
<comment>Description:</comment>
  Selects the group heads by the max value of a numeric field or function query
  
  Selects the group heads by the max value of a numeric field or function query.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setMin
type: function
doc:
<comment>Description:</comment>
  Sets the initial size of the collapse data structures when collapsing on a numeric field only
  
  Sets the initial size of the collapse data structures when collapsing on a numeric field only

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setNullPolicy
type: function
doc:
<comment>Description:</comment>
  Sets the NULL Policy
  
  Sets the NULL Policy. One of the 3 policies defined as class constants shall be passed. Accepts
  ignore, expand, or collapse policies.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrCollapseFunction::setSize
type: function
doc:
<comment>Description:</comment>
  Sets the initial size of the collapse data structures when collapsing on a numeric field only
  
  Sets the initial size of the collapse data structures when collapsing on a numeric field only.

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

<comment>Return:</comment>
  <info>SolrCollapseFunction</info>  <info>SolrCollapseFunction</info>


id: SolrDisMaxQuery::FACET_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the facet should sort by count (Duplicated for easier migration)


id: SolrDisMaxQuery::FACET_SORT_INDEX
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the facet should sort by index (Duplicated for easier migration)


id: SolrDisMaxQuery::ORDER_ASC
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the sorting should be in acending order (Duplicated for easier migration)


id: SolrDisMaxQuery::ORDER_DESC
type: constant
doc:
<comment>Description:</comment>
  Used to specify that the sorting should be in descending order (Duplicated for easier migration)


id: SolrDisMaxQuery::__construct
type: function
doc:
<comment>Description:</comment>
  Class Constructor
  
  Class constructor initializes the object and sets the q parameter if passed

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Search Query (q parameter)


id: SolrDisMaxQuery::addBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Phrase Bigram Field (pf2 parameter)
  
  Adds a Phrase Bigram Field (pf2 parameter) output format: field~slop^boost OR field^boost Slop is
  optional

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop</strong>   

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::addBoostQuery
type: function
doc:
<comment>Description:</comment>
  Adds a boost query field with value and optional boost (bq parameter)
  
  Adds a Boost Query field with value [and boost] (bq parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  
  <info>string</info>  <strong>$value</strong>  
  <info>string</info>  <strong>$boost</strong>  

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::addPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Phrase Field (pf parameter)
  
  Adds a Phrase Field (pf parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$boost</strong>  
  <info>string</info>  <strong>$slop</strong>   

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removePhraseField
   * SolrDisMaxQuery::setPhraseFields


id: SolrDisMaxQuery::addQueryField
type: function
doc:
<comment>Description:</comment>
  Add a query field with optional boost (qf parameter)
  
  Add a query field with optional boost (qf parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$boost</strong>  Boost value. Boosts documents with matching terms.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

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


id: SolrDisMaxQuery::addTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Adds a Trigram Phrase Field (pf3 parameter)
  
  Adds a Trigram Phrase Field (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name
  <info>string</info>  <strong>$boost</strong>  Field Boost
  <info>string</info>  <strong>$slop</strong>   Field Slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::addUserField
type: function
doc:
<comment>Description:</comment>
  Adds a field to User Fields Parameter (uf)
  
  Adds a field to The User Fields Parameter (uf)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::removeUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::removeBigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Removes phrase bigram field (pf2 parameter)
  
  Removes a Bigram Phrase Field (pf2 parameter) that was previously added using
  SolrDisMaxQuery::addBigramPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  The Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBigramPhraseField
   * SolrDisMaxQuery::setBigramPhraseFields
   * SolrDisMaxQuery::setBigramPhraseSlop


id: SolrDisMaxQuery::removeBoostQuery
type: function
doc:
<comment>Description:</comment>
  Removes a boost query partial by field name (bq)
  
  Removes a boost query partial from the existing query, only if SolrDisMaxQuery::addBoostQuery was
  used.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::setBoostQuery


id: SolrDisMaxQuery::removePhraseField
type: function
doc:
<comment>Description:</comment>
  Removes a Phrase Field (pf parameter)
  
  Removes a Phrase Field (pf parameter) that was previously added using
  SolrDisMaxQuery::addPhraseField

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseField
   * SolrDisMaxQuery::setPhraseFields


id: SolrDisMaxQuery::removeQueryField
type: function
doc:
<comment>Description:</comment>
  Removes a Query Field (qf parameter)
  
  Removes a Query Field (qf parameter) from the field list added by SolrDisMaxQuery::addQueryField
  
  qf: When building DisjunctionMaxQueries from the user's query it specifies the fields to search
  in, and boosts for those fields.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

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


id: SolrDisMaxQuery::removeTrigramPhraseField
type: function
doc:
<comment>Description:</comment>
  Removes a Trigram Phrase Field (pf3 parameter)
  
  Removes a Trigram Phrase Field (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::removeUserField
type: function
doc:
<comment>Description:</comment>
  Removes a field from The User Fields Parameter (uf)
  
  Removes a field from The User Fields Parameter (uf)
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field Name

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::setUserFields


id: SolrDisMaxQuery::setBigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Sets Bigram Phrase Fields and their boosts (and slops) using pf2 parameter
  
  Sets Bigram Phrase Fields (pf2) and their boosts (and slops)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields boosts (slops)

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::setBigramPhraseSlop
   * SolrDisMaxQuery::addBigramPhraseFields
   * SolrDisMaxQuery::removeBigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setBigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets Bigram Phrase Slop (ps2 parameter)
  
  Sets Bigram Phrase Slop (ps2 parameter). A default slop for Bigram phrase fields.

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setBoostFunction
type: function
doc:
<comment>Description:</comment>
  Sets a Boost Function (bf parameter)
  
  Sets Boost Function (bf parameter).
  
  Functions (with optional boosts) that will be included in the user's query to influence the score.
  Any function supported natively by Solr can be used, along with a boost value. e.g.:
  
  recip(rord(myfield),1,2,3)^1.5

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setBoostQuery
type: function
doc:
<comment>Description:</comment>
  Directly Sets Boost Query Parameter (bq)
  
  Sets Boost Query Parameter (bq)

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  query

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addBoostQuery
   * SolrDisMaxQuery::removeBoostQuery


id: SolrDisMaxQuery::setMinimumMatch
type: function
doc:
<comment>Description:</comment>
  Set Minimum "Should" Match (mm)
  
  Set Minimum "Should" Match parameter (mm). If the default query operator is AND then mm=100%, if
  the default query operator (q.op) is OR, then mm=0%.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  Minimum match value/expression

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setPhraseFields
type: function
doc:
<comment>Description:</comment>
  Sets  Phrase Fields and their boosts (and slops) using pf2 parameter
  
  Sets  Phrase Fields (pf) and their boosts (and slops)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields, boosts [, slops]

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addPhraseFields
   * SolrDisMaxQuery::removePhraseField


id: SolrDisMaxQuery::setPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets the default slop on phrase queries (ps parameter)
  
  Sets the default amount of slop on phrase queries built with "pf", "pf2" and/or "pf3" fields
  (affects boosting). "ps" parameter

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

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setQueryAlt
type: function
doc:
<comment>Description:</comment>
  Set Query Alternate (q.alt parameter)
  
  Set Query Alternate (q.alt parameter)
  
  When the main q parameter is not specified or is blank. The q.alt parameter is used

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Query String

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setQueryPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Specifies the amount of slop permitted on phrase queries explicitly included in the user's query
  string (qf parameter)
  
  The Query Phrase Slop is the amount of slop permitted on phrase queries explicitly included in the
  user's query string with the qf parameter.
  
  slop refers to the number of positions one token needs to be moved in relation to another token in
  order to match a phrase specified in a query.

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Amount of slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTieBreaker
type: function
doc:
<comment>Description:</comment>
  Sets Tie Breaker parameter (tie parameter)
  
  Sets Tie Breaker parameter (tie parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$tieBreaker</strong>  The tie parameter specifies a float value (which should be something much
                       less than 1) to use as tiebreaker in DisMax queries.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDisMaxQuery::setTrigramPhraseFields
type: function
doc:
<comment>Description:</comment>
  Directly Sets Trigram Phrase Fields (pf3 parameter)
  
  Directly Sets Trigram Phrase Fields (pf3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Trigram Phrase Fields

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseSlop


id: SolrDisMaxQuery::setTrigramPhraseSlop
type: function
doc:
<comment>Description:</comment>
  Sets Trigram Phrase Slop (ps3 parameter)
  
  Sets Trigram Phrase Slop (ps3 parameter)

<comment>Param:</comment>
  <info>string</info>  <strong>$slop</strong>  Phrase slop

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addTrigramPhraseField
   * SolrDisMaxQuery::removeTrigramPhraseField
   * SolrDisMaxQuery::setTrigramPhraseFields


id: SolrDisMaxQuery::setUserFields
type: function
doc:
<comment>Description:</comment>
  Sets User Fields parameter (uf)
  
  Sets User Fields parameter (uf)
  
  User Fields: Specifies which schema fields the end user shall be allowed to query.

<comment>Param:</comment>
  <info>string</info>  <strong>$fields</strong>  Fields names separated by space
                   
                   This parameter supports wildcards.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

<comment>See Also:</comment>
   * SolrDisMaxQuery::addUserField
   * SolrDisMaxQuery::removeUserField


id: SolrDisMaxQuery::useDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Switch QueryParser to be DisMax Query Parser
  
  Switch QueryParser to be DisMax Query Parser

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>

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


id: SolrDisMaxQuery::useEDisMaxQueryParser
type: function
doc:
<comment>Description:</comment>
  Switch QueryParser to be EDisMax
  
  Switch QueryParser to be EDisMax. By default the query builder uses edismax, if it was switched
  using SolrDisMaxQuery::useDisMaxQueryParser, it can be switched back using this method.

<comment>Return:</comment>
  <info>SolrDisMaxQuery</info>  <info>SolrDisMaxQuery</info>


id: SolrDocument::__clone
type: function
doc:
<comment>Description:</comment>
  Crée une copie de l'objet SolrDocument
  
  Crée une copie de l'objet SolrDocument. À ne pas appeler directement.

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


id: SolrDocument::__get
type: function
doc:
<comment>Description:</comment>
  Accède à un champ comme une propriété
  
  Méthode magique pour accéder au champ comme à une propriété.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Retourne une instance SolrDocumentField.


id: SolrDocument::__isset
type: function
doc:
<comment>Description:</comment>
  Vérifie si un champ existe
  
  Vérifie si un champ existe.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Nom du champ.

<comment>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: SolrDocument::__set
type: function
doc:
<comment>Description:</comment>
  Ajoute un champ au document
  
  Ajoute un champ au document. Utilisé pour définir les champs comme nouvelles propriétés.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   Nom du champ.
  <info>string</info>  <strong>$fieldValue</strong>  Valeur du champ.

<comment>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: SolrDocument::__unset
type: function
doc:
<comment>Description:</comment>
  Efface un champ du document
  
  Efface un champ du document lorsqu'il est accessible sous la forme d'une propriété de l'objet.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Le nom du champ.

<comment>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: SolrDocument::addField
type: function
doc:
<comment>Description:</comment>
  Ajoute un champ au document
  
  Cette méthode ajoute un champ à l'instance SolrDocument.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   Le nom du champ.
  <info>string</info>  <strong>$fieldValue</strong>  La valeur du champ.

<comment>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: SolrDocument::clear
type: function
doc:
<comment>Description:</comment>
  Efface tous les champs du document
  
  Réinitialise l'objet courant. Efface tous les champs et réinitialise le document.

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


id: SolrDocument::current
type: function
doc:
<comment>Description:</comment>
  Récupère le champ courant
  
  Récupère le champ courant.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Retourne le champ courant.


id: SolrDocument::deleteField
type: function
doc:
<comment>Description:</comment>
  Efface un champ du document
  
  Efface un champ du document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Nom du champ

<comment>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: SolrDocument::fieldExists
type: function
doc:
<comment>Description:</comment>
  Vérifie si un champ existe dans le document
  
  Vérifie si le champ demandé est un champ valide du document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> si le champ est présent, ou <info>false</info> sinon.


id: SolrDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns an array of child documents (SolrDocument)
  
  Returns an array of child documents (SolrDocument)

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

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of child documents
  
  Returns the number of child documents

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

<comment>See Also:</comment>
   * SolrDocument::hasChildDocuments
   * SolrDocument::getChildDocuments


id: SolrDocument::getField
type: function
doc:
<comment>Description:</comment>
  Récupère un champ par son nom
  
  Récupère un champ par son nom.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Nom du champ.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Retourne un objet SolrDocumentField en cas de succès, ou <info>false</info> si une erreur
                     survient.


id: SolrDocument::getFieldCount
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre de champs du document
  
  Récupère le nombre de champs du document. Les champs à valeur multiple sont comptés une seule
  fois.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, <info>false</info> sinon.


id: SolrDocument::getFieldNames
type: function
doc:
<comment>Description:</comment>
  Récupère un tableau de noms de champs du document
  
  Récupère un tableau de noms de champs du document.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant les noms des champs du document.


id: SolrDocument::getInputDocument
type: function
doc:
<comment>Description:</comment>
  Retourne un objet SolrInputDocument équivalent à l'objet
  
  Retourne un objet SolrInputDocument équivalent à l'objet. Utile si vous voulez re-soumettre/mettre
  à jour un document issue d'une requête.

<comment>Return:</comment>
  <info>SolrInputDocument</info>  Retourne un objet SolrInputDocument en cas de succès, et <info>null</info> si une erreur
                     survient.


id: SolrDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Checks whether the document has any child documents
  
  Checks whether the document has any child documents

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

<comment>See Also:</comment>
   * SolrDocument::getChildDocuments
   * SolrDocument::getChildDocumentsCount


id: SolrDocument::key
type: function
doc:
<comment>Description:</comment>
  Récupère la clé courante
  
  Récupère la clé courante.

<comment>Return:</comment>
  <info>string</info>  Retourne la clé courante.


id: SolrDocument::merge
type: function
doc:
<comment>Description:</comment>
  Fusionne la source à l'objet SolrDocument courant
  
  Fusionne la source à l'objet SolrDocument courant.

<comment>Param:</comment>
  <info>SolrDocument</info>  <strong>$sourceDoc</strong>  La source du document.
  <info>bool</info>          <strong>$overwrite</strong>  Si vaut <info>true</info> alors les champs dont les noms sont identiques dans le
                            document destinataire seront écrasés.

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


id: SolrDocument::next
type: function
doc:
<comment>Description:</comment>
  Déplace le pointeur interne sur le champ suivant
  
  Déplace le pointeur interne sur le champ suivant.

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


id: SolrDocument::offsetExists
type: function
doc:
<comment>Description:</comment>
  Vérifie si un champ particulier existe
  
  Vérifie si un champ particulier existe. Méthode utilisée lorsque l'objet est traité comme un
  tableau.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Le nom du champ.

<comment>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: SolrDocument::offsetGet
type: function
doc:
<comment>Description:</comment>
  Récupère un champ
  
  Utilisé pour récupérer un champ lorsque l'objet est traité comme un tableau.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Retourne un objet SolrDocumentField.


id: SolrDocument::offsetSet
type: function
doc:
<comment>Description:</comment>
  Ajoute un champ au document
  
  Utilisé lorsque l'objet est traité comme un tableau, pour ajouter un champ au document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>   Le nom du champ.
  <info>string</info>  <strong>$fieldValue</strong>  Le valeur du champ.

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


id: SolrDocument::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Efface un champ
  
  Efface un champ du document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Le nom du champ.

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


id: SolrDocument::reset
type: function
doc:
<comment>Description:</comment>
  Alias de SolrDocument::clear
  
  Alias de SolrDocument::clear()

<comment>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: SolrDocument::rewind
type: function
doc:
<comment>Description:</comment>
  Réinitialise le pointeur interne au début
  
  Réinitialise le pointeur interne au début.

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


id: SolrDocument::serialize
type: function
doc:
<comment>Description:</comment>
  Utilisé pour une sérialisation personnalisée
  
  Utilisé pour une sérialisation personnalisée.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères représentant le document Solr sérialisé.


id: SolrDocument::sort
type: function
doc:
<comment>Description:</comment>
  Trie les champs du document
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy</strong>    Le critère de tri.
  <info>int</info>  <strong>$sortDirection</strong>  La direction du tri.

<comment>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: SolrDocument::toArray
type: function
doc:
<comment>Description:</comment>
  Récupère un tableau représentant le document
  
  Récupère un tableau représentant le document.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau représentant le document.


id: SolrDocument::unserialize
type: function
doc:
<comment>Description:</comment>
  Sérialisation personnalisée d'objets SolrDocument
  
  Sérialisation personnalisée d'objets SolrDocument.

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  Une représentation XML du document.

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


id: SolrDocument::valid
type: function
doc:
<comment>Description:</comment>
  Vérifie si la position courant interne est toujours valide
  
  Vérifie si la position courant interne est toujours valide. Utilisée lors d'opérations foreach.

<comment>Return:</comment>
  <info>bool</info>  Retourne <info>true</info> en cas de succès, ou <info>false</info> si la position courante n'est plus valide.


id: SolrDocumentField
type: class
doc:
<comment>Description:</comment>
  Représente un champ d'un document Solr. Toutes les propriétés sont en lecture seule.


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

<comment>Return:</comment>
  <info>unknown</info>  Aucune.


id: SolrDocumentField::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructeur
  
  Destructeur.

<comment>Return:</comment>
  <info>unknown</info>  Rien.


id: SolrException
type: class
doc:
<comment>Description:</comment>
  C'est la classe de base pour toutes les exceptions lancées par les classes de l'extension Solr.


id: SolrException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Récupère des informations internes lorsqu'une exception a été lancée
  
  Récupère des informations internes lorsqu'une exception a été lancée.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant des informations internes lorsqu'une exception a été lancée.
         Utilisé uniquement dans un cadre de débogage pour les développeurs de l'extension.


id: SolrGenericResponse::PARSE_SOLR_DOC
type: constant
doc:
<comment>Description:</comment>
  Les documents doivent être analysés comme des instances SolrDocument.


id: SolrGenericResponse::PARSE_SOLR_OBJ
type: constant
doc:
<comment>Description:</comment>
  Les documents doivent être analysés comme des instances SolrObject.


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

<comment>Return:</comment>
  <info>unknown</info>  Rien


id: SolrGenericResponse::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructeur
  
  Destructeur.

<comment>Return:</comment>
  <info>unknown</info>  Rien


id: SolrIllegalArgumentException
type: class
doc:
<comment>Description:</comment>
  Cet objet est lancé lorsqu'un argument illégal ou invalide est passé à une méthode.


id: SolrIllegalArgumentException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Retourne des informations sur l'endroit d'où l'exception a été émise
  
  Retourne des informations sur l'endroit d'où l'exception a été émise.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

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


id: SolrIllegalOperationException
type: class
doc:
<comment>Description:</comment>
  Cet objet est lancé lorsqu'une opération illégale ou non supportée est effectuée sur l'objet.


id: SolrIllegalOperationException::getInternalInfo
type: function
doc:
<comment>Description:</comment>
  Récupère des informations internes lorsqu'une exception a été lancée
  
  Récupère des informations internes lorsqu'une exception a été lancée.
  
  Cette fonction est actuellement non documentée ; seule la liste des arguments est disponible.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant des informations internes lorsqu'une exception a été lancée.
         Utilisé uniquement dans un cadre de débogage pour les développeurs de l'extension.


id: SolrInputDocument
type: class
doc:
<comment>Description:</comment>
  Représente un document Solr qui est sur le point d'être envoyé à l'index Solr.


id: SolrInputDocument::__clone
type: function
doc:
<comment>Description:</comment>
  Crée une copie de l'objet SolrDocument
  
  Cette méthode ne devrait pas être appelée directement. Elle est utilisée pour créer une copie
  interne de l'objet SolrInputDocument.

<comment>Return:</comment>
  <info>void</info>  Crée une nouvelle instance SolrInputDocument.


id: SolrInputDocument::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructeur
  
  Destructeur.

<comment>Return:</comment>
  <info>unknown</info>  Aucune.


id: SolrInputDocument::addChildDocument
type: function
doc:
<comment>Description:</comment>
  Adds a child document for block indexing
  
  Adds a child document to construct a document block with nested documents.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$child</strong>  A <info>SolrInputDocument</info> object.

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addChildDocuments
type: function
doc:
<comment>Description:</comment>
  Adds an array of child documents
  
  Adds an array of child documents to the current input document.

<comment>Param:</comment>
  <info>array</info>  <strong>$docs</strong>  An <info>array</info> of <info>SolrInputDocument</info> objects.

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::addField
type: function
doc:
<comment>Description:</comment>
  Ajoute un champ au document
  
  Pour des champs à valeur multiple, si une valeur de boost valide est spécifiée, la valeur
  spécifiée sera multipliée par la valeur de boost courant pour ce champ.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>        Le nom du champ.
  <info>string</info>  <strong>$fieldValue</strong>       La valeur du champ.
  <info>float</info>   <strong>$fieldBoostValue</strong>  Le boost de ce champ. Cette valeur ne peut être négative. Vous pouvez
                            passer une valeur inférieure à 1.0 mais elle doit être supérieure à 0.

<comment>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: SolrInputDocument::clear
type: function
doc:
<comment>Description:</comment>
  Réinitialise le document d'entrée
  
  Réinitialise le document en supprimant tous les champs.

<comment>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: SolrInputDocument::deleteField
type: function
doc:
<comment>Description:</comment>
  Efface un champ d'un document
  
  Efface un champ d'un document.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Le nom du champ.

<comment>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: SolrInputDocument::fieldExists
type: function
doc:
<comment>Description:</comment>
  Vérifie si un champ existe
  
  Vérifie si un champ existe.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Le nom du champ.

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


id: SolrInputDocument::getBoost
type: function
doc:
<comment>Description:</comment>
  Récupère la valeur courante du boost pour le document
  
  Récupère la valeur courante du boost pour le document.

<comment>Return:</comment>
  <info>float</info>  Retourne la valeur du boost en cas de succès, et <info>false</info> si une erreur survient.


id: SolrInputDocument::getChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns an array of child documents (SolrInputDocument)
  
  Returns an array of child documents (SolrInputDocument)

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::getChildDocumentsCount
type: function
doc:
<comment>Description:</comment>
  Returns the number of child documents
  
  Returns the number of child documents

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::hasChildDocuments
   * SolrInputDocument::getChildDocuments


id: SolrInputDocument::getField
type: function
doc:
<comment>Description:</comment>
  Récupère un champ par son nom
  
  Récupère un champ par son nom.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>SolrDocumentField</info>  Retourne un objet SolrDocumentField en cas de succès, et <info>false</info> si une erreur
                     survient.


id: SolrInputDocument::getFieldBoost
type: function
doc:
<comment>Description:</comment>
  Récupère la valeur du boost pour un champ donné
  
  Récupère la valeur du boost pour un champ donné.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>float</info>  Retourne la valeur du boost pour le champ, ou <info>false</info> si une erreur survient.


id: SolrInputDocument::getFieldCount
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de champs du document
  
  Retourne le nombre de champs du document.

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


id: SolrInputDocument::getFieldNames
type: function
doc:
<comment>Description:</comment>
  Retourne un tableau contenant tous les champs du document
  
  Retourne un tableau contenant tous les champs du document.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau en cas de succès, et <info>false</info> si une erreur survient.


id: SolrInputDocument::hasChildDocuments
type: function
doc:
<comment>Description:</comment>
  Returns true if the document has any child documents
  
  Checks whether the document has any child documents

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

<comment>See Also:</comment>
   * SolrInputDocument::addChildDocument
   * SolrInputDocument::addChildDocuments
   * SolrInputDocument::getChildDocuments
   * SolrInputDocument::getChildDocumentsCount


id: SolrInputDocument::merge
type: function
doc:
<comment>Description:</comment>
  Fusionne un document d'entrée dans un autre
  
  Fusionne un document d'entrée dans un autre.

<comment>Param:</comment>
  <info>SolrInputDocument</info>  <strong>$sourceDoc</strong>  Le document source.
  <info>bool</info>               <strong>$overwrite</strong>  Si vaut <info>true</info>, il remplacera les champs correspondant dans le
                                 document cible.

<comment>Return:</comment>
  <info>bool</info>  Cette fonction retourne <info>true</info> en cas de succès ou <info>false</info> si une erreur survient. Dans le
        futur, cette méthode sera modifiée pour retourner le nombre de champs du nouveau document.


id: SolrInputDocument::reset
type: function
doc:
<comment>Description:</comment>
  Alias de SolrInputDocument::clear
  
  Alias de SolrInputDocument::clear.

<comment>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: SolrInputDocument::setBoost
type: function
doc:
<comment>Description:</comment>
  Définit la valeur de boost pour le document
  
  Définit la valeur de boost pour le document.

<comment>Param:</comment>
  <info>float</info>  <strong>$documentBoostValue</strong>  La valeur de boost pour ce document.

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


id: SolrInputDocument::setFieldBoost
type: function
doc:
<comment>Description:</comment>
  Définit la valeur de boost pour un champ
  
  Définit la valeur de boost pour un champ. Ceci remplacera la valeur de boost courante pour ce
  champ.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldName</strong>        Le nom du champ.
  <info>float</info>   <strong>$fieldBoostValue</strong>  La valeur de boost.

<comment>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: SolrInputDocument::sort
type: function
doc:
<comment>Description:</comment>
  Tri les champs du document
  
  

<comment>Param:</comment>
  <info>int</info>  <strong>$sortOrderBy</strong>    Le critère de tri
  <info>int</info>  <strong>$sortDirection</strong>  La direction du tri

<comment>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: SolrInputDocument::toArray
type: function
doc:
<comment>Description:</comment>
  Retourne un représentation sous forme de tableau du document d'entrée
  
  Retourne un représentation sous forme de tableau du document d'entrée.

<comment>Return:</comment>
  <info>array</info>  Retourne une représentation sous forme de tableau des champs et <info>false</info> si une erreur
         survient.


id: SolrModifiableParams
type: class
doc:
<comment>Description:</comment>
  Représente une collection de paires nom-valeur envoyées au serveur Solr lors d'une requête.


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

<comment>Return:</comment>
  <info>unknown</info>  Aucune


id: SolrModifiableParams::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructeur
  
  Destructeur

<comment>Return:</comment>
  <info>unknown</info>  Rien


id: SolrObject
type: class
doc:
<comment>Description:</comment>
  Les propriétés de cet objet peuvent également être accédées en utilisant une syntaxe de type
  tableau. Elles sont toutes en lecture seule.


id: SolrObject::__construct
type: function
doc:
<comment>Description:</comment>
  Crée un objet Solr
  
  Crée un objet Solr.

<comment>Return:</comment>
  <info>unknown</info>  Rien


id: SolrObject::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructeur
  
  Le destructeur

<comment>Return:</comment>
  <info>unknown</info>  Rien.


id: SolrObject::getPropertyNames
type: function
doc:
<comment>Description:</comment>
  Récupère un tableau contenant les noms de toutes les propriétés
  
  Récupère un tableau contenant les noms de toutes les propriétés.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau.


id: SolrObject::offsetExists
type: function
doc:
<comment>Description:</comment>
  Vérifie si une propriété existe
  
  Vérifie si une propriété existe. Cette méthode est utilisée lorsque l'objet est traité comme un
  tableau.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  Le nom de la propriété.

<comment>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: SolrObject::offsetGet
type: function
doc:
<comment>Description:</comment>
  Récupère une propriété
  
  Récupère la valeur d'une propriété. Cette méthode est utilisée lorsque l'objet est traité comme un
  tableau.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  Le nom de la propriété.

<comment>Return:</comment>
  <info>mixed</info>  Retourne la valeur de la propriété.


id: SolrObject::offsetSet
type: function
doc:
<comment>Description:</comment>
  Définit la valeur d'une propriété
  
  Définit la valeur de la propriété. Cette méthode est utilisée lorsque l'objet est traité comme un
  tableau. Cet objet est en lecture seule. Vous ne devriez jamais utiliser cette méthode.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>   Le nom de la propriété.
  <info>string</info>  <strong>$property_value</strong>  La nouvelle valeur.

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


id: SolrObject::offsetUnset
type: function
doc:
<comment>Description:</comment>
  Supprime la valeur de la propriété
  
  Supprime la valeur de la propriété. Cette méthode est utilisée lorsque l'objet est traité comme un
  tableau. Cet objet est en lecture seule. Vous ne devriez jamais utiliser cette méthode.

<comment>Param:</comment>
  <info>string</info>  <strong>$property_name</strong>  Le nom de la propriété.

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


id: SolrParams::add
type: function
doc:
<comment>Description:</comment>
  Alias de SolrParams::addParam
  
  Alias de SolrParams::addParam.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Nom du paramètre.
  <info>string</info>  <strong>$value</strong>  Valeur du paramètre.

<comment>Return:</comment>
  <info>SolrParams</info>  Retourne une instance d'un objet SolrParams en cas de succès.


id: SolrParams::addParam
type: function
doc:
<comment>Description:</comment>
  Ajoute un paramètre à l'objet
  
  Ajoute un paramètre à l'objet. Cette méthode est utilisée pour les paramètres pouvant être
  spécifiés plusieurs fois.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Nom du paramètre.
  <info>string</info>  <strong>$value</strong>  Valeur du paramètre.

<comment>Return:</comment>
  <info>SolrParams</info>  Retourne un objet SolrParam en cas de succès, et <info>false</info> si une erreur survient.


id: SolrParams::get
type: function
doc:
<comment>Description:</comment>
  Alias de SolrParams::getParam
  
  Alias de SolrParams::getParam.

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  Nom du paramètre.

<comment>Return:</comment>
  <info>mixed</info>  Retourne une chaîne de caractères ou un tableau suivant le type du paramètre.


id: SolrParams::getParam
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur d'un paramètre
  
  Retourne la valeur d'un paramètre.

<comment>Param:</comment>
  <info>string</info>  <strong>$param_name</strong>  Nom du paramètre.

<comment>Return:</comment>
  <info>mixed</info>  Retourne une chaîne de caractères ou un tableau suivant le type du paramètre.


id: SolrParams::getParams
type: function
doc:
<comment>Description:</comment>
  Retourne un tableau de paramètres non encodés URL
  
  Retourne un tableau de paramètres non encodés URL.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau de paramètres non encodés URL.


id: SolrParams::getPreparedParams
type: function
doc:
<comment>Description:</comment>
  Retourne un tableau de paramètres encodés URL
  
  Retourne un tableau de paramètres encodés URL.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau de paramètres encodés URL.


id: SolrParams::serialize
type: function
doc:
<comment>Description:</comment>
  Utilisé pour une sérialisation personnalisée
  
  Utilisé pour une sérialisation personnalisée.

<comment>Return:</comment>
  <info>string</info>  Utilisé pour une sérialisation personnalisée.


id: SolrParams::set
type: function
doc:
<comment>Description:</comment>
  Alias de SolrParams::setParam
  
  Alias de SolrParams::setParam.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Nom du paramètre.
  <info>string</info>  <strong>$value</strong>  Valeur du paramètre.

<comment>Return:</comment>
  <info>void</info>  Retourne une instance de l'objet SolrParams en cas de succès.


id: SolrParams::setParam
type: function
doc:
<comment>Description:</comment>
  Définit un paramètre à une valeur spécifique
  
  Définit un paramètre à une valeur spécifique. À n'utiliser que pour les paramètres ne pouvant être
  spécifiés qu'une seule fois. Les appels suivants sur le même paramètre écraseront la précédente
  valeur.

<comment>Param:</comment>
  <info>string</info>  <strong>$name</strong>   Nom du paramètre.
  <info>string</info>  <strong>$value</strong>  Valeur du paramètre.

<comment>Return:</comment>
  <info>SolrParams</info>  Retourne un objet SolrParam en cas de succès, et <info>false</info> si une erreur survient.


id: SolrParams::toString
type: function
doc:
<comment>Description:</comment>
  Retourne tous les paramètres de l'objet
  
  Retourne tous les paramètres de l'objet, sous la forme de paire nom-valeur.

<comment>Param:</comment>
  <info>bool</info>  <strong>$url_encode</strong>  Si l'on doit retourner les valeurs encodées URL.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>false</info> si une erreur survient.


id: SolrParams::unserialize
type: function
doc:
<comment>Description:</comment>
  Utilisé pour la sérialisation personnalisée
  
  Utilisé pour la sérialisation personnalisée.

<comment>Param:</comment>
  <info>string</info>  <strong>$serialized</strong>  La représentation sérialisée de l'objet.

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


id: SolrPingResponse
type: class
doc:
<comment>Description:</comment>
  Représente une réponse à une requête de type ping au serveur Solr.


id: SolrPingResponse::getResponse
type: function
doc:
<comment>Description:</comment>
  Récupère la réponse du serveur
  
  Récupère la réponse du serveur. Normalement, la réponse devrait être vide car la requête est de
  type HEAD.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne vide.


id: SolrQuery::FACET_SORT_COUNT
type: constant
doc:
<comment>Description:</comment>
  Utilisé pour spécifier que le facet doit être trié par son total.


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

<comment>Param:</comment>
  <info>string</info>  <strong>$q</strong>  Requête de recherche optionnelle

<comment>Return:</comment>
  <info>unknown</info>  Aucun


id: SolrQuery::__destruct
type: function
doc:
<comment>Description:</comment>
  Destructeur
  
  Destructeur

<comment>Return:</comment>
  <info>unknown</info>  Aucun.


id: SolrQuery::addExpandFilterQuery
type: function
doc:
<comment>Description:</comment>
  Overrides main filter query, determines which documents to include in the main group
  
  Overrides main filter query, determines which documents to include in the main group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addExpandSortField
type: function
doc:
<comment>Description:</comment>
  Orders the documents within the expanded groups (expand.sort parameter)
  
  Orders the documents within the expanded groups (expand.sort parameter).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name
  <info>string</info>  <strong>$order</strong>  Order ASC/DESC, utilizes SolrQuery::ORDER_* constants.
                  
                  Default: <info>SolrQuery::ORDER_DESC</info>

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::addFacetDateField
type: function
doc:
<comment>Description:</comment>
  Lie un facet.date
  
  Cette méthode vous permet de spécifier un champ qui doit être traité comme une facette.
  
  Elle peut être utilisée plusieurs fois avec différents noms de champs pour indiquer plusieurs
  champs de facette.

<comment>Param:</comment>
  <info>string</info>  <strong>$dateField</strong>  Le nom du champ date.

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne un objet SolrQuery.


id: SolrQuery::addFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Ajoute une autre paramètre facet.date.other
  
  Définit le paramètre facet.date.other. Accepte un paramètre optionnel permettant d'écraser la
  valeur.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           La valeur à utiliser.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ pour l'écrasement.

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


id: SolrQuery::addFacetField
type: function
doc:
<comment>Description:</comment>
  Ajoute un autre champ à la facette
  
  Ajoute un autre champ à la facette.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ

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


id: SolrQuery::addFacetQuery
type: function
doc:
<comment>Description:</comment>
  Ajoute une requête de facette
  
  Ajoute une requête de facette.

<comment>Param:</comment>
  <info>string</info>  <strong>$facetQuery</strong>  La requête de facette

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


id: SolrQuery::addField
type: function
doc:
<comment>Description:</comment>
  Spécifie quel champ doit retourner le résultat
  
  Cette méthode est utilisé pour spécifier un jeu de champs à retourner, permettant ainsi de limiter
  la quantité d'informations retournées.
  
  Cette méthode doit être appelée plusieurs fois ; une fois par nom de champ.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant.


id: SolrQuery::addFilterQuery
type: function
doc:
<comment>Description:</comment>
  Spécifie un filtre de requête
  
  Spécifie un filtre de requête.

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  Le filtre de requête

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant.


id: SolrQuery::addGroupField
type: function
doc:
<comment>Description:</comment>
  Add a field to be used to group results
  
  The name of the field by which to group results. The field must be single-valued, and either be
  indexed or a field type that has a value source and works in a function query, such as
  ExternalFileField. It must also be a string-based field, such as StrField or TextField Uses
  group.field parameter

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  The name of the field.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupFunction
type: function
doc:
<comment>Description:</comment>
  Allows grouping results based on the unique values of a function query (group.func parameter)
  
  Adds a group function (group.func parameter) Allows grouping results based on the unique values of
  a function query.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupQuery
type: function
doc:
<comment>Description:</comment>
  Allows grouping of documents that match the given query
  
  Allows grouping of documents that match the given query. Adds query to the group.query parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addGroupSortField
type: function
doc:
<comment>Description:</comment>
  Add a group sort field (group.sort parameter)
  
  Allow sorting group documents, using group sort field (group.sort parameter).

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Field name
  <info>int</info>     <strong>$order</strong>  Order ASC/DESC, utilizes SolrQuery::ORDER_* constants

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::addHighlightField
type: function
doc:
<comment>Description:</comment>
  Lie un hl.fl
  
  Lie un hl.fl. Ceci est utilisé pour spécifier le champ à mettre en évidence.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Nom du champ

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


id: SolrQuery::addMltField
type: function
doc:
<comment>Description:</comment>
  Spécifie un champ à utiliser pour les similitudes
  
  Lie un mlt.fl. Il spécifie qu'un champ doit être utilisé pour les similitudes.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ

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


id: SolrQuery::addMltQueryField
type: function
doc:
<comment>Description:</comment>
  Lie un mlt.qf
  
  Lie un mlt.qf. Utilisé pour spécifier les champs de requêtes ainsi que leurs renforts.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ
  <info>float</info>   <strong>$boost</strong>  La valeur du renfort

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


id: SolrQuery::addSortField
type: function
doc:
<comment>Description:</comment>
  Utilisé pour contrôler le tri du résultat
  
  Utilisé pour contrôler le tri du résultat.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ
  <info>int</info>     <strong>$order</strong>  La direction du tri. Doit être soit SolrQuery::ORDER_ASC, soit
                  SolrQuery::ORDER_DESC.

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant.


id: SolrQuery::addStatsFacet
type: function
doc:
<comment>Description:</comment>
  Récupère un sous résultat pour y trouver des valeurs d'une facette donnée
  
  Récupère un sous résultat pour y trouver des valeurs d'une facette donnée. Lie un champ
  stats.facet.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ

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


id: SolrQuery::addStatsField
type: function
doc:
<comment>Description:</comment>
  Lie un paramètre stats.field
  
  Lie un paramètre stats.field. Cette méthode ajoute un autre paramètre stats.field.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ

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


id: SolrQuery::collapse
type: function
doc:
<comment>Description:</comment>
  Collapses the result set to a single document per group
  
  Collapses the result set to a single document per group before it forwards the result set to the
  rest of the search components.
  
  So all downstream components (faceting, highlighting, etc...) will work with the collapsed result
  set.

<comment>Param:</comment>
  <info>SolrCollapseFunction</info>  <strong>$collapseFunction</strong>  

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns the current <info>SolrQuery</info> object


id: SolrQuery::getExpand
type: function
doc:
<comment>Description:</comment>
  Returns true if group expanding is enabled
  
  Returns <info>true</info> if group expanding is enabled

<comment>Return:</comment>
  <info>bool</info>  Returns whether group expanding is enabled.


id: SolrQuery::getExpandFilterQueries
type: function
doc:
<comment>Description:</comment>
  Returns the expand filter queries
  
  Returns the expand filter queries

<comment>Return:</comment>
  <info>array</info>  Returns the expand filter queries.


id: SolrQuery::getExpandQuery
type: function
doc:
<comment>Description:</comment>
  Returns the expand query expand.q parameter
  
  Returns the expand query expand.q parameter

<comment>Return:</comment>
  <info>array</info>  Returns the expand query.


id: SolrQuery::getExpandRows
type: function
doc:
<comment>Description:</comment>
  Returns The number of rows to display in each group (expand.rows)
  
  Returns The number of rows to display in each group (expand.rows)

<comment>Return:</comment>
  <info>int</info>  Returns the number of rows.


id: SolrQuery::getExpandSortFields
type: function
doc:
<comment>Description:</comment>
  Returns an array of fields
  
  Returns an array of fields

<comment>Return:</comment>
  <info>array</info>  Returns an array of fields.


id: SolrQuery::getFacet
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur du paramètre de facette
  
  Retourne la valeur du paramètre de facette.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si aucun paramètre n'est défini.


id: SolrQuery::getFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Retourne la valeur du paramètre facet.date.end
  
  Retourne la valeur du paramètre facet.date.end. Cette méthode accepte un champ optionnel
  permettant l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun paramètre n'est
          défini.


id: SolrQuery::getFacetDateFields
type: function
doc:
<comment>Description:</comment>
  Retourne tous les champs facet.date
  
  Retourne tous les champs facet.date.

<comment>Return:</comment>
  <info>array</info>  Retourne tous les champs facet.date sous la forme d'un tableau ou <info>null</info> si aucun n'a été
         défini.


id: SolrQuery::getFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Récupère la valeur du paramètre facet.date.gap
  
  Récupère la valeur du paramètre facet.date.gap. La méthode accepte un champ à y substituer.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> s'il n'est pas défini.


id: SolrQuery::getFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Récupère la valeur du paramètre facet.date.hardend
  
  Récupère la valeur du paramètre facet.date.hardend . La méthode accepte un champ à y substituer.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> s'il n'est pas défini.


id: SolrQuery::getFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Récupère la valeur du paramètre facet.date.other
  
  Récupère la valeur du paramètre facet.date.other. La méthode accepte un champ à y substituer.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau en cas de succès, et <info>null</info> s'il n'est pas défini.


id: SolrQuery::getFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Récupère la limite inférieure du premier intervalle de la date pour toutes les facettes de date
  pour
  ce champ
  
  Récupère la limite inférieure du premier intervalle de la date pour toutes les facettes de date
  pour ce champ. Accepte un champ optionnel pour l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si le paramètre n'est pas
          défini.


id: SolrQuery::getFacetFields
type: function
doc:
<comment>Description:</comment>
  Récupère toutes les facettes des champs
  
  Récupère toutes les facettes des champs.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau contenant tous les champs et <info>null</info> si aucun n'a été défini.


id: SolrQuery::getFacetLimit
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre maximal de contraintes qui peut être retourné pour les facettes des champs
  
  Récupère le nombre maximal de contraintes qui peut être retourné pour les facettes des champs.
  Cette méthode accepte un champ optionnel autorisant l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun paramètre n'est défini.


id: SolrQuery::getFacetMethod
type: function
doc:
<comment>Description:</comment>
  Récupère la valeur du paramètre facet.method
  
  Récupère la valeur du paramètre facet.method. La méthode accepte un champ à y substituer.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> s'il n'est pas défini.


id: SolrQuery::getFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre minimal de facettes des champs qui doivent être incluses dans la réponse
  
  Récupère le nombre minimal de facettes des champs qui doivent être incluses dans la réponse.
  Accepte un champ optionnel autorisant l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun paramètre n'est défini.


id: SolrQuery::getFacetMissing
type: function
doc:
<comment>Description:</comment>
  Récupère l'état courant du paramètre facet.missing
  
  Récupère l'état courant du paramètre facet.missing. Accepte un champ optionnel autorisant
  l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si aucun paramètre n'est défini.


id: SolrQuery::getFacetOffset
type: function
doc:
<comment>Description:</comment>
  Récupère la position dans la liste des contraintes à utiliser pour la pagination
  
  Récupère la position dans la liste des contraintes à utiliser pour la pagination. Accepte un champ
  optionnel autorisant l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun paramètre n'est défini.


id: SolrQuery::getFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Récupère le préfixe de la facette
  
  Récupère le préfixe de la facette.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun paramètre n'est
          défini.


id: SolrQuery::getFacetQueries
type: function
doc:
<comment>Description:</comment>
  Récupère toutes les facettes des requêtes
  
  Récupère toutes les facettes des requêtes.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau en cas de succès, et <info>null</info> si aucun paramètre n'a été défini.


id: SolrQuery::getFacetSort
type: function
doc:
<comment>Description:</comment>
  Retourne le type de tri de la facette
  
  Retourne un entier (SolrQuery::FACET_SORT_INDEX ou SolrQuery::FACET_SORT_COUNT).

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier (SolrQuery::FACET_SORT_INDEX ou SolrQuery::FACET_SORT_COUNT) en cas de
       succès, et <info>null</info> si aucun paramètre n'est défini.


id: SolrQuery::getFields
type: function
doc:
<comment>Description:</comment>
  Récupère la liste des champs qui seront retournés dans la réponse
  
  Récupère la liste des champs qui seront retournés dans la réponse.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getFilterQueries
type: function
doc:
<comment>Description:</comment>
  Récupère un tableau de filtres de requêtes
  
  Récupère un tableau de filtres de requêtes. Ce sont les requêtes qui peuvent être utilisées pour
  restreindre le jeu de documents qui peut être retourné, sans influencer le score.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getGroup
type: function
doc:
<comment>Description:</comment>
  Returns true if grouping is enabled
  
  Returns true if grouping is enabled

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

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


id: SolrQuery::getGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Returns group cache percent value
  
  Returns group cache percent value

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

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


id: SolrQuery::getGroupFacet
type: function
doc:
<comment>Description:</comment>
  Returns the group.facet parameter value
  
  Returns the group.facet parameter value

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

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


id: SolrQuery::getGroupFields
type: function
doc:
<comment>Description:</comment>
  Returns group fields (group.field parameter values)
  
  Returns group fields (group.field parameter values)

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

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


id: SolrQuery::getGroupFormat
type: function
doc:
<comment>Description:</comment>
  Returns the group.format value
  
  Returns the group.format value

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

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


id: SolrQuery::getGroupFunctions
type: function
doc:
<comment>Description:</comment>
  Returns group functions (group.func parameter values)
  
  Returns group functions (group.func parameter values)

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

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


id: SolrQuery::getGroupLimit
type: function
doc:
<comment>Description:</comment>
  Returns the group.limit value
  
  Returns the group.limit value

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

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


id: SolrQuery::getGroupMain
type: function
doc:
<comment>Description:</comment>
  Returns the group.main value
  
  Returns the group.main value

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

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


id: SolrQuery::getGroupNGroups
type: function
doc:
<comment>Description:</comment>
  Returns the group.ngroups value
  
  Returns the group.ngroups value

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

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


id: SolrQuery::getGroupOffset
type: function
doc:
<comment>Description:</comment>
  Returns the group.offset value
  
  Returns the group.offset value

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

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


id: SolrQuery::getGroupQueries
type: function
doc:
<comment>Description:</comment>
  Returns all the group.query parameter values
  
  Returns all the group.query parameter values

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

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


id: SolrQuery::getGroupSortFields
type: function
doc:
<comment>Description:</comment>
  Returns the group.sort value
  
  Returns the group.sort value

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

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


id: SolrQuery::getGroupTruncate
type: function
doc:
<comment>Description:</comment>
  Returns the group.truncate value
  
  Returns the group.truncate value

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

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


id: SolrQuery::getHighlight
type: function
doc:
<comment>Description:</comment>
  Récupère l'état du paramètre h1
  
  Retourne un booléen indiquant si les extraits mis en évidence doivent être générés dans la
  réponse.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Récupère le champ mis en évidence à utiliser comme champ par défaut ou comme champ de sauvegarde
  
  Récupère le champ mis en évidence à utiliser comme champ par défaut ou comme champ de sauvegarde.
  Accepte un champ optionnel autorisant l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun n'a été défini.


id: SolrQuery::getHighlightFields
type: function
doc:
<comment>Description:</comment>
  Récupère tous les champs pour lesquels Solr doit mettre en évidence un extrait
  
  Récupère tous les champs pour lesquels Solr doit mettre en évidence un extrait.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau en cas de succès, et <info>null</info> si aucun n'a été défini.


id: SolrQuery::getHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Récupère le formatage utilisé pour mettre en évidence la sortie
  
  Récupère le formatage utilisé pour mettre en évidence la sortie.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Récupère le générateur d'extrait de texte pour la mise en évidence
  
  Récupère le générateur d'extrait de texte pour la mise en évidence. Accepte un champ optionnel
  permettant l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre de caractères des fragments à considérer pour la mise en évidence
  
  Retourne le nombre de caractères des fragments à considérer pour la mise en évidence. Zéro
  signifie aucun fragments. Le champ entier devrait être utilisé.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Retourne si l'on doit activer la mise en évidence pour les intervalles/jokers/flous/préfixes des
  requêtes
  
  Retourne si l'on doit activer la mise en évidence pour les intervalles/jokers/flous/préfixes des
  requêtes.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre maximal de caractères du champ à retourner
  
  Retourne le nombre maximal de caractères du champ à retourner.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre maximal de caractères du document dans lequel les extraits seront cherchés
  
  Retourne le nombre maximal de caractères du document dans lequel les extraits seront cherchés.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Retourne si l'on doit rassembler les fragments contigus en un seul fragment
  
  Retourne si l'on doit rassembler les fragments contigus en un seul fragment. Accepte un champ
  optionnel permettant l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre maximal de caractères depuis un champ lors de l'utilisation d'une regex
  
  Retourne le nombre maximal de caractères depuis un champ lors de l'utilisation d'une regex.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Récupère l'expression rationnelle utilisée pour la fragmentation
  
  Récupère l'expression rationnelle utilisée pour la fragmentation.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Récupère le facteur de déviation depuis la taille du fragment idéal
  
  Retourne le facteur utilisé par l'expression rationnelle de fragmentation pour la déviation depuis
  la taille idéal du fragment afin d'accommoder l'expression rationnelle.

<comment>Return:</comment>
  <info>float</info>  Retourne un <info>float</info> en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Retourne si le champ ne doit être mis en évidence que si la requête correspond à un champ en
  particulier
  
  Retourne si le champ ne doit être mis en évidence que si la requête correspond à un champ en
  particulier.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Récupère le texte qui doit apparaître après le terme mise en évidence
  
  Récupère le texte qui doit apparaître après le terme mise en évidence. Accepte un champ optionnel
  permettant l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Retourne le texte qui doit apparaître avant le terme mise en évidence
  
  Retourne le texte qui doit apparaître avant le terme mise en évidence. Accepte un champ optionnel
  permettant l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre maximal d'extraits mis en évidence à générer par champ
  
  &gt;Récupère le nombre maximal d'extraits mis en évidence à générer par champ. Accepte un champ
  optionnel permettant l'écrasement.

<comment>Param:</comment>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Récupère l'état du paramètre hl.usePhraseHighlighter
  
  Retourne si l'on doit utiliser SpanScorer pour mettre en évidence les termes d'une phrase
  uniquement lorsqu'ils apparaissent dans la phrase de requête du document.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getMlt
type: function
doc:
<comment>Description:</comment>
  Retourne si les résultats MoreLikeThis doivent être activés
  
  Retourne si les résultats MoreLikeThis doivent être activés.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getMltBoost
type: function
doc:
<comment>Description:</comment>
  Retourne si la requête doit être améliorée en utilisant la pertinence des termes
  
  Retourne si la requête doit être améliorée en utilisant la pertinence des termes.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getMltCount
type: function
doc:
<comment>Description:</comment>
  Récupère le nombre de documents similaires à retourner pour chaque résultat
  
  Récupère le nombre de documents similaires à retourner pour chaque résultat.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getMltFields
type: function
doc:
<comment>Description:</comment>
  Récupère tous les champs à utiliser pour la similarité
  
  Récupère tous les champs à utiliser pour la similarité.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre maximal de termes de requête qui peuvent être inclus lors de la génération
  d'une
  requête
  
  Retourne le nombre maximal de termes de requête qui peuvent être inclus lors de la génération
  d'une requête.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si le nombre maximal n'est pas défini.


id: SolrQuery::getMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre maximal de jokers à analyser dans chaque champ du document
  
  Retourne le nombre maximal de jokers à analyser dans chaque champ du document qui n'est pas stocké
  avec le support TermVector.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si le nombre maximal de jokers n'est pas défini.


id: SolrQuery::getMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Retourne la longueur minimale des mots en deçà de laquelle ils seront ignorés
  
  Retourne la longueur minimale des mots en deçà de laquelle ils seront ignorés.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si la longueur n'est pas définie.


id: SolrQuery::getMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Retourne le seuil de fréquence d'apparition des mots
  
  Retourne le seuil de fréquence d'apparition des mots en deçà duquel ils seront ignorés.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si le seuil n'est pas défini.


id: SolrQuery::getMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Retourne la fréquence en deçà duquel les termes doivent être ignorés dans le document source
  
  Retourne la fréquence en deçà duquel les termes doivent être ignorés dans le document source.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si la fréquence n'est pas définie.


id: SolrQuery::getMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Retourne la longueur minimum d'un mot en deça duquel il sera ignoré
  
  Retourne la longueur minimum d'un mot en deça duquel il sera ignoré.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si la longueur n'est pas définie.


id: SolrQuery::getMltQueryFields
type: function
doc:
<comment>Description:</comment>
  Retourne les champs de la requête ainsi que leurs boosts
  
  Retourne les champs de la requête ainsi que leurs boosts.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau en cas de succès, et <info>null</info> si aucun champ n'est défini.


id: SolrQuery::getQuery
type: function
doc:
<comment>Description:</comment>
  Retourne la requête principale
  
  Retourne la requête principale.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si indéfini.


id: SolrQuery::getRows
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre maximal de documents
  
  Retourne le nombre maximal de documents depuis le jeu complet de résultats à retourner au client à
  chaque requête.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si indéfini.


id: SolrQuery::getSortFields
type: function
doc:
<comment>Description:</comment>
  Retourne tous les champs de tri
  
  Retourne tous les champs de tri.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau en cas de succès, et <info>null</info> si aucun paramètre n'est défini.


id: SolrQuery::getStart
type: function
doc:
<comment>Description:</comment>
  Retourne la position dans le jeu complet de résultats
  
  Retourne la position dans le jeu complet de résultats de la requête à partir de laquelle on doit
  commencer à retourner les documents.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si indéfini.


id: SolrQuery::getStats
type: function
doc:
<comment>Description:</comment>
  Vérifie si les statistiques sont actives ou non
  
  Vérifie si les statistiques sont actives ou non.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si indéfini.


id: SolrQuery::getStatsFacets
type: function
doc:
<comment>Description:</comment>
  Retourne toutes les statistiques définies
  
  Retourne toutes les statistiques définies.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau en cas de succès, et <info>null</info> si aucune n'est définie.


id: SolrQuery::getStatsFields
type: function
doc:
<comment>Description:</comment>
  Retourne les statistiques des champs
  
  Retourne les statistiques des champs.

<comment>Return:</comment>
  <info>array</info>  Retourne un tableau en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getTerms
type: function
doc:
<comment>Description:</comment>
  Vérifie si le TermsComponent est activé ou non
  
  Vérifie si le TermsComponent est activé ou non

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si indéfini.


id: SolrQuery::getTermsField
type: function
doc:
<comment>Description:</comment>
  Récupère le champ depuis lequel les termes sont récupérés
  
  Récupère le champ depuis lequel les termes sont récupérés.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun champ n'est défini.


id: SolrQuery::getTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Vérifie si l'on doit inclure ou non la limite inférieure dans le jeu de résultats
  
  Vérifie si l'on doit inclure ou non la limite inférieure dans le jeu de résultats.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Vérifie si l'on doit inclure ou non la limite supérieure dans le jeu de résultats
  
  Vérifie si l'on doit inclure ou non la limite supérieure dans le jeu de résultats.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès et <info>null</info> si aucun n'est défini.


id: SolrQuery::getTermsLimit
type: function
doc:
<comment>Description:</comment>
  Retourne le nombre maximal de termes que Solr peut retourner
  
  Retourne le nombre maximal de termes que Solr peut retourner.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun nombre n'est défini.


id: SolrQuery::getTermsLowerBound
type: function
doc:
<comment>Description:</comment>
  Retourne le terme sur lequel on doit commencer
  
  Retourne le terme sur lequel on doit commencer.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun terme n'est défini.


id: SolrQuery::getTermsMaxCount
type: function
doc:
<comment>Description:</comment>
  Retourne la fréquence maximale des documents
  
  Retourne la fréquence maximale des documents.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucune fréquence n'est retournée.


id: SolrQuery::getTermsMinCount
type: function
doc:
<comment>Description:</comment>
  Retourne la fréquence minimale des documents
  
  Retourne la fréquence minimale des documents à retourner aux fins d'inclusion.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucune fréquence n'est définie.


id: SolrQuery::getTermsPrefix
type: function
doc:
<comment>Description:</comment>
  Retourne le préfixe du terme
  
  Retourne le préfixe utilisé pour restreindre les termes. Ainsi, seuls les termes qui commencent
  par ce préfixe correspondront à la recherche.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getTermsReturnRaw
type: function
doc:
<comment>Description:</comment>
  Si l'on doit retourner ou non les caractères brutes
  
  Retourne un booléen indiquant si l'on doit retourner ou non les caractères brutes des termes
  indexés, suivant s'ils sont humainement lisibles.

<comment>Return:</comment>
  <info>bool</info>  Retourne un booléen en cas de succès et <info>null</info> si aucun n'est défini.


id: SolrQuery::getTermsSort
type: function
doc:
<comment>Description:</comment>
  Retourne un entier indiquant le nombre de termes stockés
  
  SolrQuery::TERMS_SORT_INDEX indique que les termes sont retournés triés sur l'index.
  SolrQuery::TERMS_SORT_COUNT implique que les termes sont stockés par la fréquence des termes (le
  plus grand nombre en premier).

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getTermsUpperBound
type: function
doc:
<comment>Description:</comment>
  Retourne le terme sur lequel on doit s'arrêter
  
  Retourne le terme sur lequel on doit s'arrêter.

<comment>Return:</comment>
  <info>string</info>  Retourne une chaîne de caractères en cas de succès, et <info>null</info> si aucun n'est défini.


id: SolrQuery::getTimeAllowed
type: function
doc:
<comment>Description:</comment>
  Retourne le délai d'exécution autorisé pour une requête
  
  Retourne le délai d'exécution, en millisecondes, autorisé pour une requête.

<comment>Return:</comment>
  <info>int</info>  Retourne un entier en cas de succès, et <info>null</info> si aucun délai n'est défini.


id: SolrQuery::removeExpandFilterQuery
type: function
doc:
<comment>Description:</comment>
  Removes an expand filter query
  
  Removes an expand filter query.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery


id: SolrQuery::removeExpandSortField
type: function
doc:
<comment>Description:</comment>
  Removes an expand sort field from the expand.sort parameter
  
  Removes an expand sort field from the expand.sort parameter.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  field name

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::removeFacetDateField
type: function
doc:
<comment>Description:</comment>
  Supprime un champ date
  
  Supprime un champ date.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ à supprimer

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


id: SolrQuery::removeFacetDateOther
type: function
doc:
<comment>Description:</comment>
  Supprime un paramètre facet.date.other
  
  Supprime un paramètre facet.date.other.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           La valeur
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::removeFacetField
type: function
doc:
<comment>Description:</comment>
  Supprime un paramètre facet.date
  
  Supprime un paramètre facet.date.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ

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


id: SolrQuery::removeFacetQuery
type: function
doc:
<comment>Description:</comment>
  Supprime un paramètre facet.query
  
  Supprime un paramètre facet.query.

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

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


id: SolrQuery::removeField
type: function
doc:
<comment>Description:</comment>
  Efface un champ depuis la liste des champs
  
  Efface un champ depuis la liste des champs.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Nom du champ.

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


id: SolrQuery::removeFilterQuery
type: function
doc:
<comment>Description:</comment>
  Supprime un filtre de requête
  
  Supprime un filtre de requête.

<comment>Param:</comment>
  <info>string</info>  <strong>$fq</strong>  Le filtre de requête à supprimer

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


id: SolrQuery::removeHighlightField
type: function
doc:
<comment>Description:</comment>
  Supprime un des champs utilisés pour la mise en évidence
  
  Supprime un des champs utilisés pour la mise en évidence.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ.

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


id: SolrQuery::removeMltField
type: function
doc:
<comment>Description:</comment>
  Supprime un des champs moreLikeThis
  
  Supprime un des champs moreLikeThis.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Nom du champ

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


id: SolrQuery::removeMltQueryField
type: function
doc:
<comment>Description:</comment>
  Supprime un des champs moreLikeThis de la requête
  
  Supprime un des champs moreLikeThis de la requête.

<comment>Param:</comment>
  <info>string</info>  <strong>$queryField</strong>  Le champ de la requête

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


id: SolrQuery::removeSortField
type: function
doc:
<comment>Description:</comment>
  Supprime un champ de tri
  
  Supprime un champ de tri

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ.

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


id: SolrQuery::removeStatsFacet
type: function
doc:
<comment>Description:</comment>
  Supprime un paramètre stats.facet
  
  Supprime un paramètre stats.facet.

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

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


id: SolrQuery::removeStatsField
type: function
doc:
<comment>Description:</comment>
  Supprime un paramètre stats.field
  
  Supprime un paramètre stats.field.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>  Le nom du champ.

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


id: SolrQuery::setEchoHandler
type: function
doc:
<comment>Description:</comment>
  Bascule le paramètre echoHandler
  
  Si définit à <info>true</info>, Solr placera le nom du gestionnaire utilisé dans la réponse au client à des
  fins de débogage.

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

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


id: SolrQuery::setEchoParams
type: function
doc:
<comment>Description:</comment>
  Détermine les paramètres à inclure dans la réponse
  
  Indique à Solr les paramètres à inclure dans la réponse aux fins de déboguage :
  
  

<comment>Param:</comment>
  <info>string</info>  <strong>$type</strong>  Le type de paramètres à inclure.

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


id: SolrQuery::setExpand
type: function
doc:
<comment>Description:</comment>
  Enables/Disables the Expand Component
  
  Enables/Disables the Expand Component.

<comment>Param:</comment>
  <info>bool</info>  <strong>$value</strong>  Bool flag

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandQuery
type: function
doc:
<comment>Description:</comment>
  Sets the expand.q parameter
  
  Sets the expand.q parameter.
  
  Overrides the main q parameter,  determines which documents to include in the main group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandRows
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExpandRows
type: function
doc:
<comment>Description:</comment>
  Sets the number of rows to display in each group (expand.rows). Server Default 5
  
  Sets the number of rows to display in each group (expand.rows). Server Default 5

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

<comment>Return:</comment>
  <info>SolrQuery</info>  <info>SolrQuery</info>

<comment>See Also:</comment>
   * SolrQuery::setExpand
   * SolrQuery::addExpandSortField
   * SolrQuery::removeExpandSortField
   * SolrQuery::setExpandQuery
   * SolrQuery::addExpandFilterQuery
   * SolrQuery::removeExpandFilterQuery


id: SolrQuery::setExplainOther
type: function
doc:
<comment>Description:</comment>
  Définit le paramètre de requête explainOther
  
  Définit le paramètre de requête explainOther.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  La requête Lucene identifiant un jeu de documents

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


id: SolrQuery::setFacet
type: function
doc:
<comment>Description:</comment>
  Lie un paramètre facet. Active ou désactive les facet
  
  Active ou désactive les facet.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  <info>true</info> pour activer les facet, <info>false</info> pour les désactiver.

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


id: SolrQuery::setFacetDateEnd
type: function
doc:
<comment>Description:</comment>
  Lie un facet.date.end
  
  Lie un facet.date.end

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           Voir facet.date.end
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ

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


id: SolrQuery::setFacetDateGap
type: function
doc:
<comment>Description:</comment>
  Lie un facet.date.gap
  
  Lie un facet.date.gap

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           Voir facet.date.gap
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ

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


id: SolrQuery::setFacetDateHardEnd
type: function
doc:
<comment>Description:</comment>
  Lie un facet.date.hardend
  
  Lie un facet.date.hardend

<comment>Param:</comment>
  <info>bool</info>    <strong>$value</strong>           Voir facet.date.hardend
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ

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


id: SolrQuery::setFacetDateStart
type: function
doc:
<comment>Description:</comment>
  Lie un facet.date.start
  
  Lie un facet.date.start.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>           Voir facet.date.start
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setFacetEnumCacheMinDefaultFrequency
type: function
doc:
<comment>Description:</comment>
  Définit la fréquence minimale du document utilisée pour déterminer le comptage des termes
  
  Définit la fréquence minimale du document utilisée pour déterminer le comptage des termes.

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           La fréquence minimale.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setFacetLimit
type: function
doc:
<comment>Description:</comment>
  Lie un facet.limit
  
  Lie un facet.limit. Définit le nombre maximal de contraintes qui doit être retourné pour les
  champs facet.

<comment>Param:</comment>
  <info>int</info>     <strong>$limit</strong>           Le nombre maximal de contraintes.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setFacetMethod
type: function
doc:
<comment>Description:</comment>
  Spécifie le type d'algorithme à utiliser pour un champ facet
  
  Spécifie le type d'algorithme à utiliser pour un champ facet.

<comment>Param:</comment>
  <info>string</info>  <strong>$method</strong>          La méthode à utiliser.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setFacetMinCount
type: function
doc:
<comment>Description:</comment>
  Lie un facet.mincount
  
  Définit le nombre minimal pour les champs facet qui doit être inclus dans la réponse.

<comment>Param:</comment>
  <info>int</info>     <strong>$mincount</strong>        Le nombre minimal.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setFacetMissing
type: function
doc:
<comment>Description:</comment>
  Lie un facet.missing
  
  Utilisé pour indiquer que, en plus des contraintes relatives aux termes d'un champ facet, un
  comptage de tous les résultats correspondants qui n'ont pas de valeur pour le champ doit être
  calculé.

<comment>Param:</comment>
  <info>bool</info>    <strong>$flag</strong>            <info>true</info> pour activer cette fonctionnalité. <info>false</info> pour la désactiver.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setFacetOffset
type: function
doc:
<comment>Description:</comment>
  Définit la position dans la liste des contraintes pour la pagination
  
  Définit la position dans la liste des contraintes pour la pagination.

<comment>Param:</comment>
  <info>int</info>     <strong>$offset</strong>          La position.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setFacetPrefix
type: function
doc:
<comment>Description:</comment>
  Spécifie un préfixe utilisé pour limiter les termes
  
  Spécifie un préfixe utilisé pour limiter les termes.

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

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


id: SolrQuery::setFacetSort
type: function
doc:
<comment>Description:</comment>
  Détermine le tri des facet
  
  Détermine le tri des facet.

<comment>Param:</comment>
  <info>int</info>     <strong>$facetSort</strong>       Utilisez SolrQuery::FACET_SORT_INDEX pour trier sur l'index, ou
                           SolrQuery::FACET_SORT_COUNT pour trier sur le total.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setGroup
type: function
doc:
<comment>Description:</comment>
  Enable/Disable result grouping (group parameter)
  
  Enable/Disable result grouping (group parameter)

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::getGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupCachePercent
type: function
doc:
<comment>Description:</comment>
  Enables caching for result grouping
  
  Setting this parameter to a number greater than 0 enables caching for result grouping. Result
  Grouping executes two searches; this option caches the second search. The server default value is
  0.  Testing has shown that group caching only improves search time with Boolean, wildcard, and
  fuzzy queries. For simple queries like term or "match all" queries, group caching degrades
  performance. group.cache.percent parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat


id: SolrQuery::setGroupFacet
type: function
doc:
<comment>Description:</comment>
  Sets group.facet parameter
  
  Determines whether to compute grouped facets for the field facets specified in facet.field
  parameters. Grouped facets are computed based on the first specified group.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupFormat
type: function
doc:
<comment>Description:</comment>
  Sets the group format, result structure (group.format parameter)
  
  Sets the group.format parameter. If this parameter is set to simple, the grouped documents are
  presented in a single flat list, and the start and rows parameters affect the numbers of documents
  instead of groups. Accepts: grouped/simple

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupLimit
type: function
doc:
<comment>Description:</comment>
  Specifies the number of results to return for each group. The server default value is 1
  
  Specifies the number of results to return for each group. The server default value is 1.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupMain
type: function
doc:
<comment>Description:</comment>
  If true, the result of the first field grouping command is used as the main result list in the
  response, using group.format=simple
  
  If <info>true</info>, the result of the first field grouping command is used as the main result list in the
  response, using <return>group.format=simple</return>.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  If <info>true</info>, the result of the first field grouping command is used as the main result
                  list in the response.

<comment>Return:</comment>
  <info>SolrQuery</info>  Returns an instance of <class>SolrQuery</class>.

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupNGroups
type: function
doc:
<comment>Description:</comment>
  If true, Solr includes the number of groups that have matched the query in the results
  
  If true, Solr includes the number of groups that have matched the query in the results.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupOffset
type: function
doc:
<comment>Description:</comment>
  Sets the group.offset parameter
  
  Sets the group.offset parameter.

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupTruncate
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setGroupTruncate
type: function
doc:
<comment>Description:</comment>
  If true, facet counts are based on the most relevant document of each group matching the query
  
  If true, facet counts are based on the most relevant document of each group matching the query.
  The server default value is false. group.truncate parameter

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

<comment>Return:</comment>
  <info>SolrQuery</info>  

<comment>See Also:</comment>
   * SolrQuery::setGroup
   * SolrQuery::addGroupField
   * SolrQuery::addGroupFunction
   * SolrQuery::addGroupQuery
   * SolrQuery::addGroupSortField
   * SolrQuery::setGroupFacet
   * SolrQuery::setGroupOffset
   * SolrQuery::setGroupLimit
   * SolrQuery::setGroupMain
   * SolrQuery::setGroupNGroups
   * SolrQuery::setGroupFormat
   * SolrQuery::setGroupCachePercent


id: SolrQuery::setHighlight
type: function
doc:
<comment>Description:</comment>
  Active ou désactive la coloration
  
  Le fait de définir à <info>true</info> active la coloration des extraits à générer dans la réponse à la
  requête.
  
  Le fait de définir à <info>false</info> désactive la coloration.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Active ou désactive la coloration

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


id: SolrQuery::setHighlightAlternateField
type: function
doc:
<comment>Description:</comment>
  Spécifie le champ de sauvegarde à utiliser
  
  Si un extrait ne peut être généré en raison de termes ne correspondant pas, la méthode peut
  spécifier un champ à utiliser comme sauvegarde ou comme résumé par défaut.

<comment>Param:</comment>
  <info>string</info>  <strong>$field</strong>           Le nom du champ de sauvegarde
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ qui sera écrasé par cette configuration.

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


id: SolrQuery::setHighlightFormatter
type: function
doc:
<comment>Description:</comment>
  Spécifie un formateur pour la sortie colorisée
  
  Spécifie un formateur pour la sortie colorisée.

<comment>Param:</comment>
  <info>string</info>  <strong>$formatter</strong>       Actuellement, la seule valeur est "simple".
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>SolrQuery</info>  Renvoie une instance de <class>SolrQuery</class>.


id: SolrQuery::setHighlightFragmenter
type: function
doc:
<comment>Description:</comment>
  Définit un générateur d'extraits de texte pour le texte colorisé
  
  Définit un générateur d'extraits de texte pour le texte colorisé.

<comment>Param:</comment>
  <info>string</info>  <strong>$fragmenter</strong>      Le fragmenteur standard est gap. Une autre option est regex, qui tente de
                           créer des fragments qui correspondent à une certain expression
                           rationnelle.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setHighlightFragsize
type: function
doc:
<comment>Description:</comment>
  La taille du fragment à considérer pour la coloration
  
  Définit la taille, en caractères, du fragments à considérer pour la coloration. "0" indique que la
  valeur du champ complet doit être utilisée (aucune fragmentation).

<comment>Param:</comment>
  <info>int</info>     <strong>$size</strong>            La taille, en caractères, du fragment à considérer pour la coloration.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setHighlightHighlightMultiTerm
type: function
doc:
<comment>Description:</comment>
  Utilise SpanScorer pour coloriser les termes d'une phrase
  
  Utilise SpanScorer pour coloriser les termes d'une phrase uniquement lorsqu'ils apparaissent dans
  la phrase de requête du document.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Si l'on doit utiliser ou non SpanScorer pour coloriser les termes de la phrase
               uniquement lorsqu'ils apparaissent dans la phrase de requête du document.

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


id: SolrQuery::setHighlightMaxAlternateFieldLength
type: function
doc:
<comment>Description:</comment>
  Définit le nombre maximal de caractères du champ à retourner
  
  Si SolrQuery::setHighlightAlternateField() passe la valeur <info>true</info>, ce paramètre spécifie le nombre
  maximal de caractères du champ à retourner.
  
  Toutes les valeurs inférieures ou égales à 0 signifient qu'il n'y a pas de limite.

<comment>Param:</comment>
  <info>int</info>     <strong>$fieldLength</strong>     La longueur du champ.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setHighlightMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Spécifie le nombre de caractères dans un document pour y chercher des extraits correspondants
  
  Spécifie le nombre de caractères dans un document pour y chercher des extraits correspondants.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  Le nombre de caractères dans un document pour y chercher des extraites correspondants

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


id: SolrQuery::setHighlightMergeContiguous
type: function
doc:
<comment>Description:</comment>
  Si l'on doit rassembler les fragments proches dans un seul fragment
  
  Si l'on doit rassembler les fragments proches dans un seul fragment.

<comment>Param:</comment>
  <info></info>        <strong>$value</strong>           Si l'on doit rassembler les fragments proches dans un seul fragment.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setHighlightRegexMaxAnalyzedChars
type: function
doc:
<comment>Description:</comment>
  Spécifie le nombre maximal de caractères à analyser
  
  Spécifie le nombre maximal de caractères à analyser dans un champ lors de l'utilisateur du
  formatteur regex.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxAnalyzedChars</strong>  Le nombre maximal de caractères à analyser dans un champ lors de
                          l'utilisateur du formatteur regex.

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


id: SolrQuery::setHighlightRegexPattern
type: function
doc:
<comment>Description:</comment>
  Spécifie l'expression rationnelle pour la fragmentation
  
  Spécifie l'expression rationnelle pour la fragmentation. Peut être utilisé pour extraire des
  phrases.

<comment>Param:</comment>
  <info>string</info>  <strong>$value</strong>  L'expression rationnelle pour la fragmentation. Peut être utilisé pour extraire
                  des phrases.

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


id: SolrQuery::setHighlightRegexSlop
type: function
doc:
<comment>Description:</comment>
  Définit le facteur par lequel le fragmenteur regex peut dévier de la taille idéale du fragment
  
  Le facteur par lequel le fragmenteur regex peut dévier de la taille idéale du fragment ( spécifié
  par SolrQuery::setHighlightFragsize ) pour arranger l'expression rationnelle.

<comment>Param:</comment>
  <info>float</info>  <strong>$factor</strong>  Le facteur par lequel le fragmenteur regex peut dévier de la taille idéale du
                  fragment.

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


id: SolrQuery::setHighlightRequireFieldMatch
type: function
doc:
<comment>Description:</comment>
  Champ correspondant requis lors de la colorisation
  
  Si <info>true</info>, alors le champ ne sera colorisé que si la requête correspond dans ce champ particulier.
  
  Ne fonctionne que si SolrQuery::setHighlightUsePhraseHighlighter() a été défini à <info>true</info>.

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

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


id: SolrQuery::setHighlightSimplePost
type: function
doc:
<comment>Description:</comment>
  Définit le texte qui doit apparaître après un terme colorisé
  
  Définit le texte qui doit apparaître après un terme colorisé.

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePost</strong>      Définit le texte qui doit apparaître après un terme colorisé.
                           
                            ]]>
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

<comment>Return:</comment>
  <info>SolrQuery</info>  Renvoie une instance de <class>SolrQuery</class>.


id: SolrQuery::setHighlightSimplePre
type: function
doc:
<comment>Description:</comment>
  Définit le texte qui doit apparaître avant un terme colorisé
  
  Définit le texte qui doit apparaître avant un terme colorisé.
  
   ]]>

<comment>Param:</comment>
  <info>string</info>  <strong>$simplePre</strong>       Le texte qui doit apparaître avant un terme colorisé
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setHighlightSnippets
type: function
doc:
<comment>Description:</comment>
  Définit le nombre maximal d'extraits à coloriser par champ
  
  Définit le nombre maximal d'extraits à coloriser par champ.

<comment>Param:</comment>
  <info>int</info>     <strong>$value</strong>           Le nombre maximal d'extraits à coloriser par champ.
  <info>string</info>  <strong>$field_override</strong>  Le nom du champ.

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


id: SolrQuery::setHighlightUsePhraseHighlighter
type: function
doc:
<comment>Description:</comment>
  Si l'on doit coloriser les termes d'une phrase uniquement si ils apparaissent dans la requête
  
  Si l'on doit utiliser SpanScorer pour coloriser les termes d'une phrase uniquement si ils
  apparaissent dans la requête du document.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  Si l'on doit utiliser SpanScorer pour coloriser les termes d'une phrase uniquement si
            ils apparaissent dans la requête du document.

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


id: SolrQuery::setMlt
type: function
doc:
<comment>Description:</comment>
  Active ou désactive moreLikeThis
  
  Active ou désactive moreLikeThis

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> pour l'activer, <info>false</info> pour le désactiver.

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


id: SolrQuery::setMltBoost
type: function
doc:
<comment>Description:</comment>
  Si la requête doit être stimulée par la pertinence des termes
  
  Si la requête doit être stimulée par la pertinence des termes.

<comment>Param:</comment>
  <info></info>  <strong>$value</strong>  À définir à <info>true</info> ou à <info>false</info>.

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


id: SolrQuery::setMltCount
type: function
doc:
<comment>Description:</comment>
  Définit le nombre de documents similaires à retourner à chaque résultat
  
  Définit le nombre de documents similaires à retourner à chaque résultat.

<comment>Param:</comment>
  <info>int</info>  <strong>$count</strong>  Le nombre de documents similaires à retourner à chaque résultat

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


id: SolrQuery::setMltMaxNumQueryTerms
type: function
doc:
<comment>Description:</comment>
  Définit le nombre maximal de termes de requête à inclure
  
  Définit le nombre maximal de termes de requête à inclure dans chaque requête générée.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  Le nombre maximal de termes de requête à inclure dans chaque requête générée.

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


id: SolrQuery::setMltMaxNumTokens
type: function
doc:
<comment>Description:</comment>
  Spécifie le nombre maximal de motifs à analyser
  
  Spécifie le nombre maximal de motifs à analyser dans chaque champ d'exemple du document qui n'est
  pas stocké avec le support TermVector.

<comment>Param:</comment>
  <info>int</info>  <strong>$value</strong>  Le nombre maximal de motifs à analyser.

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


id: SolrQuery::setMltMaxWordLength
type: function
doc:
<comment>Description:</comment>
  Définit la longueur maximale d'un mot
  
  Définit la longueur maximale d'un mot en dessus duquel les mots seront ignorés.

<comment>Param:</comment>
  <info>int</info>  <strong>$maxWordLength</strong>  La longueur maximale d'un mot en dessus duquel les mots seront ignorés

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


id: SolrQuery::setMltMinDocFrequency
type: function
doc:
<comment>Description:</comment>
  Définit la fréquence mltMinDoc
  
  Définit la fréquence à partir de laquelle les mots seront ignorés si ils n'apparaissent pas dans
  les documents.

<comment>Param:</comment>
  <info>int</info>  <strong>$minDocFrequency</strong>  La fréquence à partir de laquelle les mots seront ignorés si ils
                         n'apparaissent pas dans les documents

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


id: SolrQuery::setMltMinTermFrequency
type: function
doc:
<comment>Description:</comment>
  Définit la fréquence en dessous de laquelle les termes seront ignorés dans le document source
  
  Définit la fréquence en dessous de laquelle les termes seront ignorés dans le document source.

<comment>Param:</comment>
  <info>int</info>  <strong>$minTermFrequency</strong>  La fréquence en dessous de laquelle les termes seront ignorés dans le
                          document source

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


id: SolrQuery::setMltMinWordLength
type: function
doc:
<comment>Description:</comment>
  Définit la longueur minimale d'un mot
  
  Définit la longueur minimale d'un mot en dessous de laquelle il sera ignoré.

<comment>Param:</comment>
  <info>int</info>  <strong>$minWordLength</strong>  La longueur minimale d'un mot en dessous de laquelle il sera ignoré.

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


id: SolrQuery::setOmitHeader
type: function
doc:
<comment>Description:</comment>
  Exclut l'en-tête des résultats retournés
  
  Exclut l'en-tête des résultats retournés.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> pour exclure l'en-tête des résultats.

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


id: SolrQuery::setQuery
type: function
doc:
<comment>Description:</comment>
  Définit la requête de recherche
  
  Définit la requête de recherche.

<comment>Param:</comment>
  <info>string</info>  <strong>$query</strong>  La requête de recherche

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant.


id: SolrQuery::setRows
type: function
doc:
<comment>Description:</comment>
  Spécifie le nombre maximal de lignes à retourner dans le résultat
  
  Spécifie le nombre maximal de lignes à retourner dans le résultat.

<comment>Param:</comment>
  <info>int</info>  <strong>$rows</strong>  Le nombre maximal de lignes à retourner.

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant.


id: SolrQuery::setShowDebugInfo
type: function
doc:
<comment>Description:</comment>
  Drapeau pour afficher les informations de débogage
  
  Drapeau pour afficher les informations de débogage.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Si l'on doit ou non afficher les informations de débogage. <info>true</info> ou <info>false</info>.

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


id: SolrQuery::setStart
type: function
doc:
<comment>Description:</comment>
  Spécifie le nombre maximal de lignes à ignorer
  
  Spécifie le nombre maximal de lignes à ignorer. Utile pour paginer les résultats.

<comment>Param:</comment>
  <info>int</info>  <strong>$start</strong>  Le nombre de lignes à ignorer.

<comment>Return:</comment>
  <info>SolrQuery</info>  Retourne l'objet SolrQuery courant.


id: SolrQuery::setStats
type: function
doc:
<comment>Description:</comment>
  Active ou désactive le composant statistique
  
  Active ou désactive le composant statistique.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> pour activer le composant statistique, <info>false</info> pour le désactiver.

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


id: SolrQuery::setTerms
type: function
doc:
<comment>Description:</comment>
  Active ou désactive le TermsComponent
  
  Active ou désactive le TermsComponent.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  <info>true</info> pour l'activer, <info>false</info> pour le désactiver.

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


id: SolrQuery::setTermsField
type: function
doc:
<comment>Description:</comment>
  Définit le nom du champ dans lequel les termes seront récupérés
  
  Définit le nom du champ dans lequel les termes seront récupérés.

<comment>Param:</comment>
  <info>string</info>  <strong>$fieldname</strong>  Le nom du champ.

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


id: SolrQuery::setTermsIncludeLowerBound
type: function
doc:
<comment>Description:</comment>
  Inclut le terme inférieure liée dans le jeu de résultat
  
  Inclut le terme inférieure liée dans le jeu de résultat.

<comment>Param:</comment>
  <info>bool</info>  <strong>$flag</strong>  Inclut le terme inférieure liée dans le jeu de résultat.

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


id: SolrQuery::setTermsIncludeUpperBound
type: function
doc:
<comment>Description:</comment>
  Inclut le terme supérieure liée dans le jeu de résultat
  
  Inclut le terme supérieure liée dans le jeu de résultat.

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

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


id: SolrQuery::setTermsLimit
type: function
doc:
<comment>Description:</comment>
  Définit le nombre maximal de termes à retourner
  
  Définit le nombre maximal de termes à retourner.

<comment>Param:</comment>
  <info>int</info>  <strong>$limit</strong>  Le nombre maximal de termes à retourner. Tous les termes seront retournés si la
               limite est négative.

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


